Class: SmsControllerApi
Hierarchy
-
↳
SmsControllerApi
Table of contents
Constructors
Properties
Methods
- deleteSmsMessage
- deleteSmsMessageRaw
- deleteSmsMessages
- deleteSmsMessagesRaw
- getSmsMessage
- getSmsMessageRaw
- getSmsMessagesPaginated
- getSmsMessagesPaginatedRaw
- request
- withMiddleware
- withPostMiddleware
- withPreMiddleware
Constructors
constructor
• new SmsControllerApi(configuration?
)
Parameters
Name | Type |
---|---|
configuration | Configuration |
Inherited from
Properties
configuration
• Protected
configuration: Configuration
Inherited from
Methods
deleteSmsMessage
▸ deleteSmsMessage(requestParameters
, initOverrides?
): Promise
<void
>
Delete an SMS message Delete SMS message.
Parameters
Name | Type |
---|---|
requestParameters | DeleteSmsMessageRequest |
initOverrides? | RequestInit |
Returns
Promise
<void
>
deleteSmsMessageRaw
▸ deleteSmsMessageRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<void
>>
Delete an SMS message Delete SMS message.
Parameters
Name | Type |
---|---|
requestParameters | DeleteSmsMessageRequest |
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<void
>>
deleteSmsMessages
▸ deleteSmsMessages(requestParameters
, initOverrides?
): Promise
<void
>
Delete all SMS messages or all messages for a given phone number Delete all SMS messages
Parameters
Name | Type |
---|---|
requestParameters | DeleteSmsMessagesRequest |
initOverrides? | RequestInit |
Returns
Promise
<void
>
deleteSmsMessagesRaw
▸ deleteSmsMessagesRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<void
>>
Delete all SMS messages or all messages for a given phone number Delete all SMS messages
Parameters
Name | Type |
---|---|
requestParameters | DeleteSmsMessagesRequest |
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<void
>>
getSmsMessage
▸ getSmsMessage(requestParameters
, initOverrides?
): 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
Name | Type |
---|---|
requestParameters | GetSmsMessageRequest |
initOverrides? | RequestInit |
Returns
Promise
<SmsDto
>
getSmsMessageRaw
▸ getSmsMessageRaw(requestParameters
, initOverrides?
): 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
Name | Type |
---|---|
requestParameters | GetSmsMessageRequest |
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<SmsDto
>>
getSmsMessagesPaginated
▸ getSmsMessagesPaginated(requestParameters
, initOverrides?
): Promise
<PageSmsProjection
>
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
Name | Type |
---|---|
requestParameters | GetSmsMessagesPaginatedRequest |
initOverrides? | RequestInit |
Returns
Promise
<PageSmsProjection
>
getSmsMessagesPaginatedRaw
▸ getSmsMessagesPaginatedRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<PageSmsProjection
>>
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
Name | Type |
---|---|
requestParameters | GetSmsMessagesPaginatedRequest |
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<PageSmsProjection
>>
request
▸ Protected
request(context
, initOverrides?
): Promise
<Response
>
Parameters
Name | Type |
---|---|
context | RequestOpts |
initOverrides? | RequestInit |
Returns
Promise
<Response
>
Inherited from
withMiddleware
▸ withMiddleware<T
>(this
, ...middlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
this | T |
...middlewares | Middleware [] |
Returns
T
Inherited from
withPostMiddleware
▸ withPostMiddleware<T
>(this
, ...postMiddlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
this | T |
...postMiddlewares | (context : ResponseContext ) => Promise <void |
Returns
T
Inherited from
withPreMiddleware
▸ withPreMiddleware<T
>(this
, ...preMiddlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
this | T |
...preMiddlewares | (context : RequestContext ) => Promise <void |
Returns
T