Class SmsControllerApi

Hierarchy

BaseAPI
- SmsControllerApi

Constructors

constructor

new SmsControllerApi(configuration?: Configuration): SmsControllerApi
Parameters
- configuration: Configuration = ...
Returns SmsControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteSentSmsMessage

deleteSentSmsMessage(requestParameters: DeleteSentSmsMessageRequest, initOverrides?: RequestInit): Promise<void>
Delete a sent SMS message Delete sent SMS message.
Parameters
- requestParameters: DeleteSentSmsMessageRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteSentSmsMessageRaw

deleteSentSmsMessageRaw(requestParameters: DeleteSentSmsMessageRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete a sent SMS message Delete sent SMS message.
Parameters
- requestParameters: DeleteSentSmsMessageRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

deleteSentSmsMessages

deleteSentSmsMessages(requestParameters: DeleteSentSmsMessagesRequest, initOverrides?: RequestInit): Promise<void>
Delete all sent SMS messages or all messages for a given phone number Delete all sent SMS messages
Parameters
- requestParameters: DeleteSentSmsMessagesRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteSentSmsMessagesRaw

deleteSentSmsMessagesRaw(requestParameters: DeleteSentSmsMessagesRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete all sent SMS messages or all messages for a given phone number Delete all sent SMS messages
Parameters
- requestParameters: DeleteSentSmsMessagesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

deleteSmsMessage

deleteSmsMessage(requestParameters: DeleteSmsMessageRequest, initOverrides?: RequestInit): Promise<void>
Delete an SMS message Delete SMS message.
Parameters
- requestParameters: DeleteSmsMessageRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteSmsMessageRaw

deleteSmsMessageRaw(requestParameters: DeleteSmsMessageRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete an SMS message Delete SMS message.
Parameters
- requestParameters: DeleteSmsMessageRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

deleteSmsMessages

deleteSmsMessages(requestParameters: DeleteSmsMessagesRequest, initOverrides?: RequestInit): Promise<void>
Delete all SMS messages or all messages for a given phone number Delete all SMS messages
Parameters
- requestParameters: DeleteSmsMessagesRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteSmsMessagesRaw

deleteSmsMessagesRaw(requestParameters: DeleteSmsMessagesRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete all SMS messages or all messages for a given phone number Delete all SMS messages
Parameters
- requestParameters: DeleteSmsMessagesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

getAllSmsMessages

getAllSmsMessages(requestParameters: GetAllSmsMessagesRequest, initOverrides?: RequestInit): Promise<PageSmsProjection>
Parameters
- requestParameters: GetAllSmsMessagesRequest
- Optional initOverrides: RequestInit
Returns Promise<PageSmsProjection>

getAllSmsMessagesRaw

getAllSmsMessagesRaw(requestParameters: GetAllSmsMessagesRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageSmsProjection>>
Parameters
- requestParameters: GetAllSmsMessagesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageSmsProjection>>

getReplyForSmsMessage

getReplyForSmsMessage(requestParameters: GetReplyForSmsMessageRequest, initOverrides?: RequestInit): Promise<ReplyForSms>
Get reply for an SMS message. Get reply for an SMS message
Parameters
- requestParameters: GetReplyForSmsMessageRequest
- Optional initOverrides: RequestInit
Returns Promise<ReplyForSms>

getReplyForSmsMessageRaw

getReplyForSmsMessageRaw(requestParameters: GetReplyForSmsMessageRequest, initOverrides?: RequestInit): Promise<ApiResponse<ReplyForSms>>
Get reply for an SMS message. Get reply for an SMS message
Parameters
- requestParameters: GetReplyForSmsMessageRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ReplyForSms>>

getSentSmsCount

getSentSmsCount(initOverrides?: RequestInit): Promise<CountDto>
Get number of sent SMS Get sent SMS count
Parameters
- Optional initOverrides: RequestInit
Returns Promise<CountDto>

getSentSmsCountRaw

getSentSmsCountRaw(initOverrides?: RequestInit): Promise<ApiResponse<CountDto>>
Get number of sent SMS Get sent SMS count
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CountDto>>

getSentSmsMessage

getSentSmsMessage(requestParameters: GetSentSmsMessageRequest, initOverrides?: RequestInit): Promise<SentSmsDto>
Returns an SMS summary object with content. Get sent SMS content including body. Expects sent SMS to exist by ID.
Parameters
- requestParameters: GetSentSmsMessageRequest
- Optional initOverrides: RequestInit
Returns Promise<SentSmsDto>

getSentSmsMessageRaw

getSentSmsMessageRaw(requestParameters: GetSentSmsMessageRequest, initOverrides?: RequestInit): Promise<ApiResponse<SentSmsDto>>
Returns an SMS summary object with content. Get sent SMS content including body. Expects sent SMS to exist by ID.
Parameters
- requestParameters: GetSentSmsMessageRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<SentSmsDto>>

getSentSmsMessagesPaginated

getSentSmsMessagesPaginated(requestParameters: GetSentSmsMessagesPaginatedRequest, initOverrides?: RequestInit): Promise<PageSentSmsProjection>
By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages Get all SMS messages in all phone numbers in paginated form. .
Parameters
- requestParameters: GetSentSmsMessagesPaginatedRequest
- Optional initOverrides: RequestInit
Returns Promise<PageSentSmsProjection>

getSentSmsMessagesPaginatedRaw

getSentSmsMessagesPaginatedRaw(requestParameters: GetSentSmsMessagesPaginatedRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageSentSmsProjection>>
By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages Get all SMS messages in all phone numbers in paginated form. .
Parameters
- requestParameters: GetSentSmsMessagesPaginatedRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageSentSmsProjection>>

getSmsCodes

getSmsCodes(requestParameters: GetSmsCodesRequest, initOverrides?: RequestInit): Promise<ExtractCodesResult>
Extract one-time passcodes and verification tokens from SMS body content. Deterministic PATTERN extraction is available now. Use method flags to control fallback behavior for QA. Extract verification codes from an SMS
Parameters
- requestParameters: GetSmsCodesRequest
- Optional initOverrides: RequestInit
Returns Promise<ExtractCodesResult>

getSmsCodesRaw

getSmsCodesRaw(requestParameters: GetSmsCodesRequest, initOverrides?: RequestInit): Promise<ApiResponse<ExtractCodesResult>>
Extract one-time passcodes and verification tokens from SMS body content. Deterministic PATTERN extraction is available now. Use method flags to control fallback behavior for QA. Extract verification codes from an SMS
Parameters
- requestParameters: GetSmsCodesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ExtractCodesResult>>

getSmsCount

getSmsCount(initOverrides?: RequestInit): Promise<CountDto>
Get number of SMS Get SMS count
Parameters
- Optional initOverrides: RequestInit
Returns Promise<CountDto>

getSmsCountRaw

getSmsCountRaw(initOverrides?: RequestInit): Promise<ApiResponse<CountDto>>
Get number of SMS Get SMS count
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CountDto>>

getSmsMessage

getSmsMessage(requestParameters: GetSmsMessageRequest, initOverrides?: RequestInit): Promise<SmsDto>
Returns a SMS summary object with content. Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.
Parameters
- requestParameters: GetSmsMessageRequest
- Optional initOverrides: RequestInit
Returns Promise<SmsDto>

getSmsMessageRaw

getSmsMessageRaw(requestParameters: GetSmsMessageRequest, initOverrides?: RequestInit): Promise<ApiResponse<SmsDto>>
Returns a SMS summary object with content. Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.
Parameters
- requestParameters: GetSmsMessageRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<SmsDto>>

getUnreadSmsCount

getUnreadSmsCount(initOverrides?: RequestInit): Promise<UnreadCount>
Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response Get unread SMS count
Parameters
- Optional initOverrides: RequestInit
Returns Promise<UnreadCount>

getUnreadSmsCountRaw

getUnreadSmsCountRaw(initOverrides?: RequestInit): Promise<ApiResponse<UnreadCount>>
Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response Get unread SMS count
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<UnreadCount>>

replyToSmsMessage

replyToSmsMessage(requestParameters: ReplyToSmsMessageRequest, initOverrides?: RequestInit): Promise<SentSmsDto>
Reply to an SMS message. Send a reply to a received SMS message. Replies are sent from the receiving number.
Parameters
- requestParameters: ReplyToSmsMessageRequest
- Optional initOverrides: RequestInit
Returns Promise<SentSmsDto>

replyToSmsMessageRaw

replyToSmsMessageRaw(requestParameters: ReplyToSmsMessageRequest, initOverrides?: RequestInit): Promise<ApiResponse<SentSmsDto>>
Reply to an SMS message. Send a reply to a received SMS message. Replies are sent from the receiving number.
Parameters
- requestParameters: ReplyToSmsMessageRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<SentSmsDto>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

sendSms

sendSms(requestParameters: SendSmsRequest, initOverrides?: RequestInit): Promise<SentSmsDto>
Parameters
- requestParameters: SendSmsRequest
- Optional initOverrides: RequestInit
Returns Promise<SentSmsDto>

sendSmsRaw

sendSmsRaw(requestParameters: SendSmsRequest, initOverrides?: RequestInit): Promise<ApiResponse<SentSmsDto>>
Parameters
- requestParameters: SendSmsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<SentSmsDto>>

setSmsFavourited

setSmsFavourited(requestParameters: SetSmsFavouritedRequest, initOverrides?: RequestInit): Promise<SmsDto>
Parameters
- requestParameters: SetSmsFavouritedRequest
- Optional initOverrides: RequestInit
Returns Promise<SmsDto>

setSmsFavouritedRaw

setSmsFavouritedRaw(requestParameters: SetSmsFavouritedRequest, initOverrides?: RequestInit): Promise<ApiResponse<SmsDto>>
Parameters
- requestParameters: SetSmsFavouritedRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<SmsDto>>

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware

Class SmsControllerApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = ...

Returns SmsControllerApi

Properties

Protected configuration

Methods

deleteSentSmsMessage

Parameters

requestParameters: DeleteSentSmsMessageRequest

Optional initOverrides: RequestInit

Returns Promise<void>

deleteSentSmsMessageRaw

Parameters

requestParameters: DeleteSentSmsMessageRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<void>>

deleteSentSmsMessages

Parameters

requestParameters: DeleteSentSmsMessagesRequest

Optional initOverrides: RequestInit

Returns Promise<void>

deleteSentSmsMessagesRaw

Parameters

requestParameters: DeleteSentSmsMessagesRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<void>>

deleteSmsMessage

Parameters

requestParameters: DeleteSmsMessageRequest

Optional initOverrides: RequestInit

Returns Promise<void>

deleteSmsMessageRaw

Parameters

requestParameters: DeleteSmsMessageRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<void>>

deleteSmsMessages

Parameters

requestParameters: DeleteSmsMessagesRequest

Optional initOverrides: RequestInit

Returns Promise<void>

deleteSmsMessagesRaw

Parameters

requestParameters: DeleteSmsMessagesRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<void>>

getAllSmsMessages

Parameters

requestParameters: GetAllSmsMessagesRequest

Optional initOverrides: RequestInit

Returns Promise<PageSmsProjection>

getAllSmsMessagesRaw

Parameters

requestParameters: GetAllSmsMessagesRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<PageSmsProjection>>

getReplyForSmsMessage

Parameters

requestParameters: GetReplyForSmsMessageRequest

Optional initOverrides: RequestInit

Returns Promise<ReplyForSms>

getReplyForSmsMessageRaw

Parameters

requestParameters: GetReplyForSmsMessageRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<ReplyForSms>>

getSentSmsCount

Parameters

Optional initOverrides: RequestInit

Returns Promise<CountDto>

getSentSmsCountRaw

Parameters

`Protected` configuration

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Protected` request