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.
clerk · Nov 22, 2023 · 4aaf510 · 4aaf510
1 parent 4bb5705
commit 4aaf510
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 45 deletions.
diff --git a/.changeset/eleven-bananas-joke.md 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
@@ -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
@@ -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
diff --git 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
@@ -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
diff --git 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
@@ -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,
 };