MissedSmsControllerApi
in package
MissedSmsControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['getAllMissedSmsMessages' => ['application/json'], 'getMissedSmsCount' => ['application/json'], 'getMissedSmsMessage' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- getAllMissedSmsMessages() : PageMissedSmsProjection
- Operation getAllMissedSmsMessages
- getAllMissedSmsMessagesAsync() : PromiseInterface
- Operation getAllMissedSmsMessagesAsync
- getAllMissedSmsMessagesAsyncWithHttpInfo() : PromiseInterface
- Operation getAllMissedSmsMessagesAsyncWithHttpInfo
- getAllMissedSmsMessagesRequest() : Request
- Create request for operation 'getAllMissedSmsMessages'
- getAllMissedSmsMessagesWithHttpInfo() : array<string|int, mixed>
- Operation getAllMissedSmsMessagesWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getMissedSmsCount() : CountDto
- Operation getMissedSmsCount
- getMissedSmsCountAsync() : PromiseInterface
- Operation getMissedSmsCountAsync
- getMissedSmsCountAsyncWithHttpInfo() : PromiseInterface
- Operation getMissedSmsCountAsyncWithHttpInfo
- getMissedSmsCountRequest() : Request
- Create request for operation 'getMissedSmsCount'
- getMissedSmsCountWithHttpInfo() : array<string|int, mixed>
- Operation getMissedSmsCountWithHttpInfo
- getMissedSmsMessage() : MissedSmsDto
- Operation getMissedSmsMessage
- getMissedSmsMessageAsync() : PromiseInterface
- Operation getMissedSmsMessageAsync
- getMissedSmsMessageAsyncWithHttpInfo() : PromiseInterface
- Operation getMissedSmsMessageAsyncWithHttpInfo
- getMissedSmsMessageRequest() : Request
- Create request for operation 'getMissedSmsMessage'
- getMissedSmsMessageWithHttpInfo() : array<string|int, mixed>
- Operation getMissedSmsMessageWithHttpInfo
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['getAllMissedSmsMessages' => ['application/json'], 'getMissedSmsCount' => ['application/json'], 'getMissedSmsMessage' => ['application/json']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$hostIndex
protected
int
$hostIndex
Host index
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 —getAllMissedSmsMessages()
Operation getAllMissedSmsMessages
public
getAllMissedSmsMessages([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['getAllMissedSmsMessages'][0] ]) : PageMissedSmsProjection
Get all missed SMS messages in paginated format
Parameters
- $phone_number : string = null
-
Optional receiving phone number to filter missed SMS for (optional)
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter missed SMS after given date time (optional)
- $before : DateTime = null
-
Optional filter missed SMS before given date time (optional)
- $search : string = null
-
Optional search filter (optional)
- $contentType : string = self::contentTypes['getAllMissedSmsMessages'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllMissedSmsMessages'] to see the possible values for this operation
Tags
Return values
PageMissedSmsProjection —getAllMissedSmsMessagesAsync()
Operation getAllMissedSmsMessagesAsync
public
getAllMissedSmsMessagesAsync([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['getAllMissedSmsMessages'][0] ]) : PromiseInterface
Get all missed SMS messages in paginated format
Parameters
- $phone_number : string = null
-
Optional receiving phone number to filter missed SMS for (optional)
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter missed SMS after given date time (optional)
- $before : DateTime = null
-
Optional filter missed SMS before given date time (optional)
- $search : string = null
-
Optional search filter (optional)
- $contentType : string = self::contentTypes['getAllMissedSmsMessages'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllMissedSmsMessages'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllMissedSmsMessagesAsyncWithHttpInfo()
Operation getAllMissedSmsMessagesAsyncWithHttpInfo
public
getAllMissedSmsMessagesAsyncWithHttpInfo([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['getAllMissedSmsMessages'][0] ]) : PromiseInterface
Get all missed SMS messages in paginated format
Parameters
- $phone_number : string = null
-
Optional receiving phone number to filter missed SMS for (optional)
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter missed SMS after given date time (optional)
- $before : DateTime = null
-
Optional filter missed SMS before given date time (optional)
- $search : string = null
-
Optional search filter (optional)
- $contentType : string = self::contentTypes['getAllMissedSmsMessages'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllMissedSmsMessages'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllMissedSmsMessagesRequest()
Create request for operation 'getAllMissedSmsMessages'
public
getAllMissedSmsMessagesRequest([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['getAllMissedSmsMessages'][0] ]) : Request
Parameters
- $phone_number : string = null
-
Optional receiving phone number to filter missed SMS for (optional)
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter missed SMS after given date time (optional)
- $before : DateTime = null
-
Optional filter missed SMS before given date time (optional)
- $search : string = null
-
Optional search filter (optional)
- $contentType : string = self::contentTypes['getAllMissedSmsMessages'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllMissedSmsMessages'] to see the possible values for this operation
Tags
Return values
Request —getAllMissedSmsMessagesWithHttpInfo()
Operation getAllMissedSmsMessagesWithHttpInfo
public
getAllMissedSmsMessagesWithHttpInfo([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['getAllMissedSmsMessages'][0] ]) : array<string|int, mixed>
Get all missed SMS messages in paginated format
Parameters
- $phone_number : string = null
-
Optional receiving phone number to filter missed SMS for (optional)
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter missed SMS after given date time (optional)
- $before : DateTime = null
-
Optional filter missed SMS before given date time (optional)
- $search : string = null
-
Optional search filter (optional)
- $contentType : string = self::contentTypes['getAllMissedSmsMessages'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllMissedSmsMessages'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageMissedSmsProjection, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getMissedSmsCount()
Operation getMissedSmsCount
public
getMissedSmsCount([string $contentType = self::contentTypes['getMissedSmsCount'][0] ]) : CountDto
Get missed SMS count
Parameters
- $contentType : string = self::contentTypes['getMissedSmsCount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMissedSmsCount'] to see the possible values for this operation
Tags
Return values
CountDto —getMissedSmsCountAsync()
Operation getMissedSmsCountAsync
public
getMissedSmsCountAsync([string $contentType = self::contentTypes['getMissedSmsCount'][0] ]) : PromiseInterface
Get missed SMS count
Parameters
- $contentType : string = self::contentTypes['getMissedSmsCount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMissedSmsCount'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getMissedSmsCountAsyncWithHttpInfo()
Operation getMissedSmsCountAsyncWithHttpInfo
public
getMissedSmsCountAsyncWithHttpInfo([string $contentType = self::contentTypes['getMissedSmsCount'][0] ]) : PromiseInterface
Get missed SMS count
Parameters
- $contentType : string = self::contentTypes['getMissedSmsCount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMissedSmsCount'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getMissedSmsCountRequest()
Create request for operation 'getMissedSmsCount'
public
getMissedSmsCountRequest([string $contentType = self::contentTypes['getMissedSmsCount'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getMissedSmsCount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMissedSmsCount'] to see the possible values for this operation
Tags
Return values
Request —getMissedSmsCountWithHttpInfo()
Operation getMissedSmsCountWithHttpInfo
public
getMissedSmsCountWithHttpInfo([string $contentType = self::contentTypes['getMissedSmsCount'][0] ]) : array<string|int, mixed>
Get missed SMS count
Parameters
- $contentType : string = self::contentTypes['getMissedSmsCount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMissedSmsCount'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\CountDto, HTTP status code, HTTP response headers (array of strings)
getMissedSmsMessage()
Operation getMissedSmsMessage
public
getMissedSmsMessage(string $missed_sms_id[, string $contentType = self::contentTypes['getMissedSmsMessage'][0] ]) : MissedSmsDto
Get missed SMS content
Parameters
- $missed_sms_id : string
-
missed_sms_id (required)
- $contentType : string = self::contentTypes['getMissedSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMissedSmsMessage'] to see the possible values for this operation
Tags
Return values
MissedSmsDto —getMissedSmsMessageAsync()
Operation getMissedSmsMessageAsync
public
getMissedSmsMessageAsync(string $missed_sms_id[, string $contentType = self::contentTypes['getMissedSmsMessage'][0] ]) : PromiseInterface
Get missed SMS content
Parameters
- $missed_sms_id : string
-
(required)
- $contentType : string = self::contentTypes['getMissedSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMissedSmsMessage'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getMissedSmsMessageAsyncWithHttpInfo()
Operation getMissedSmsMessageAsyncWithHttpInfo
public
getMissedSmsMessageAsyncWithHttpInfo(string $missed_sms_id[, string $contentType = self::contentTypes['getMissedSmsMessage'][0] ]) : PromiseInterface
Get missed SMS content
Parameters
- $missed_sms_id : string
-
(required)
- $contentType : string = self::contentTypes['getMissedSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMissedSmsMessage'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getMissedSmsMessageRequest()
Create request for operation 'getMissedSmsMessage'
public
getMissedSmsMessageRequest(string $missed_sms_id[, string $contentType = self::contentTypes['getMissedSmsMessage'][0] ]) : Request
Parameters
- $missed_sms_id : string
-
(required)
- $contentType : string = self::contentTypes['getMissedSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMissedSmsMessage'] to see the possible values for this operation
Tags
Return values
Request —getMissedSmsMessageWithHttpInfo()
Operation getMissedSmsMessageWithHttpInfo
public
getMissedSmsMessageWithHttpInfo(string $missed_sms_id[, string $contentType = self::contentTypes['getMissedSmsMessage'][0] ]) : array<string|int, mixed>
Get missed SMS content
Parameters
- $missed_sms_id : string
-
(required)
- $contentType : string = self::contentTypes['getMissedSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMissedSmsMessage'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\MissedSmsDto, 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 —createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options