Documentation

SmsControllerApi
in package

SmsControllerApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

contentTypes  = ['deleteSentSmsMessage' => ['application/json'], 'deleteSentSmsMessages' => ['application/json'], 'deleteSmsMessage' => ['application/json'], 'deleteSmsMessages' => ['application/json'], 'getAllSmsMessages' => ['application/json'], 'getReplyForSmsMessage' => ['application/json'], 'getSentSmsCount' => ['application/json'], 'getSentSmsMessage' => ['application/json'], 'getSentSmsMessagesPaginated' => ['application/json'], 'getSmsCount' => ['application/json'], 'getSmsMessage' => ['application/json'], 'getUnreadSmsCount' => ['application/json'], 'replyToSmsMessage' => ['application/json'], 'sendSms' => ['application/json'], 'setSmsFavourited' => ['application/json']]
$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int
__construct()  : mixed
deleteSentSmsMessage()  : void
Operation deleteSentSmsMessage
deleteSentSmsMessageAsync()  : PromiseInterface
Operation deleteSentSmsMessageAsync
deleteSentSmsMessageAsyncWithHttpInfo()  : PromiseInterface
Operation deleteSentSmsMessageAsyncWithHttpInfo
deleteSentSmsMessageRequest()  : Request
Create request for operation 'deleteSentSmsMessage'
deleteSentSmsMessages()  : void
Operation deleteSentSmsMessages
deleteSentSmsMessagesAsync()  : PromiseInterface
Operation deleteSentSmsMessagesAsync
deleteSentSmsMessagesAsyncWithHttpInfo()  : PromiseInterface
Operation deleteSentSmsMessagesAsyncWithHttpInfo
deleteSentSmsMessagesRequest()  : Request
Create request for operation 'deleteSentSmsMessages'
deleteSentSmsMessagesWithHttpInfo()  : array<string|int, mixed>
Operation deleteSentSmsMessagesWithHttpInfo
deleteSentSmsMessageWithHttpInfo()  : array<string|int, mixed>
Operation deleteSentSmsMessageWithHttpInfo
deleteSmsMessage()  : void
Operation deleteSmsMessage
deleteSmsMessageAsync()  : PromiseInterface
Operation deleteSmsMessageAsync
deleteSmsMessageAsyncWithHttpInfo()  : PromiseInterface
Operation deleteSmsMessageAsyncWithHttpInfo
deleteSmsMessageRequest()  : Request
Create request for operation 'deleteSmsMessage'
deleteSmsMessages()  : void
Operation deleteSmsMessages
deleteSmsMessagesAsync()  : PromiseInterface
Operation deleteSmsMessagesAsync
deleteSmsMessagesAsyncWithHttpInfo()  : PromiseInterface
Operation deleteSmsMessagesAsyncWithHttpInfo
deleteSmsMessagesRequest()  : Request
Create request for operation 'deleteSmsMessages'
deleteSmsMessagesWithHttpInfo()  : array<string|int, mixed>
Operation deleteSmsMessagesWithHttpInfo
deleteSmsMessageWithHttpInfo()  : array<string|int, mixed>
Operation deleteSmsMessageWithHttpInfo
getAllSmsMessages()  : PageSmsProjection
Operation getAllSmsMessages
getAllSmsMessagesAsync()  : PromiseInterface
Operation getAllSmsMessagesAsync
getAllSmsMessagesAsyncWithHttpInfo()  : PromiseInterface
Operation getAllSmsMessagesAsyncWithHttpInfo
getAllSmsMessagesRequest()  : Request
Create request for operation 'getAllSmsMessages'
getAllSmsMessagesWithHttpInfo()  : array<string|int, mixed>
Operation getAllSmsMessagesWithHttpInfo
getConfig()  : Configuration
getHostIndex()  : int
Get the host index
getReplyForSmsMessage()  : ReplyForSms
Operation getReplyForSmsMessage
getReplyForSmsMessageAsync()  : PromiseInterface
Operation getReplyForSmsMessageAsync
getReplyForSmsMessageAsyncWithHttpInfo()  : PromiseInterface
Operation getReplyForSmsMessageAsyncWithHttpInfo
getReplyForSmsMessageRequest()  : Request
Create request for operation 'getReplyForSmsMessage'
getReplyForSmsMessageWithHttpInfo()  : array<string|int, mixed>
Operation getReplyForSmsMessageWithHttpInfo
getSentSmsCount()  : CountDto
Operation getSentSmsCount
getSentSmsCountAsync()  : PromiseInterface
Operation getSentSmsCountAsync
getSentSmsCountAsyncWithHttpInfo()  : PromiseInterface
Operation getSentSmsCountAsyncWithHttpInfo
getSentSmsCountRequest()  : Request
Create request for operation 'getSentSmsCount'
getSentSmsCountWithHttpInfo()  : array<string|int, mixed>
Operation getSentSmsCountWithHttpInfo
getSentSmsMessage()  : SentSmsDto
Operation getSentSmsMessage
getSentSmsMessageAsync()  : PromiseInterface
Operation getSentSmsMessageAsync
getSentSmsMessageAsyncWithHttpInfo()  : PromiseInterface
Operation getSentSmsMessageAsyncWithHttpInfo
getSentSmsMessageRequest()  : Request
Create request for operation 'getSentSmsMessage'
getSentSmsMessagesPaginated()  : PageSentSmsProjection
Operation getSentSmsMessagesPaginated
getSentSmsMessagesPaginatedAsync()  : PromiseInterface
Operation getSentSmsMessagesPaginatedAsync
getSentSmsMessagesPaginatedAsyncWithHttpInfo()  : PromiseInterface
Operation getSentSmsMessagesPaginatedAsyncWithHttpInfo
getSentSmsMessagesPaginatedRequest()  : Request
Create request for operation 'getSentSmsMessagesPaginated'
getSentSmsMessagesPaginatedWithHttpInfo()  : array<string|int, mixed>
Operation getSentSmsMessagesPaginatedWithHttpInfo
getSentSmsMessageWithHttpInfo()  : array<string|int, mixed>
Operation getSentSmsMessageWithHttpInfo
getSmsCount()  : CountDto
Operation getSmsCount
getSmsCountAsync()  : PromiseInterface
Operation getSmsCountAsync
getSmsCountAsyncWithHttpInfo()  : PromiseInterface
Operation getSmsCountAsyncWithHttpInfo
getSmsCountRequest()  : Request
Create request for operation 'getSmsCount'
getSmsCountWithHttpInfo()  : array<string|int, mixed>
Operation getSmsCountWithHttpInfo
getSmsMessage()  : SmsDto
Operation getSmsMessage
getSmsMessageAsync()  : PromiseInterface
Operation getSmsMessageAsync
getSmsMessageAsyncWithHttpInfo()  : PromiseInterface
Operation getSmsMessageAsyncWithHttpInfo
getSmsMessageRequest()  : Request
Create request for operation 'getSmsMessage'
getSmsMessageWithHttpInfo()  : array<string|int, mixed>
Operation getSmsMessageWithHttpInfo
getUnreadSmsCount()  : UnreadCount
Operation getUnreadSmsCount
getUnreadSmsCountAsync()  : PromiseInterface
Operation getUnreadSmsCountAsync
getUnreadSmsCountAsyncWithHttpInfo()  : PromiseInterface
Operation getUnreadSmsCountAsyncWithHttpInfo
getUnreadSmsCountRequest()  : Request
Create request for operation 'getUnreadSmsCount'
getUnreadSmsCountWithHttpInfo()  : array<string|int, mixed>
Operation getUnreadSmsCountWithHttpInfo
replyToSmsMessage()  : SentSmsDto
Operation replyToSmsMessage
replyToSmsMessageAsync()  : PromiseInterface
Operation replyToSmsMessageAsync
replyToSmsMessageAsyncWithHttpInfo()  : PromiseInterface
Operation replyToSmsMessageAsyncWithHttpInfo
replyToSmsMessageRequest()  : Request
Create request for operation 'replyToSmsMessage'
replyToSmsMessageWithHttpInfo()  : array<string|int, mixed>
Operation replyToSmsMessageWithHttpInfo
sendSms()  : SentSmsDto
Operation sendSms
sendSmsAsync()  : PromiseInterface
Operation sendSmsAsync
sendSmsAsyncWithHttpInfo()  : PromiseInterface
Operation sendSmsAsyncWithHttpInfo
sendSmsRequest()  : Request
Create request for operation 'sendSms'
sendSmsWithHttpInfo()  : array<string|int, mixed>
Operation sendSmsWithHttpInfo
setHostIndex()  : void
Set the host index
setSmsFavourited()  : SmsDto
Operation setSmsFavourited
setSmsFavouritedAsync()  : PromiseInterface
Operation setSmsFavouritedAsync
setSmsFavouritedAsyncWithHttpInfo()  : PromiseInterface
Operation setSmsFavouritedAsyncWithHttpInfo
setSmsFavouritedRequest()  : Request
Create request for operation 'setSmsFavourited'
setSmsFavouritedWithHttpInfo()  : array<string|int, mixed>
Operation setSmsFavouritedWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option

Constants

contentTypes

public array<string|int, string> contentTypes = ['deleteSentSmsMessage' => ['application/json'], 'deleteSentSmsMessages' => ['application/json'], 'deleteSmsMessage' => ['application/json'], 'deleteSmsMessages' => ['application/json'], 'getAllSmsMessages' => ['application/json'], 'getReplyForSmsMessage' => ['application/json'], 'getSentSmsCount' => ['application/json'], 'getSentSmsMessage' => ['application/json'], 'getSentSmsMessagesPaginated' => ['application/json'], 'getSmsCount' => ['application/json'], 'getSmsMessage' => ['application/json'], 'getUnreadSmsCount' => ['application/json'], 'replyToSmsMessage' => ['application/json'], 'sendSms' => ['application/json'], 'setSmsFavourited' => ['application/json']]

Properties

Methods

__construct()

public __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int

(Optional) host index to select the list of hosts if defined in the OpenAPI spec

Return values
mixed

deleteSentSmsMessage()

Operation deleteSentSmsMessage

public deleteSentSmsMessage(string $sent_sms_id[, string $contentType = self::contentTypes['deleteSentSmsMessage'][0] ]) : void

Delete sent SMS message.

Parameters
$sent_sms_id : string

sent_sms_id (required)

$contentType : string = self::contentTypes['deleteSentSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSentSmsMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

deleteSentSmsMessageAsync()

Operation deleteSentSmsMessageAsync

public deleteSentSmsMessageAsync(string $sent_sms_id[, string $contentType = self::contentTypes['deleteSentSmsMessage'][0] ]) : PromiseInterface

Delete sent SMS message.

Parameters
$sent_sms_id : string

(required)

$contentType : string = self::contentTypes['deleteSentSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSentSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteSentSmsMessageAsyncWithHttpInfo()

Operation deleteSentSmsMessageAsyncWithHttpInfo

public deleteSentSmsMessageAsyncWithHttpInfo(string $sent_sms_id[, string $contentType = self::contentTypes['deleteSentSmsMessage'][0] ]) : PromiseInterface

Delete sent SMS message.

Parameters
$sent_sms_id : string

(required)

$contentType : string = self::contentTypes['deleteSentSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSentSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteSentSmsMessageRequest()

Create request for operation 'deleteSentSmsMessage'

public deleteSentSmsMessageRequest(string $sent_sms_id[, string $contentType = self::contentTypes['deleteSentSmsMessage'][0] ]) : Request
Parameters
$sent_sms_id : string

(required)

$contentType : string = self::contentTypes['deleteSentSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSentSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

deleteSentSmsMessages()

Operation deleteSentSmsMessages

public deleteSentSmsMessages([string $phone_number_id = null ][, string $contentType = self::contentTypes['deleteSentSmsMessages'][0] ]) : void

Delete all sent SMS messages

Parameters
$phone_number_id : string = null

phone_number_id (optional)

$contentType : string = self::contentTypes['deleteSentSmsMessages'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSentSmsMessages'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

deleteSentSmsMessagesAsync()

Operation deleteSentSmsMessagesAsync

public deleteSentSmsMessagesAsync([string $phone_number_id = null ][, string $contentType = self::contentTypes['deleteSentSmsMessages'][0] ]) : PromiseInterface

Delete all sent SMS messages

Parameters
$phone_number_id : string = null

(optional)

$contentType : string = self::contentTypes['deleteSentSmsMessages'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSentSmsMessages'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteSentSmsMessagesAsyncWithHttpInfo()

Operation deleteSentSmsMessagesAsyncWithHttpInfo

public deleteSentSmsMessagesAsyncWithHttpInfo([string $phone_number_id = null ][, string $contentType = self::contentTypes['deleteSentSmsMessages'][0] ]) : PromiseInterface

Delete all sent SMS messages

Parameters
$phone_number_id : string = null

(optional)

$contentType : string = self::contentTypes['deleteSentSmsMessages'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSentSmsMessages'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteSentSmsMessagesRequest()

Create request for operation 'deleteSentSmsMessages'

public deleteSentSmsMessagesRequest([string $phone_number_id = null ][, string $contentType = self::contentTypes['deleteSentSmsMessages'][0] ]) : Request
Parameters
$phone_number_id : string = null

(optional)

$contentType : string = self::contentTypes['deleteSentSmsMessages'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSentSmsMessages'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

deleteSentSmsMessagesWithHttpInfo()

Operation deleteSentSmsMessagesWithHttpInfo

public deleteSentSmsMessagesWithHttpInfo([string $phone_number_id = null ][, string $contentType = self::contentTypes['deleteSentSmsMessages'][0] ]) : array<string|int, mixed>

Delete all sent SMS messages

Parameters
$phone_number_id : string = null

(optional)

$contentType : string = self::contentTypes['deleteSentSmsMessages'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSentSmsMessages'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

deleteSentSmsMessageWithHttpInfo()

Operation deleteSentSmsMessageWithHttpInfo

public deleteSentSmsMessageWithHttpInfo(string $sent_sms_id[, string $contentType = self::contentTypes['deleteSentSmsMessage'][0] ]) : array<string|int, mixed>

Delete sent SMS message.

Parameters
$sent_sms_id : string

(required)

$contentType : string = self::contentTypes['deleteSentSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSentSmsMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

deleteSmsMessage()

Operation deleteSmsMessage

public deleteSmsMessage(string $sms_id[, string $contentType = self::contentTypes['deleteSmsMessage'][0] ]) : void

Delete SMS message.

Parameters
$sms_id : string

sms_id (required)

$contentType : string = self::contentTypes['deleteSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSmsMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

deleteSmsMessageAsync()

Operation deleteSmsMessageAsync

public deleteSmsMessageAsync(string $sms_id[, string $contentType = self::contentTypes['deleteSmsMessage'][0] ]) : PromiseInterface

Delete SMS message.

Parameters
$sms_id : string

(required)

$contentType : string = self::contentTypes['deleteSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteSmsMessageAsyncWithHttpInfo()

Operation deleteSmsMessageAsyncWithHttpInfo

public deleteSmsMessageAsyncWithHttpInfo(string $sms_id[, string $contentType = self::contentTypes['deleteSmsMessage'][0] ]) : PromiseInterface

Delete SMS message.

Parameters
$sms_id : string

(required)

$contentType : string = self::contentTypes['deleteSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteSmsMessageRequest()

Create request for operation 'deleteSmsMessage'

public deleteSmsMessageRequest(string $sms_id[, string $contentType = self::contentTypes['deleteSmsMessage'][0] ]) : Request
Parameters
$sms_id : string

(required)

$contentType : string = self::contentTypes['deleteSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

deleteSmsMessages()

Operation deleteSmsMessages

public deleteSmsMessages([string $phone_number_id = null ][, string $contentType = self::contentTypes['deleteSmsMessages'][0] ]) : void

Delete all SMS messages

Parameters
$phone_number_id : string = null

phone_number_id (optional)

$contentType : string = self::contentTypes['deleteSmsMessages'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSmsMessages'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

deleteSmsMessagesAsync()

Operation deleteSmsMessagesAsync

public deleteSmsMessagesAsync([string $phone_number_id = null ][, string $contentType = self::contentTypes['deleteSmsMessages'][0] ]) : PromiseInterface

Delete all SMS messages

Parameters
$phone_number_id : string = null

(optional)

$contentType : string = self::contentTypes['deleteSmsMessages'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSmsMessages'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteSmsMessagesAsyncWithHttpInfo()

Operation deleteSmsMessagesAsyncWithHttpInfo

public deleteSmsMessagesAsyncWithHttpInfo([string $phone_number_id = null ][, string $contentType = self::contentTypes['deleteSmsMessages'][0] ]) : PromiseInterface

Delete all SMS messages

Parameters
$phone_number_id : string = null

(optional)

$contentType : string = self::contentTypes['deleteSmsMessages'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSmsMessages'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteSmsMessagesRequest()

Create request for operation 'deleteSmsMessages'

public deleteSmsMessagesRequest([string $phone_number_id = null ][, string $contentType = self::contentTypes['deleteSmsMessages'][0] ]) : Request
Parameters
$phone_number_id : string = null

(optional)

$contentType : string = self::contentTypes['deleteSmsMessages'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSmsMessages'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

deleteSmsMessagesWithHttpInfo()

Operation deleteSmsMessagesWithHttpInfo

public deleteSmsMessagesWithHttpInfo([string $phone_number_id = null ][, string $contentType = self::contentTypes['deleteSmsMessages'][0] ]) : array<string|int, mixed>

Delete all SMS messages

Parameters
$phone_number_id : string = null

(optional)

$contentType : string = self::contentTypes['deleteSmsMessages'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSmsMessages'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

deleteSmsMessageWithHttpInfo()

Operation deleteSmsMessageWithHttpInfo

public deleteSmsMessageWithHttpInfo(string $sms_id[, string $contentType = self::contentTypes['deleteSmsMessage'][0] ]) : array<string|int, mixed>

Delete SMS message.

Parameters
$sms_id : string

(required)

$contentType : string = self::contentTypes['deleteSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['deleteSmsMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

getAllSmsMessages()

Operation getAllSmsMessages

public getAllSmsMessages([string $phone_number = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, bool $favourite = false ][, string $contentType = self::contentTypes['getAllSmsMessages'][0] ]) : PageSmsProjection
Parameters
$phone_number : string = null

Optional receiving phone number to filter SMS messages for (optional)

$page : int

Optional page index in SMS list pagination (optional, default to 0)

$size : int = 20

Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter SMSs received after given date time (optional)

$before : DateTime = null

Optional filter SMSs received before given date time (optional)

$search : string = null

Optional search filter (optional)

$favourite : bool = false

Optionally filter results for favourites only (optional, default to false)

$contentType : string = self::contentTypes['getAllSmsMessages'][0]

The value for the Content-Type header. Check self::contentTypes['getAllSmsMessages'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageSmsProjection

getAllSmsMessagesAsync()

Operation getAllSmsMessagesAsync

public getAllSmsMessagesAsync([string $phone_number = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, bool $favourite = false ][, string $contentType = self::contentTypes['getAllSmsMessages'][0] ]) : PromiseInterface
Parameters
$phone_number : string = null

Optional receiving phone number to filter SMS messages for (optional)

$page : int

Optional page index in SMS list pagination (optional, default to 0)

$size : int = 20

Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter SMSs received after given date time (optional)

$before : DateTime = null

Optional filter SMSs received before given date time (optional)

$search : string = null

Optional search filter (optional)

$favourite : bool = false

Optionally filter results for favourites only (optional, default to false)

$contentType : string = self::contentTypes['getAllSmsMessages'][0]

The value for the Content-Type header. Check self::contentTypes['getAllSmsMessages'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllSmsMessagesAsyncWithHttpInfo()

Operation getAllSmsMessagesAsyncWithHttpInfo

public getAllSmsMessagesAsyncWithHttpInfo([string $phone_number = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, bool $favourite = false ][, string $contentType = self::contentTypes['getAllSmsMessages'][0] ]) : PromiseInterface
Parameters
$phone_number : string = null

Optional receiving phone number to filter SMS messages for (optional)

$page : int

Optional page index in SMS list pagination (optional, default to 0)

$size : int = 20

Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter SMSs received after given date time (optional)

$before : DateTime = null

Optional filter SMSs received before given date time (optional)

$search : string = null

Optional search filter (optional)

$favourite : bool = false

Optionally filter results for favourites only (optional, default to false)

$contentType : string = self::contentTypes['getAllSmsMessages'][0]

The value for the Content-Type header. Check self::contentTypes['getAllSmsMessages'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllSmsMessagesRequest()

Create request for operation 'getAllSmsMessages'

public getAllSmsMessagesRequest([string $phone_number = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, bool $favourite = false ][, string $contentType = self::contentTypes['getAllSmsMessages'][0] ]) : Request
Parameters
$phone_number : string = null

Optional receiving phone number to filter SMS messages for (optional)

$page : int

Optional page index in SMS list pagination (optional, default to 0)

$size : int = 20

Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter SMSs received after given date time (optional)

$before : DateTime = null

Optional filter SMSs received before given date time (optional)

$search : string = null

Optional search filter (optional)

$favourite : bool = false

Optionally filter results for favourites only (optional, default to false)

$contentType : string = self::contentTypes['getAllSmsMessages'][0]

The value for the Content-Type header. Check self::contentTypes['getAllSmsMessages'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getAllSmsMessagesWithHttpInfo()

Operation getAllSmsMessagesWithHttpInfo

public getAllSmsMessagesWithHttpInfo([string $phone_number = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, bool $favourite = false ][, string $contentType = self::contentTypes['getAllSmsMessages'][0] ]) : array<string|int, mixed>
Parameters
$phone_number : string = null

Optional receiving phone number to filter SMS messages for (optional)

$page : int

Optional page index in SMS list pagination (optional, default to 0)

$size : int = 20

Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter SMSs received after given date time (optional)

$before : DateTime = null

Optional filter SMSs received before given date time (optional)

$search : string = null

Optional search filter (optional)

$favourite : bool = false

Optionally filter results for favourites only (optional, default to false)

$contentType : string = self::contentTypes['getAllSmsMessages'][0]

The value for the Content-Type header. Check self::contentTypes['getAllSmsMessages'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\PageSmsProjection, HTTP status code, HTTP response headers (array of strings)

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int

Host index

getReplyForSmsMessage()

Operation getReplyForSmsMessage

public getReplyForSmsMessage(string $sms_id[, string $contentType = self::contentTypes['getReplyForSmsMessage'][0] ]) : ReplyForSms

Get reply for an SMS message

Parameters
$sms_id : string

sms_id (required)

$contentType : string = self::contentTypes['getReplyForSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['getReplyForSmsMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ReplyForSms

getReplyForSmsMessageAsync()

Operation getReplyForSmsMessageAsync

public getReplyForSmsMessageAsync(string $sms_id[, string $contentType = self::contentTypes['getReplyForSmsMessage'][0] ]) : PromiseInterface

Get reply for an SMS message

Parameters
$sms_id : string

(required)

$contentType : string = self::contentTypes['getReplyForSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['getReplyForSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getReplyForSmsMessageAsyncWithHttpInfo()

Operation getReplyForSmsMessageAsyncWithHttpInfo

public getReplyForSmsMessageAsyncWithHttpInfo(string $sms_id[, string $contentType = self::contentTypes['getReplyForSmsMessage'][0] ]) : PromiseInterface

Get reply for an SMS message

Parameters
$sms_id : string

(required)

$contentType : string = self::contentTypes['getReplyForSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['getReplyForSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getReplyForSmsMessageRequest()

Create request for operation 'getReplyForSmsMessage'

public getReplyForSmsMessageRequest(string $sms_id[, string $contentType = self::contentTypes['getReplyForSmsMessage'][0] ]) : Request
Parameters
$sms_id : string

(required)

$contentType : string = self::contentTypes['getReplyForSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['getReplyForSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getReplyForSmsMessageWithHttpInfo()

Operation getReplyForSmsMessageWithHttpInfo

public getReplyForSmsMessageWithHttpInfo(string $sms_id[, string $contentType = self::contentTypes['getReplyForSmsMessage'][0] ]) : array<string|int, mixed>

Get reply for an SMS message

Parameters
$sms_id : string

(required)

$contentType : string = self::contentTypes['getReplyForSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['getReplyForSmsMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\ReplyForSms, HTTP status code, HTTP response headers (array of strings)

getSentSmsCount()

Operation getSentSmsCount

public getSentSmsCount([string $contentType = self::contentTypes['getSentSmsCount'][0] ]) : CountDto

Get sent SMS count

Parameters
$contentType : string = self::contentTypes['getSentSmsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getSentSmsCount'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CountDto

getSentSmsCountAsync()

Operation getSentSmsCountAsync

public getSentSmsCountAsync([string $contentType = self::contentTypes['getSentSmsCount'][0] ]) : PromiseInterface

Get sent SMS count

Parameters
$contentType : string = self::contentTypes['getSentSmsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getSentSmsCount'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getSentSmsCountAsyncWithHttpInfo()

Operation getSentSmsCountAsyncWithHttpInfo

public getSentSmsCountAsyncWithHttpInfo([string $contentType = self::contentTypes['getSentSmsCount'][0] ]) : PromiseInterface

Get sent SMS count

Parameters
$contentType : string = self::contentTypes['getSentSmsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getSentSmsCount'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getSentSmsCountRequest()

Create request for operation 'getSentSmsCount'

public getSentSmsCountRequest([string $contentType = self::contentTypes['getSentSmsCount'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getSentSmsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getSentSmsCount'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getSentSmsCountWithHttpInfo()

Operation getSentSmsCountWithHttpInfo

public getSentSmsCountWithHttpInfo([string $contentType = self::contentTypes['getSentSmsCount'][0] ]) : array<string|int, mixed>

Get sent SMS count

Parameters
$contentType : string = self::contentTypes['getSentSmsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getSentSmsCount'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\CountDto, HTTP status code, HTTP response headers (array of strings)

getSentSmsMessage()

Operation getSentSmsMessage

public getSentSmsMessage(string $sent_sms_id[, string $contentType = self::contentTypes['getSentSmsMessage'][0] ]) : SentSmsDto

Get sent SMS content including body. Expects sent SMS to exist by ID.

Parameters
$sent_sms_id : string

sent_sms_id (required)

$contentType : string = self::contentTypes['getSentSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['getSentSmsMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
SentSmsDto

getSentSmsMessageAsync()

Operation getSentSmsMessageAsync

public getSentSmsMessageAsync(string $sent_sms_id[, string $contentType = self::contentTypes['getSentSmsMessage'][0] ]) : PromiseInterface

Get sent SMS content including body. Expects sent SMS to exist by ID.

Parameters
$sent_sms_id : string

(required)

$contentType : string = self::contentTypes['getSentSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['getSentSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getSentSmsMessageAsyncWithHttpInfo()

Operation getSentSmsMessageAsyncWithHttpInfo

public getSentSmsMessageAsyncWithHttpInfo(string $sent_sms_id[, string $contentType = self::contentTypes['getSentSmsMessage'][0] ]) : PromiseInterface

Get sent SMS content including body. Expects sent SMS to exist by ID.

Parameters
$sent_sms_id : string

(required)

$contentType : string = self::contentTypes['getSentSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['getSentSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getSentSmsMessageRequest()

Create request for operation 'getSentSmsMessage'

public getSentSmsMessageRequest(string $sent_sms_id[, string $contentType = self::contentTypes['getSentSmsMessage'][0] ]) : Request
Parameters
$sent_sms_id : string

(required)

$contentType : string = self::contentTypes['getSentSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['getSentSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getSentSmsMessagesPaginated()

Operation getSentSmsMessagesPaginated

public getSentSmsMessagesPaginated([string $phone_number = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $contentType = self::contentTypes['getSentSmsMessagesPaginated'][0] ]) : PageSentSmsProjection

Get all SMS messages in all phone numbers in paginated form. .

Parameters
$phone_number : string = null

Optional phone number to filter sent SMS messages for (optional)

$page : int

Optional page index in SMS list pagination (optional, default to 0)

$size : int = 20

Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter SMSs received after given date time (optional)

$before : DateTime = null

Optional filter SMSs received before given date time (optional)

$search : string = null

Optional search filter (optional)

$contentType : string = self::contentTypes['getSentSmsMessagesPaginated'][0]

The value for the Content-Type header. Check self::contentTypes['getSentSmsMessagesPaginated'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageSentSmsProjection

getSentSmsMessagesPaginatedAsync()

Operation getSentSmsMessagesPaginatedAsync

public getSentSmsMessagesPaginatedAsync([string $phone_number = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $contentType = self::contentTypes['getSentSmsMessagesPaginated'][0] ]) : PromiseInterface

Get all SMS messages in all phone numbers in paginated form. .

Parameters
$phone_number : string = null

Optional phone number to filter sent SMS messages for (optional)

$page : int

Optional page index in SMS list pagination (optional, default to 0)

$size : int = 20

Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter SMSs received after given date time (optional)

$before : DateTime = null

Optional filter SMSs received before given date time (optional)

$search : string = null

Optional search filter (optional)

$contentType : string = self::contentTypes['getSentSmsMessagesPaginated'][0]

The value for the Content-Type header. Check self::contentTypes['getSentSmsMessagesPaginated'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getSentSmsMessagesPaginatedAsyncWithHttpInfo()

Operation getSentSmsMessagesPaginatedAsyncWithHttpInfo

public getSentSmsMessagesPaginatedAsyncWithHttpInfo([string $phone_number = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $contentType = self::contentTypes['getSentSmsMessagesPaginated'][0] ]) : PromiseInterface

Get all SMS messages in all phone numbers in paginated form. .

Parameters
$phone_number : string = null

Optional phone number to filter sent SMS messages for (optional)

$page : int

Optional page index in SMS list pagination (optional, default to 0)

$size : int = 20

Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter SMSs received after given date time (optional)

$before : DateTime = null

Optional filter SMSs received before given date time (optional)

$search : string = null

Optional search filter (optional)

$contentType : string = self::contentTypes['getSentSmsMessagesPaginated'][0]

The value for the Content-Type header. Check self::contentTypes['getSentSmsMessagesPaginated'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getSentSmsMessagesPaginatedRequest()

Create request for operation 'getSentSmsMessagesPaginated'

public getSentSmsMessagesPaginatedRequest([string $phone_number = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $contentType = self::contentTypes['getSentSmsMessagesPaginated'][0] ]) : Request
Parameters
$phone_number : string = null

Optional phone number to filter sent SMS messages for (optional)

$page : int

Optional page index in SMS list pagination (optional, default to 0)

$size : int = 20

Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter SMSs received after given date time (optional)

$before : DateTime = null

Optional filter SMSs received before given date time (optional)

$search : string = null

Optional search filter (optional)

$contentType : string = self::contentTypes['getSentSmsMessagesPaginated'][0]

The value for the Content-Type header. Check self::contentTypes['getSentSmsMessagesPaginated'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getSentSmsMessagesPaginatedWithHttpInfo()

Operation getSentSmsMessagesPaginatedWithHttpInfo

public getSentSmsMessagesPaginatedWithHttpInfo([string $phone_number = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $contentType = self::contentTypes['getSentSmsMessagesPaginated'][0] ]) : array<string|int, mixed>

Get all SMS messages in all phone numbers in paginated form. .

Parameters
$phone_number : string = null

Optional phone number to filter sent SMS messages for (optional)

$page : int

Optional page index in SMS list pagination (optional, default to 0)

$size : int = 20

Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter SMSs received after given date time (optional)

$before : DateTime = null

Optional filter SMSs received before given date time (optional)

$search : string = null

Optional search filter (optional)

$contentType : string = self::contentTypes['getSentSmsMessagesPaginated'][0]

The value for the Content-Type header. Check self::contentTypes['getSentSmsMessagesPaginated'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\PageSentSmsProjection, HTTP status code, HTTP response headers (array of strings)

getSentSmsMessageWithHttpInfo()

Operation getSentSmsMessageWithHttpInfo

public getSentSmsMessageWithHttpInfo(string $sent_sms_id[, string $contentType = self::contentTypes['getSentSmsMessage'][0] ]) : array<string|int, mixed>

Get sent SMS content including body. Expects sent SMS to exist by ID.

Parameters
$sent_sms_id : string

(required)

$contentType : string = self::contentTypes['getSentSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['getSentSmsMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\SentSmsDto, HTTP status code, HTTP response headers (array of strings)

getSmsCount()

Operation getSmsCount

public getSmsCount([string $contentType = self::contentTypes['getSmsCount'][0] ]) : CountDto

Get SMS count

Parameters
$contentType : string = self::contentTypes['getSmsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getSmsCount'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CountDto

getSmsCountAsync()

Operation getSmsCountAsync

public getSmsCountAsync([string $contentType = self::contentTypes['getSmsCount'][0] ]) : PromiseInterface

Get SMS count

Parameters
$contentType : string = self::contentTypes['getSmsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getSmsCount'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getSmsCountAsyncWithHttpInfo()

Operation getSmsCountAsyncWithHttpInfo

public getSmsCountAsyncWithHttpInfo([string $contentType = self::contentTypes['getSmsCount'][0] ]) : PromiseInterface

Get SMS count

Parameters
$contentType : string = self::contentTypes['getSmsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getSmsCount'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getSmsCountRequest()

Create request for operation 'getSmsCount'

public getSmsCountRequest([string $contentType = self::contentTypes['getSmsCount'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getSmsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getSmsCount'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getSmsCountWithHttpInfo()

Operation getSmsCountWithHttpInfo

public getSmsCountWithHttpInfo([string $contentType = self::contentTypes['getSmsCount'][0] ]) : array<string|int, mixed>

Get SMS count

Parameters
$contentType : string = self::contentTypes['getSmsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getSmsCount'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\CountDto, HTTP status code, HTTP response headers (array of strings)

getSmsMessage()

Operation getSmsMessage

public getSmsMessage(string $sms_id[, string $contentType = self::contentTypes['getSmsMessage'][0] ]) : SmsDto

Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.

Parameters
$sms_id : string

sms_id (required)

$contentType : string = self::contentTypes['getSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['getSmsMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
SmsDto

getSmsMessageAsync()

Operation getSmsMessageAsync

public getSmsMessageAsync(string $sms_id[, string $contentType = self::contentTypes['getSmsMessage'][0] ]) : PromiseInterface

Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.

Parameters
$sms_id : string

(required)

$contentType : string = self::contentTypes['getSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['getSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getSmsMessageAsyncWithHttpInfo()

Operation getSmsMessageAsyncWithHttpInfo

public getSmsMessageAsyncWithHttpInfo(string $sms_id[, string $contentType = self::contentTypes['getSmsMessage'][0] ]) : PromiseInterface

Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.

Parameters
$sms_id : string

(required)

$contentType : string = self::contentTypes['getSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['getSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getSmsMessageRequest()

Create request for operation 'getSmsMessage'

public getSmsMessageRequest(string $sms_id[, string $contentType = self::contentTypes['getSmsMessage'][0] ]) : Request
Parameters
$sms_id : string

(required)

$contentType : string = self::contentTypes['getSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['getSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getSmsMessageWithHttpInfo()

Operation getSmsMessageWithHttpInfo

public getSmsMessageWithHttpInfo(string $sms_id[, string $contentType = self::contentTypes['getSmsMessage'][0] ]) : array<string|int, mixed>

Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.

Parameters
$sms_id : string

(required)

$contentType : string = self::contentTypes['getSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['getSmsMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\SmsDto, HTTP status code, HTTP response headers (array of strings)

getUnreadSmsCount()

Operation getUnreadSmsCount

public getUnreadSmsCount([string $contentType = self::contentTypes['getUnreadSmsCount'][0] ]) : UnreadCount

Get unread SMS count

Parameters
$contentType : string = self::contentTypes['getUnreadSmsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getUnreadSmsCount'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
UnreadCount

getUnreadSmsCountAsync()

Operation getUnreadSmsCountAsync

public getUnreadSmsCountAsync([string $contentType = self::contentTypes['getUnreadSmsCount'][0] ]) : PromiseInterface

Get unread SMS count

Parameters
$contentType : string = self::contentTypes['getUnreadSmsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getUnreadSmsCount'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getUnreadSmsCountAsyncWithHttpInfo()

Operation getUnreadSmsCountAsyncWithHttpInfo

public getUnreadSmsCountAsyncWithHttpInfo([string $contentType = self::contentTypes['getUnreadSmsCount'][0] ]) : PromiseInterface

Get unread SMS count

Parameters
$contentType : string = self::contentTypes['getUnreadSmsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getUnreadSmsCount'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getUnreadSmsCountRequest()

Create request for operation 'getUnreadSmsCount'

public getUnreadSmsCountRequest([string $contentType = self::contentTypes['getUnreadSmsCount'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getUnreadSmsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getUnreadSmsCount'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getUnreadSmsCountWithHttpInfo()

Operation getUnreadSmsCountWithHttpInfo

public getUnreadSmsCountWithHttpInfo([string $contentType = self::contentTypes['getUnreadSmsCount'][0] ]) : array<string|int, mixed>

Get unread SMS count

Parameters
$contentType : string = self::contentTypes['getUnreadSmsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getUnreadSmsCount'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\UnreadCount, HTTP status code, HTTP response headers (array of strings)

replyToSmsMessage()

Operation replyToSmsMessage

public replyToSmsMessage(string $sms_id, SmsReplyOptions $sms_reply_options[, string $contentType = self::contentTypes['replyToSmsMessage'][0] ]) : SentSmsDto

Send a reply to a received SMS message. Replies are sent from the receiving number.

Parameters
$sms_id : string

sms_id (required)

$sms_reply_options : SmsReplyOptions

sms_reply_options (required)

$contentType : string = self::contentTypes['replyToSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['replyToSmsMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
SentSmsDto

replyToSmsMessageAsync()

Operation replyToSmsMessageAsync

public replyToSmsMessageAsync(string $sms_id, SmsReplyOptions $sms_reply_options[, string $contentType = self::contentTypes['replyToSmsMessage'][0] ]) : PromiseInterface

Send a reply to a received SMS message. Replies are sent from the receiving number.

Parameters
$sms_id : string

(required)

$sms_reply_options : SmsReplyOptions

(required)

$contentType : string = self::contentTypes['replyToSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['replyToSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

replyToSmsMessageAsyncWithHttpInfo()

Operation replyToSmsMessageAsyncWithHttpInfo

public replyToSmsMessageAsyncWithHttpInfo(string $sms_id, SmsReplyOptions $sms_reply_options[, string $contentType = self::contentTypes['replyToSmsMessage'][0] ]) : PromiseInterface

Send a reply to a received SMS message. Replies are sent from the receiving number.

Parameters
$sms_id : string

(required)

$sms_reply_options : SmsReplyOptions

(required)

$contentType : string = self::contentTypes['replyToSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['replyToSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

replyToSmsMessageRequest()

Create request for operation 'replyToSmsMessage'

public replyToSmsMessageRequest(string $sms_id, SmsReplyOptions $sms_reply_options[, string $contentType = self::contentTypes['replyToSmsMessage'][0] ]) : Request
Parameters
$sms_id : string

(required)

$sms_reply_options : SmsReplyOptions

(required)

$contentType : string = self::contentTypes['replyToSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['replyToSmsMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

replyToSmsMessageWithHttpInfo()

Operation replyToSmsMessageWithHttpInfo

public replyToSmsMessageWithHttpInfo(string $sms_id, SmsReplyOptions $sms_reply_options[, string $contentType = self::contentTypes['replyToSmsMessage'][0] ]) : array<string|int, mixed>

Send a reply to a received SMS message. Replies are sent from the receiving number.

Parameters
$sms_id : string

(required)

$sms_reply_options : SmsReplyOptions

(required)

$contentType : string = self::contentTypes['replyToSmsMessage'][0]

The value for the Content-Type header. Check self::contentTypes['replyToSmsMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\SentSmsDto, HTTP status code, HTTP response headers (array of strings)

sendSms()

Operation sendSms

public sendSms(SmsSendOptions $sms_send_options[, string $from_phone_number = null ][, string $from_phone_id = null ][, string $contentType = self::contentTypes['sendSms'][0] ]) : SentSmsDto
Parameters
$sms_send_options : SmsSendOptions

sms_send_options (required)

$from_phone_number : string = null

Phone number to send from in E.164 format (optional)

$from_phone_id : string = null

Phone number ID to send from in UUID form (optional)

$contentType : string = self::contentTypes['sendSms'][0]

The value for the Content-Type header. Check self::contentTypes['sendSms'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
SentSmsDto

sendSmsAsync()

Operation sendSmsAsync

public sendSmsAsync(SmsSendOptions $sms_send_options[, string $from_phone_number = null ][, string $from_phone_id = null ][, string $contentType = self::contentTypes['sendSms'][0] ]) : PromiseInterface
Parameters
$sms_send_options : SmsSendOptions

(required)

$from_phone_number : string = null

Phone number to send from in E.164 format (optional)

$from_phone_id : string = null

Phone number ID to send from in UUID form (optional)

$contentType : string = self::contentTypes['sendSms'][0]

The value for the Content-Type header. Check self::contentTypes['sendSms'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

sendSmsAsyncWithHttpInfo()

Operation sendSmsAsyncWithHttpInfo

public sendSmsAsyncWithHttpInfo(SmsSendOptions $sms_send_options[, string $from_phone_number = null ][, string $from_phone_id = null ][, string $contentType = self::contentTypes['sendSms'][0] ]) : PromiseInterface
Parameters
$sms_send_options : SmsSendOptions

(required)

$from_phone_number : string = null

Phone number to send from in E.164 format (optional)

$from_phone_id : string = null

Phone number ID to send from in UUID form (optional)

$contentType : string = self::contentTypes['sendSms'][0]

The value for the Content-Type header. Check self::contentTypes['sendSms'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

sendSmsRequest()

Create request for operation 'sendSms'

public sendSmsRequest(SmsSendOptions $sms_send_options[, string $from_phone_number = null ][, string $from_phone_id = null ][, string $contentType = self::contentTypes['sendSms'][0] ]) : Request
Parameters
$sms_send_options : SmsSendOptions

(required)

$from_phone_number : string = null

Phone number to send from in E.164 format (optional)

$from_phone_id : string = null

Phone number ID to send from in UUID form (optional)

$contentType : string = self::contentTypes['sendSms'][0]

The value for the Content-Type header. Check self::contentTypes['sendSms'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

sendSmsWithHttpInfo()

Operation sendSmsWithHttpInfo

public sendSmsWithHttpInfo(SmsSendOptions $sms_send_options[, string $from_phone_number = null ][, string $from_phone_id = null ][, string $contentType = self::contentTypes['sendSms'][0] ]) : array<string|int, mixed>
Parameters
$sms_send_options : SmsSendOptions

(required)

$from_phone_number : string = null

Phone number to send from in E.164 format (optional)

$from_phone_id : string = null

Phone number ID to send from in UUID form (optional)

$contentType : string = self::contentTypes['sendSms'][0]

The value for the Content-Type header. Check self::contentTypes['sendSms'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\SentSmsDto, HTTP status code, HTTP response headers (array of strings)

setHostIndex()

Set the host index

public setHostIndex(int $hostIndex) : void
Parameters
$hostIndex : int

Host index (required)

Return values
void

setSmsFavourited()

Operation setSmsFavourited

public setSmsFavourited(string $sms_id, bool $favourited[, string $contentType = self::contentTypes['setSmsFavourited'][0] ]) : SmsDto
Parameters
$sms_id : string

ID of SMS to set favourite state (required)

$favourited : bool

favourited (required)

$contentType : string = self::contentTypes['setSmsFavourited'][0]

The value for the Content-Type header. Check self::contentTypes['setSmsFavourited'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
SmsDto

setSmsFavouritedAsync()

Operation setSmsFavouritedAsync

public setSmsFavouritedAsync(string $sms_id, bool $favourited[, string $contentType = self::contentTypes['setSmsFavourited'][0] ]) : PromiseInterface
Parameters
$sms_id : string

ID of SMS to set favourite state (required)

$favourited : bool

(required)

$contentType : string = self::contentTypes['setSmsFavourited'][0]

The value for the Content-Type header. Check self::contentTypes['setSmsFavourited'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

setSmsFavouritedAsyncWithHttpInfo()

Operation setSmsFavouritedAsyncWithHttpInfo

public setSmsFavouritedAsyncWithHttpInfo(string $sms_id, bool $favourited[, string $contentType = self::contentTypes['setSmsFavourited'][0] ]) : PromiseInterface
Parameters
$sms_id : string

ID of SMS to set favourite state (required)

$favourited : bool

(required)

$contentType : string = self::contentTypes['setSmsFavourited'][0]

The value for the Content-Type header. Check self::contentTypes['setSmsFavourited'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

setSmsFavouritedRequest()

Create request for operation 'setSmsFavourited'

public setSmsFavouritedRequest(string $sms_id, bool $favourited[, string $contentType = self::contentTypes['setSmsFavourited'][0] ]) : Request
Parameters
$sms_id : string

ID of SMS to set favourite state (required)

$favourited : bool

(required)

$contentType : string = self::contentTypes['setSmsFavourited'][0]

The value for the Content-Type header. Check self::contentTypes['setSmsFavourited'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

setSmsFavouritedWithHttpInfo()

Operation setSmsFavouritedWithHttpInfo

public setSmsFavouritedWithHttpInfo(string $sms_id, bool $favourited[, string $contentType = self::contentTypes['setSmsFavourited'][0] ]) : array<string|int, mixed>
Parameters
$sms_id : string

ID of SMS to set favourite state (required)

$favourited : bool

(required)

$contentType : string = self::contentTypes['setSmsFavourited'][0]

The value for the Content-Type header. Check self::contentTypes['setSmsFavourited'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\SmsDto, HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed>

of http client options

Search results