Skip to content

Commit a8e1592

Browse files
author
Nikos Polykandriotis
committed
feat(backend): Deprecate createSMSMessage
1 parent d8cd0e2 commit a8e1592

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

.changeset/slimy-windows-grab.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
'@clerk/backend': patch
3+
---
4+
5+
Deprecate `createSMSMessage` and `SMSMessageApi` from `clerkClient`.
6+
7+
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.
8+
9+
For a brief period it will still be accessible for instances that have used it in the past 7
10+
days (13-11-2023 to 20-11-2023).
11+
12+
New instances will get a 403 forbidden response if they try to access it.

packages/backend/src/api/endpoints/SMSMessageApi.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import { deprecated } from '@clerk/shared/deprecated';
2+
13
import type { SMSMessage } from '../resources/SMSMessage';
24
import { AbstractAPI } from './AbstractApi';
35

@@ -8,8 +10,15 @@ type SMSParams = {
810
message: string;
911
};
1012

13+
/**
14+
* @deprecated This endpoint is no longer available and the function will be removed in the next major version.
15+
*/
1116
export class SMSMessageAPI extends AbstractAPI {
17+
/**
18+
* @deprecated This endpoint is no longer available and the function will be removed in the next major version.
19+
*/
1220
public async createSMSMessage(params: SMSParams) {
21+
deprecated('SMSMessageAPI.createSMSMessage', 'This endpoint is no longer available');
1322
return this.request<SMSMessage>({
1423
method: 'POST',
1524
path: basePath,

0 commit comments

Comments
 (0)