From 4aaf5103d3132f4e1ae76b861fa6ce0aae02ecbe Mon Sep 17 00:00:00 2001 From: Nikos Polykandriotis Date: Wed, 22 Nov 2023 12:45:24 +0200 Subject: [PATCH] feat(backend,clerk-sdk-node): Drop create sms endpoint (#2165) * feat(backend): Deprecate createSMSMessage * feat(backend,clerk-sdk-node): Drop create sms endpoint This feature is beeing dropped from the Backend API. For a brief period it will still be available 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. --- .changeset/eleven-bananas-joke.md | 13 +++++++++++++ .changeset/slimy-windows-grab.md | 12 ++++++++++++ packages/backend/README.md | 1 - .../src/api/endpoints/SMSMessageApi.ts | 19 ------------------- packages/backend/src/api/endpoints/index.ts | 1 - packages/backend/src/api/factory.ts | 2 -- .../sdk-node/examples/node/src/smsMessages.ts | 19 ------------------- .../__snapshots__/exports.test.ts.snap | 1 - packages/sdk-node/src/index.ts | 2 -- 9 files changed, 25 insertions(+), 45 deletions(-) create mode 100644 .changeset/eleven-bananas-joke.md create mode 100644 .changeset/slimy-windows-grab.md delete mode 100644 packages/backend/src/api/endpoints/SMSMessageApi.ts delete mode 100644 packages/sdk-node/examples/node/src/smsMessages.ts diff --git a/.changeset/eleven-bananas-joke.md b/.changeset/eleven-bananas-joke.md new file mode 100644 index 0000000000..55fb9da82f --- /dev/null +++ b/.changeset/eleven-bananas-joke.md @@ -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. diff --git a/.changeset/slimy-windows-grab.md b/.changeset/slimy-windows-grab.md new file mode 100644 index 0000000000..a23741c414 --- /dev/null +++ b/.changeset/slimy-windows-grab.md @@ -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. + +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. diff --git a/packages/backend/README.md b/packages/backend/README.md index ab3c578437..8a42121c1f 100644 --- a/packages/backend/README.md +++ b/packages/backend/README.md @@ -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. diff --git a/packages/backend/src/api/endpoints/SMSMessageApi.ts b/packages/backend/src/api/endpoints/SMSMessageApi.ts deleted file mode 100644 index a6234c7ad9..0000000000 --- a/packages/backend/src/api/endpoints/SMSMessageApi.ts +++ /dev/null @@ -1,19 +0,0 @@ -import type { SMSMessage } from '../resources/SMSMessage'; -import { AbstractAPI } from './AbstractApi'; - -const basePath = '/sms_messages'; - -type SMSParams = { - phoneNumberId: string; - message: string; -}; - -export class SMSMessageAPI extends AbstractAPI { - public async createSMSMessage(params: SMSParams) { - return this.request({ - method: 'POST', - path: basePath, - bodyParams: params, - }); - } -} diff --git a/packages/backend/src/api/endpoints/index.ts b/packages/backend/src/api/endpoints/index.ts index bd05e6af47..e4f743550a 100644 --- a/packages/backend/src/api/endpoints/index.ts +++ b/packages/backend/src/api/endpoints/index.ts @@ -11,5 +11,4 @@ export * from './PhoneNumberApi'; export * from './RedirectUrlApi'; export * from './SessionApi'; export * from './SignInTokenApi'; -export * from './SMSMessageApi'; export * from './UserApi'; diff --git a/packages/backend/src/api/factory.ts b/packages/backend/src/api/factory.ts index e187b82ebf..aa8f94c5c4 100644 --- a/packages/backend/src/api/factory.ts +++ b/packages/backend/src/api/factory.ts @@ -11,7 +11,6 @@ import { RedirectUrlAPI, SessionAPI, SignInTokenAPI, - SMSMessageAPI, UserAPI, } from './endpoints'; import { buildRequest } from './request'; @@ -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), }; diff --git a/packages/sdk-node/examples/node/src/smsMessages.ts b/packages/sdk-node/examples/node/src/smsMessages.ts deleted file mode 100644 index f47c97b6a4..0000000000 --- a/packages/sdk-node/examples/node/src/smsMessages.ts +++ /dev/null @@ -1,19 +0,0 @@ -// Usage: -// From examples/node, run files with "npm test ./src/smsMessages.ts" -import { smsMessages } from '@clerk/clerk-sdk-node'; - -const phoneNumberId = process.env.PHONE_NUMBER_ID || ''; - -try { - console.log('Create SMS message'); - const message = "I'd buy that for a dollar"; - - const smsMessage = await smsMessages.createSMSMessage({ - message, - phoneNumberId, - }); - - console.log(smsMessage); -} catch (error) { - console.log(error); -} diff --git a/packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap b/packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap index 4ab27968dd..6aee95acee 100644 --- a/packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap +++ b/packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap @@ -62,7 +62,6 @@ exports[`module exports should not change unless explicitly set 1`] = ` "signJwt", "signedInAuthObject", "signedOutAuthObject", - "smsMessages", "users", "verifyJwt", "verifyToken", diff --git a/packages/sdk-node/src/index.ts b/packages/sdk-node/src/index.ts index dd156938f4..185787c966 100644 --- a/packages/sdk-node/src/index.ts +++ b/packages/sdk-node/src/index.ts @@ -20,7 +20,6 @@ export { Clerk, clerkClient, ClerkExpressRequireAuth, ClerkExpressWithAuth, crea const { users, - smsMessages, sessions, emailAddresses, phoneNumbers, @@ -42,7 +41,6 @@ export { organizations, phoneNumbers, sessions, - smsMessages, users, };