PhoneControllerApi
in package
PhoneControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['createEmergencyAddress' => ['application/json'], 'deleteEmergencyAddress' => ['application/json'], 'deletePhoneNumber' => ['application/json'], 'getEmergencyAddress' => ['application/json'], 'getEmergencyAddresses' => ['application/json'], 'getPhoneNumber' => ['application/json'], 'getPhoneNumbers' => ['application/json'], 'getPhonePlans' => ['application/json'], 'testPhoneNumberSendSms' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- createEmergencyAddress() : EmergencyAddress
- Operation createEmergencyAddress
- createEmergencyAddressAsync() : PromiseInterface
- Operation createEmergencyAddressAsync
- createEmergencyAddressAsyncWithHttpInfo() : PromiseInterface
- Operation createEmergencyAddressAsyncWithHttpInfo
- createEmergencyAddressRequest() : Request
- Create request for operation 'createEmergencyAddress'
- createEmergencyAddressWithHttpInfo() : array<string|int, mixed>
- Operation createEmergencyAddressWithHttpInfo
- deleteEmergencyAddress() : EmptyResponseDto
- Operation deleteEmergencyAddress
- deleteEmergencyAddressAsync() : PromiseInterface
- Operation deleteEmergencyAddressAsync
- deleteEmergencyAddressAsyncWithHttpInfo() : PromiseInterface
- Operation deleteEmergencyAddressAsyncWithHttpInfo
- deleteEmergencyAddressRequest() : Request
- Create request for operation 'deleteEmergencyAddress'
- deleteEmergencyAddressWithHttpInfo() : array<string|int, mixed>
- Operation deleteEmergencyAddressWithHttpInfo
- deletePhoneNumber() : void
- Operation deletePhoneNumber
- deletePhoneNumberAsync() : PromiseInterface
- Operation deletePhoneNumberAsync
- deletePhoneNumberAsyncWithHttpInfo() : PromiseInterface
- Operation deletePhoneNumberAsyncWithHttpInfo
- deletePhoneNumberRequest() : Request
- Create request for operation 'deletePhoneNumber'
- deletePhoneNumberWithHttpInfo() : array<string|int, mixed>
- Operation deletePhoneNumberWithHttpInfo
- getConfig() : Configuration
- getEmergencyAddress() : EmergencyAddress
- Operation getEmergencyAddress
- getEmergencyAddressAsync() : PromiseInterface
- Operation getEmergencyAddressAsync
- getEmergencyAddressAsyncWithHttpInfo() : PromiseInterface
- Operation getEmergencyAddressAsyncWithHttpInfo
- getEmergencyAddresses() : array<string|int, EmergencyAddressDto>
- Operation getEmergencyAddresses
- getEmergencyAddressesAsync() : PromiseInterface
- Operation getEmergencyAddressesAsync
- getEmergencyAddressesAsyncWithHttpInfo() : PromiseInterface
- Operation getEmergencyAddressesAsyncWithHttpInfo
- getEmergencyAddressesRequest() : Request
- Create request for operation 'getEmergencyAddresses'
- getEmergencyAddressesWithHttpInfo() : array<string|int, mixed>
- Operation getEmergencyAddressesWithHttpInfo
- getEmergencyAddressRequest() : Request
- Create request for operation 'getEmergencyAddress'
- getEmergencyAddressWithHttpInfo() : array<string|int, mixed>
- Operation getEmergencyAddressWithHttpInfo
- getHostIndex() : int
- Get the host index
- getPhoneNumber() : PhoneNumberDto
- Operation getPhoneNumber
- getPhoneNumberAsync() : PromiseInterface
- Operation getPhoneNumberAsync
- getPhoneNumberAsyncWithHttpInfo() : PromiseInterface
- Operation getPhoneNumberAsyncWithHttpInfo
- getPhoneNumberRequest() : Request
- Create request for operation 'getPhoneNumber'
- getPhoneNumbers() : PagePhoneNumberProjection
- Operation getPhoneNumbers
- getPhoneNumbersAsync() : PromiseInterface
- Operation getPhoneNumbersAsync
- getPhoneNumbersAsyncWithHttpInfo() : PromiseInterface
- Operation getPhoneNumbersAsyncWithHttpInfo
- getPhoneNumbersRequest() : Request
- Create request for operation 'getPhoneNumbers'
- getPhoneNumbersWithHttpInfo() : array<string|int, mixed>
- Operation getPhoneNumbersWithHttpInfo
- getPhoneNumberWithHttpInfo() : array<string|int, mixed>
- Operation getPhoneNumberWithHttpInfo
- getPhonePlans() : array<string|int, PhonePlanDto>
- Operation getPhonePlans
- getPhonePlansAsync() : PromiseInterface
- Operation getPhonePlansAsync
- getPhonePlansAsyncWithHttpInfo() : PromiseInterface
- Operation getPhonePlansAsyncWithHttpInfo
- getPhonePlansRequest() : Request
- Create request for operation 'getPhonePlans'
- getPhonePlansWithHttpInfo() : array<string|int, mixed>
- Operation getPhonePlansWithHttpInfo
- setHostIndex() : void
- Set the host index
- testPhoneNumberSendSms() : void
- Operation testPhoneNumberSendSms
- testPhoneNumberSendSmsAsync() : PromiseInterface
- Operation testPhoneNumberSendSmsAsync
- testPhoneNumberSendSmsAsyncWithHttpInfo() : PromiseInterface
- Operation testPhoneNumberSendSmsAsyncWithHttpInfo
- testPhoneNumberSendSmsRequest() : Request
- Create request for operation 'testPhoneNumberSendSms'
- testPhoneNumberSendSmsWithHttpInfo() : array<string|int, mixed>
- Operation testPhoneNumberSendSmsWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['createEmergencyAddress' => ['application/json'], 'deleteEmergencyAddress' => ['application/json'], 'deletePhoneNumber' => ['application/json'], 'getEmergencyAddress' => ['application/json'], 'getEmergencyAddresses' => ['application/json'], 'getPhoneNumber' => ['application/json'], 'getPhoneNumbers' => ['application/json'], 'getPhonePlans' => ['application/json'], 'testPhoneNumberSendSms' => ['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 —createEmergencyAddress()
Operation createEmergencyAddress
public
createEmergencyAddress(CreateEmergencyAddressOptions $create_emergency_address_options[, string $contentType = self::contentTypes['createEmergencyAddress'][0] ]) : EmergencyAddress
Parameters
- $create_emergency_address_options : CreateEmergencyAddressOptions
-
create_emergency_address_options (required)
- $contentType : string = self::contentTypes['createEmergencyAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['createEmergencyAddress'] to see the possible values for this operation
Tags
Return values
EmergencyAddress —createEmergencyAddressAsync()
Operation createEmergencyAddressAsync
public
createEmergencyAddressAsync(CreateEmergencyAddressOptions $create_emergency_address_options[, string $contentType = self::contentTypes['createEmergencyAddress'][0] ]) : PromiseInterface
Parameters
- $create_emergency_address_options : CreateEmergencyAddressOptions
-
(required)
- $contentType : string = self::contentTypes['createEmergencyAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['createEmergencyAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createEmergencyAddressAsyncWithHttpInfo()
Operation createEmergencyAddressAsyncWithHttpInfo
public
createEmergencyAddressAsyncWithHttpInfo(CreateEmergencyAddressOptions $create_emergency_address_options[, string $contentType = self::contentTypes['createEmergencyAddress'][0] ]) : PromiseInterface
Parameters
- $create_emergency_address_options : CreateEmergencyAddressOptions
-
(required)
- $contentType : string = self::contentTypes['createEmergencyAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['createEmergencyAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createEmergencyAddressRequest()
Create request for operation 'createEmergencyAddress'
public
createEmergencyAddressRequest(CreateEmergencyAddressOptions $create_emergency_address_options[, string $contentType = self::contentTypes['createEmergencyAddress'][0] ]) : Request
Parameters
- $create_emergency_address_options : CreateEmergencyAddressOptions
-
(required)
- $contentType : string = self::contentTypes['createEmergencyAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['createEmergencyAddress'] to see the possible values for this operation
Tags
Return values
Request —createEmergencyAddressWithHttpInfo()
Operation createEmergencyAddressWithHttpInfo
public
createEmergencyAddressWithHttpInfo(CreateEmergencyAddressOptions $create_emergency_address_options[, string $contentType = self::contentTypes['createEmergencyAddress'][0] ]) : array<string|int, mixed>
Parameters
- $create_emergency_address_options : CreateEmergencyAddressOptions
-
(required)
- $contentType : string = self::contentTypes['createEmergencyAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['createEmergencyAddress'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\EmergencyAddress, HTTP status code, HTTP response headers (array of strings)
deleteEmergencyAddress()
Operation deleteEmergencyAddress
public
deleteEmergencyAddress(string $address_id[, string $contentType = self::contentTypes['deleteEmergencyAddress'][0] ]) : EmptyResponseDto
Parameters
- $address_id : string
-
address_id (required)
- $contentType : string = self::contentTypes['deleteEmergencyAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteEmergencyAddress'] to see the possible values for this operation
Tags
Return values
EmptyResponseDto —deleteEmergencyAddressAsync()
Operation deleteEmergencyAddressAsync
public
deleteEmergencyAddressAsync(string $address_id[, string $contentType = self::contentTypes['deleteEmergencyAddress'][0] ]) : PromiseInterface
Parameters
- $address_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteEmergencyAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteEmergencyAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteEmergencyAddressAsyncWithHttpInfo()
Operation deleteEmergencyAddressAsyncWithHttpInfo
public
deleteEmergencyAddressAsyncWithHttpInfo(string $address_id[, string $contentType = self::contentTypes['deleteEmergencyAddress'][0] ]) : PromiseInterface
Parameters
- $address_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteEmergencyAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteEmergencyAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteEmergencyAddressRequest()
Create request for operation 'deleteEmergencyAddress'
public
deleteEmergencyAddressRequest(string $address_id[, string $contentType = self::contentTypes['deleteEmergencyAddress'][0] ]) : Request
Parameters
- $address_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteEmergencyAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteEmergencyAddress'] to see the possible values for this operation
Tags
Return values
Request —deleteEmergencyAddressWithHttpInfo()
Operation deleteEmergencyAddressWithHttpInfo
public
deleteEmergencyAddressWithHttpInfo(string $address_id[, string $contentType = self::contentTypes['deleteEmergencyAddress'][0] ]) : array<string|int, mixed>
Parameters
- $address_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteEmergencyAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteEmergencyAddress'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\EmptyResponseDto, HTTP status code, HTTP response headers (array of strings)
deletePhoneNumber()
Operation deletePhoneNumber
public
deletePhoneNumber(string $phone_number_id[, string $contentType = self::contentTypes['deletePhoneNumber'][0] ]) : void
Parameters
- $phone_number_id : string
-
phone_number_id (required)
- $contentType : string = self::contentTypes['deletePhoneNumber'][0]
-
The value for the Content-Type header. Check self::contentTypes['deletePhoneNumber'] to see the possible values for this operation
Tags
Return values
void —deletePhoneNumberAsync()
Operation deletePhoneNumberAsync
public
deletePhoneNumberAsync(string $phone_number_id[, string $contentType = self::contentTypes['deletePhoneNumber'][0] ]) : PromiseInterface
Parameters
- $phone_number_id : string
-
(required)
- $contentType : string = self::contentTypes['deletePhoneNumber'][0]
-
The value for the Content-Type header. Check self::contentTypes['deletePhoneNumber'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deletePhoneNumberAsyncWithHttpInfo()
Operation deletePhoneNumberAsyncWithHttpInfo
public
deletePhoneNumberAsyncWithHttpInfo(string $phone_number_id[, string $contentType = self::contentTypes['deletePhoneNumber'][0] ]) : PromiseInterface
Parameters
- $phone_number_id : string
-
(required)
- $contentType : string = self::contentTypes['deletePhoneNumber'][0]
-
The value for the Content-Type header. Check self::contentTypes['deletePhoneNumber'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deletePhoneNumberRequest()
Create request for operation 'deletePhoneNumber'
public
deletePhoneNumberRequest(string $phone_number_id[, string $contentType = self::contentTypes['deletePhoneNumber'][0] ]) : Request
Parameters
- $phone_number_id : string
-
(required)
- $contentType : string = self::contentTypes['deletePhoneNumber'][0]
-
The value for the Content-Type header. Check self::contentTypes['deletePhoneNumber'] to see the possible values for this operation
Tags
Return values
Request —deletePhoneNumberWithHttpInfo()
Operation deletePhoneNumberWithHttpInfo
public
deletePhoneNumberWithHttpInfo(string $phone_number_id[, string $contentType = self::contentTypes['deletePhoneNumber'][0] ]) : array<string|int, mixed>
Parameters
- $phone_number_id : string
-
(required)
- $contentType : string = self::contentTypes['deletePhoneNumber'][0]
-
The value for the Content-Type header. Check self::contentTypes['deletePhoneNumber'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getEmergencyAddress()
Operation getEmergencyAddress
public
getEmergencyAddress(string $address_id[, string $contentType = self::contentTypes['getEmergencyAddress'][0] ]) : EmergencyAddress
Parameters
- $address_id : string
-
address_id (required)
- $contentType : string = self::contentTypes['getEmergencyAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmergencyAddress'] to see the possible values for this operation
Tags
Return values
EmergencyAddress —getEmergencyAddressAsync()
Operation getEmergencyAddressAsync
public
getEmergencyAddressAsync(string $address_id[, string $contentType = self::contentTypes['getEmergencyAddress'][0] ]) : PromiseInterface
Parameters
- $address_id : string
-
(required)
- $contentType : string = self::contentTypes['getEmergencyAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmergencyAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEmergencyAddressAsyncWithHttpInfo()
Operation getEmergencyAddressAsyncWithHttpInfo
public
getEmergencyAddressAsyncWithHttpInfo(string $address_id[, string $contentType = self::contentTypes['getEmergencyAddress'][0] ]) : PromiseInterface
Parameters
- $address_id : string
-
(required)
- $contentType : string = self::contentTypes['getEmergencyAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmergencyAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEmergencyAddresses()
Operation getEmergencyAddresses
public
getEmergencyAddresses([string $contentType = self::contentTypes['getEmergencyAddresses'][0] ]) : array<string|int, EmergencyAddressDto>
Parameters
- $contentType : string = self::contentTypes['getEmergencyAddresses'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmergencyAddresses'] to see the possible values for this operation
Tags
Return values
array<string|int, EmergencyAddressDto> —getEmergencyAddressesAsync()
Operation getEmergencyAddressesAsync
public
getEmergencyAddressesAsync([string $contentType = self::contentTypes['getEmergencyAddresses'][0] ]) : PromiseInterface
Parameters
- $contentType : string = self::contentTypes['getEmergencyAddresses'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmergencyAddresses'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEmergencyAddressesAsyncWithHttpInfo()
Operation getEmergencyAddressesAsyncWithHttpInfo
public
getEmergencyAddressesAsyncWithHttpInfo([string $contentType = self::contentTypes['getEmergencyAddresses'][0] ]) : PromiseInterface
Parameters
- $contentType : string = self::contentTypes['getEmergencyAddresses'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmergencyAddresses'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEmergencyAddressesRequest()
Create request for operation 'getEmergencyAddresses'
public
getEmergencyAddressesRequest([string $contentType = self::contentTypes['getEmergencyAddresses'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getEmergencyAddresses'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmergencyAddresses'] to see the possible values for this operation
Tags
Return values
Request —getEmergencyAddressesWithHttpInfo()
Operation getEmergencyAddressesWithHttpInfo
public
getEmergencyAddressesWithHttpInfo([string $contentType = self::contentTypes['getEmergencyAddresses'][0] ]) : array<string|int, mixed>
Parameters
- $contentType : string = self::contentTypes['getEmergencyAddresses'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmergencyAddresses'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\EmergencyAddressDto[], HTTP status code, HTTP response headers (array of strings)
getEmergencyAddressRequest()
Create request for operation 'getEmergencyAddress'
public
getEmergencyAddressRequest(string $address_id[, string $contentType = self::contentTypes['getEmergencyAddress'][0] ]) : Request
Parameters
- $address_id : string
-
(required)
- $contentType : string = self::contentTypes['getEmergencyAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmergencyAddress'] to see the possible values for this operation
Tags
Return values
Request —getEmergencyAddressWithHttpInfo()
Operation getEmergencyAddressWithHttpInfo
public
getEmergencyAddressWithHttpInfo(string $address_id[, string $contentType = self::contentTypes['getEmergencyAddress'][0] ]) : array<string|int, mixed>
Parameters
- $address_id : string
-
(required)
- $contentType : string = self::contentTypes['getEmergencyAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmergencyAddress'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\EmergencyAddress, HTTP status code, HTTP response headers (array of strings)
getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getPhoneNumber()
Operation getPhoneNumber
public
getPhoneNumber(string $phone_number_id[, string $contentType = self::contentTypes['getPhoneNumber'][0] ]) : PhoneNumberDto
Parameters
- $phone_number_id : string
-
phone_number_id (required)
- $contentType : string = self::contentTypes['getPhoneNumber'][0]
-
The value for the Content-Type header. Check self::contentTypes['getPhoneNumber'] to see the possible values for this operation
Tags
Return values
PhoneNumberDto —getPhoneNumberAsync()
Operation getPhoneNumberAsync
public
getPhoneNumberAsync(string $phone_number_id[, string $contentType = self::contentTypes['getPhoneNumber'][0] ]) : PromiseInterface
Parameters
- $phone_number_id : string
-
(required)
- $contentType : string = self::contentTypes['getPhoneNumber'][0]
-
The value for the Content-Type header. Check self::contentTypes['getPhoneNumber'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getPhoneNumberAsyncWithHttpInfo()
Operation getPhoneNumberAsyncWithHttpInfo
public
getPhoneNumberAsyncWithHttpInfo(string $phone_number_id[, string $contentType = self::contentTypes['getPhoneNumber'][0] ]) : PromiseInterface
Parameters
- $phone_number_id : string
-
(required)
- $contentType : string = self::contentTypes['getPhoneNumber'][0]
-
The value for the Content-Type header. Check self::contentTypes['getPhoneNumber'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getPhoneNumberRequest()
Create request for operation 'getPhoneNumber'
public
getPhoneNumberRequest(string $phone_number_id[, string $contentType = self::contentTypes['getPhoneNumber'][0] ]) : Request
Parameters
- $phone_number_id : string
-
(required)
- $contentType : string = self::contentTypes['getPhoneNumber'][0]
-
The value for the Content-Type header. Check self::contentTypes['getPhoneNumber'] to see the possible values for this operation
Tags
Return values
Request —getPhoneNumbers()
Operation getPhoneNumbers
public
getPhoneNumbers([string $phone_country = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getPhoneNumbers'][0] ]) : PagePhoneNumberProjection
Parameters
- $phone_country : string = null
-
Optional phone country (optional)
- $page : int
-
Optional page index for list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size for list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getPhoneNumbers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getPhoneNumbers'] to see the possible values for this operation
Tags
Return values
PagePhoneNumberProjection —getPhoneNumbersAsync()
Operation getPhoneNumbersAsync
public
getPhoneNumbersAsync([string $phone_country = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getPhoneNumbers'][0] ]) : PromiseInterface
Parameters
- $phone_country : string = null
-
Optional phone country (optional)
- $page : int
-
Optional page index for list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size for list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getPhoneNumbers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getPhoneNumbers'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getPhoneNumbersAsyncWithHttpInfo()
Operation getPhoneNumbersAsyncWithHttpInfo
public
getPhoneNumbersAsyncWithHttpInfo([string $phone_country = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getPhoneNumbers'][0] ]) : PromiseInterface
Parameters
- $phone_country : string = null
-
Optional phone country (optional)
- $page : int
-
Optional page index for list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size for list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getPhoneNumbers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getPhoneNumbers'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getPhoneNumbersRequest()
Create request for operation 'getPhoneNumbers'
public
getPhoneNumbersRequest([string $phone_country = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getPhoneNumbers'][0] ]) : Request
Parameters
- $phone_country : string = null
-
Optional phone country (optional)
- $page : int
-
Optional page index for list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size for list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getPhoneNumbers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getPhoneNumbers'] to see the possible values for this operation
Tags
Return values
Request —getPhoneNumbersWithHttpInfo()
Operation getPhoneNumbersWithHttpInfo
public
getPhoneNumbersWithHttpInfo([string $phone_country = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getPhoneNumbers'][0] ]) : array<string|int, mixed>
Parameters
- $phone_country : string = null
-
Optional phone country (optional)
- $page : int
-
Optional page index for list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size for list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getPhoneNumbers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getPhoneNumbers'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PagePhoneNumberProjection, HTTP status code, HTTP response headers (array of strings)
getPhoneNumberWithHttpInfo()
Operation getPhoneNumberWithHttpInfo
public
getPhoneNumberWithHttpInfo(string $phone_number_id[, string $contentType = self::contentTypes['getPhoneNumber'][0] ]) : array<string|int, mixed>
Parameters
- $phone_number_id : string
-
(required)
- $contentType : string = self::contentTypes['getPhoneNumber'][0]
-
The value for the Content-Type header. Check self::contentTypes['getPhoneNumber'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PhoneNumberDto, HTTP status code, HTTP response headers (array of strings)
getPhonePlans()
Operation getPhonePlans
public
getPhonePlans([string $contentType = self::contentTypes['getPhonePlans'][0] ]) : array<string|int, PhonePlanDto>
Parameters
- $contentType : string = self::contentTypes['getPhonePlans'][0]
-
The value for the Content-Type header. Check self::contentTypes['getPhonePlans'] to see the possible values for this operation
Tags
Return values
array<string|int, PhonePlanDto> —getPhonePlansAsync()
Operation getPhonePlansAsync
public
getPhonePlansAsync([string $contentType = self::contentTypes['getPhonePlans'][0] ]) : PromiseInterface
Parameters
- $contentType : string = self::contentTypes['getPhonePlans'][0]
-
The value for the Content-Type header. Check self::contentTypes['getPhonePlans'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getPhonePlansAsyncWithHttpInfo()
Operation getPhonePlansAsyncWithHttpInfo
public
getPhonePlansAsyncWithHttpInfo([string $contentType = self::contentTypes['getPhonePlans'][0] ]) : PromiseInterface
Parameters
- $contentType : string = self::contentTypes['getPhonePlans'][0]
-
The value for the Content-Type header. Check self::contentTypes['getPhonePlans'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getPhonePlansRequest()
Create request for operation 'getPhonePlans'
public
getPhonePlansRequest([string $contentType = self::contentTypes['getPhonePlans'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getPhonePlans'][0]
-
The value for the Content-Type header. Check self::contentTypes['getPhonePlans'] to see the possible values for this operation
Tags
Return values
Request —getPhonePlansWithHttpInfo()
Operation getPhonePlansWithHttpInfo
public
getPhonePlansWithHttpInfo([string $contentType = self::contentTypes['getPhonePlans'][0] ]) : array<string|int, mixed>
Parameters
- $contentType : string = self::contentTypes['getPhonePlans'][0]
-
The value for the Content-Type header. Check self::contentTypes['getPhonePlans'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PhonePlanDto[], 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 —testPhoneNumberSendSms()
Operation testPhoneNumberSendSms
public
testPhoneNumberSendSms(string $phone_number_id, TestPhoneNumberOptions $test_phone_number_options[, string $x_test_id = null ][, string $contentType = self::contentTypes['testPhoneNumberSendSms'][0] ]) : void
Parameters
- $phone_number_id : string
-
phone_number_id (required)
- $test_phone_number_options : TestPhoneNumberOptions
-
test_phone_number_options (required)
- $x_test_id : string = null
-
x_test_id (optional)
- $contentType : string = self::contentTypes['testPhoneNumberSendSms'][0]
-
The value for the Content-Type header. Check self::contentTypes['testPhoneNumberSendSms'] to see the possible values for this operation
Tags
Return values
void —testPhoneNumberSendSmsAsync()
Operation testPhoneNumberSendSmsAsync
public
testPhoneNumberSendSmsAsync(string $phone_number_id, TestPhoneNumberOptions $test_phone_number_options[, string $x_test_id = null ][, string $contentType = self::contentTypes['testPhoneNumberSendSms'][0] ]) : PromiseInterface
Parameters
- $phone_number_id : string
-
(required)
- $test_phone_number_options : TestPhoneNumberOptions
-
(required)
- $x_test_id : string = null
-
(optional)
- $contentType : string = self::contentTypes['testPhoneNumberSendSms'][0]
-
The value for the Content-Type header. Check self::contentTypes['testPhoneNumberSendSms'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testPhoneNumberSendSmsAsyncWithHttpInfo()
Operation testPhoneNumberSendSmsAsyncWithHttpInfo
public
testPhoneNumberSendSmsAsyncWithHttpInfo(string $phone_number_id, TestPhoneNumberOptions $test_phone_number_options[, string $x_test_id = null ][, string $contentType = self::contentTypes['testPhoneNumberSendSms'][0] ]) : PromiseInterface
Parameters
- $phone_number_id : string
-
(required)
- $test_phone_number_options : TestPhoneNumberOptions
-
(required)
- $x_test_id : string = null
-
(optional)
- $contentType : string = self::contentTypes['testPhoneNumberSendSms'][0]
-
The value for the Content-Type header. Check self::contentTypes['testPhoneNumberSendSms'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testPhoneNumberSendSmsRequest()
Create request for operation 'testPhoneNumberSendSms'
public
testPhoneNumberSendSmsRequest(string $phone_number_id, TestPhoneNumberOptions $test_phone_number_options[, string $x_test_id = null ][, string $contentType = self::contentTypes['testPhoneNumberSendSms'][0] ]) : Request
Parameters
- $phone_number_id : string
-
(required)
- $test_phone_number_options : TestPhoneNumberOptions
-
(required)
- $x_test_id : string = null
-
(optional)
- $contentType : string = self::contentTypes['testPhoneNumberSendSms'][0]
-
The value for the Content-Type header. Check self::contentTypes['testPhoneNumberSendSms'] to see the possible values for this operation
Tags
Return values
Request —testPhoneNumberSendSmsWithHttpInfo()
Operation testPhoneNumberSendSmsWithHttpInfo
public
testPhoneNumberSendSmsWithHttpInfo(string $phone_number_id, TestPhoneNumberOptions $test_phone_number_options[, string $x_test_id = null ][, string $contentType = self::contentTypes['testPhoneNumberSendSms'][0] ]) : array<string|int, mixed>
Parameters
- $phone_number_id : string
-
(required)
- $test_phone_number_options : TestPhoneNumberOptions
-
(required)
- $x_test_id : string = null
-
(optional)
- $contentType : string = self::contentTypes['testPhoneNumberSendSms'][0]
-
The value for the Content-Type header. Check self::contentTypes['testPhoneNumberSendSms'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options