Skip to content

feat(backend,clerk-sdk-node): Drop create sms endpoint #2165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 22, 2023
Merged

feat(backend,clerk-sdk-node): Drop create sms endpoint #2165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2837a5d
feat(backend): Deprecate createSMSMessage
Nov 20, 2023
c76832e
feat(backend,clerk-sdk-node): Drop create sms endpoint
Nov 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .changeset/eleven-bananas-joke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
'@clerk/clerk-sdk-node': patch
'@clerk/backend': patch
---

Remove createSms functions from @clerk/backend and @clerk/sdk-node.

The equivalent /sms_messages Backend API endpoint will also dropped in the future, since this feature will no longer be available for new instances.

For a brief period it will still be accessible for instances that have used it in the past 7
days (13-11-2023 to 20-11-2023).

New instances will get a 403 forbidden response if they try to access it.
12 changes: 12 additions & 0 deletions .changeset/slimy-windows-grab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
'@clerk/backend': minor
---

Deprecate `createSMSMessage` and `SMSMessageApi` from `clerkClient`.

The equivalent `/sms_messages` Backend API endpoint will also be dropped in the future, since this feature will no longer be available for new instances.
Copy link
Contributor

@SokratisVidros SokratisVidros Nov 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The equivalent `/sms_messages` Backend API endpoint will also be dropped in the future, since this feature will no longer be available for new instances.
The `/sms_messages` Backend API endpoint will also be dropped in the future since this feature will no longer be available for new Clerk instances.

Copy link
Contributor Author

@Nikpolik Nikpolik Nov 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SokratisVidros I had enabled auto merge from yesterday and did not get a chance to update the copyright 😓

Copy link
Contributor Author

@Nikpolik Nikpolik Nov 22, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its updated in #2184 which is for v4 release


For a brief period it will still be accessible for instances that have used it in the past 7
days (13-11-2023 to 20-11-2023).

New instances will get a 403 forbidden response if they try to access it.
1 change: 0 additions & 1 deletion packages/backend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,6 @@ clerk.phoneNumbers;
clerk.redirectUrls;
clerk.sessions;
clerk.signInTokens;
clerk.smsMessages;
clerk.users;

// These functions should be used by framework-specific libraries, such as @clerk/nextjs or @clerk/remix.
Expand Down
19 changes: 0 additions & 19 deletions packages/backend/src/api/endpoints/SMSMessageApi.ts
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion packages/backend/src/api/endpoints/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,4 @@ export * from './PhoneNumberApi';
export * from './RedirectUrlApi';
export * from './SessionApi';
export * from './SignInTokenApi';
export * from './SMSMessageApi';
export * from './UserApi';
2 changes: 0 additions & 2 deletions packages/backend/src/api/factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import {
RedirectUrlAPI,
SessionAPI,
SignInTokenAPI,
SMSMessageAPI,
UserAPI,
} from './endpoints';
import { buildRequest } from './request';
Expand All @@ -35,7 +34,6 @@ export function createBackendApiClient(options: CreateBackendApiOptions) {
redirectUrls: new RedirectUrlAPI(request),
sessions: new SessionAPI(request),
signInTokens: new SignInTokenAPI(request),
smsMessages: new SMSMessageAPI(request),
users: new UserAPI(request),
domains: new DomainAPI(request),
};
Expand Down
19 changes: 0 additions & 19 deletions packages/sdk-node/examples/node/src/smsMessages.ts
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ exports[`module exports should not change unless explicitly set 1`] = `
"signJwt",
"signedInAuthObject",
"signedOutAuthObject",
"smsMessages",
"users",
"verifyJwt",
"verifyToken",
Expand Down
2 changes: 0 additions & 2 deletions packages/sdk-node/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ export { Clerk, clerkClient, ClerkExpressRequireAuth, ClerkExpressWithAuth, crea

const {
users,
smsMessages,
sessions,
emailAddresses,
phoneNumbers,
Expand All @@ -42,7 +41,6 @@ export {
organizations,
phoneNumbers,
sessions,
smsMessages,
users,
};

Expand Down