Documentation

PhoneControllerApi
in package

MailSlurp

PhoneControllerApi Class Doc Comment

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['createEmergencyAddress' => ['application/json'], 'deleteEmergencyAddress' => ['application/json'], 'deletePhoneNumber' => ['application/json'], 'getConsentStatus' => ['application/json'], 'getEmergencyAddress' => ['application/json'], 'getEmergencyAddresses' => ['application/json'], 'getPhoneNumber' => ['application/json'], 'getPhoneNumbers' => ['application/json'], 'getPhonePlans' => ['application/json'], 'getPhonePlansAvailability' => ['application/json'], 'getSentSmsByPhoneNumber' => ['application/json'], 'getSmsByPhoneNumber' => ['application/json'], 'sendSmsFromPhoneNumber' => ['application/json'], 'setConsentStatus' => ['application/json'], 'setPhoneFavourited' => ['application/json'], 'testPhoneNumberSendSms' => ['application/json'], 'updatePhoneNumber' => ['application/json'], 'validatePhoneNumber' => ['application/json']]

$client


    protected
        ClientInterface
    $client

$config


    protected
        Configuration
    $config

$headerSelector


    protected
        HeaderSelector
    $headerSelector

$hostIndex


    protected
        int
    $hostIndex

Host index

__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

Create an emergency address

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

Return values

EmergencyAddress —

createEmergencyAddressAsync()

Operation createEmergencyAddressAsync


    public
                    createEmergencyAddressAsync(CreateEmergencyAddressOptions $create_emergency_address_options[, string $contentType = self::contentTypes['createEmergencyAddress'][0] ]) : PromiseInterface

Create an emergency address

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

Return values

PromiseInterface —

createEmergencyAddressAsyncWithHttpInfo()

Operation createEmergencyAddressAsyncWithHttpInfo


    public
                    createEmergencyAddressAsyncWithHttpInfo(CreateEmergencyAddressOptions $create_emergency_address_options[, string $contentType = self::contentTypes['createEmergencyAddress'][0] ]) : PromiseInterface

Create an emergency address

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

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

Return values

Request —

createEmergencyAddressWithHttpInfo()

Operation createEmergencyAddressWithHttpInfo


    public
                    createEmergencyAddressWithHttpInfo(CreateEmergencyAddressOptions $create_emergency_address_options[, string $contentType = self::contentTypes['createEmergencyAddress'][0] ]) : array<string|int, mixed>

Create an emergency address

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

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

Delete an emergency address

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

Return values

EmptyResponseDto —

deleteEmergencyAddressAsync()

Operation deleteEmergencyAddressAsync


    public
                    deleteEmergencyAddressAsync(string $address_id[, string $contentType = self::contentTypes['deleteEmergencyAddress'][0] ]) : PromiseInterface

Delete an emergency address

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

Return values

PromiseInterface —

deleteEmergencyAddressAsyncWithHttpInfo()

Operation deleteEmergencyAddressAsyncWithHttpInfo


    public
                    deleteEmergencyAddressAsyncWithHttpInfo(string $address_id[, string $contentType = self::contentTypes['deleteEmergencyAddress'][0] ]) : PromiseInterface

Delete an emergency address

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

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

Return values

Request —

deleteEmergencyAddressWithHttpInfo()

Operation deleteEmergencyAddressWithHttpInfo


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

Delete an emergency address

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

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

Delete a phone number

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

Return values

void —

deletePhoneNumberAsync()

Operation deletePhoneNumberAsync


    public
                    deletePhoneNumberAsync(string $phone_number_id[, string $contentType = self::contentTypes['deletePhoneNumber'][0] ]) : PromiseInterface

Delete a phone number

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

Return values

PromiseInterface —

deletePhoneNumberAsyncWithHttpInfo()

Operation deletePhoneNumberAsyncWithHttpInfo


    public
                    deletePhoneNumberAsyncWithHttpInfo(string $phone_number_id[, string $contentType = self::contentTypes['deletePhoneNumber'][0] ]) : PromiseInterface

Delete a phone number

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

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

Return values

Request —

deletePhoneNumberWithHttpInfo()

Operation deletePhoneNumberWithHttpInfo


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

Delete a phone number

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

Return values

array<string|int, mixed> —

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

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration —

getConsentStatus()

Operation getConsentStatus


    public
                    getConsentStatus([string $contentType = self::contentTypes['getConsentStatus'][0] ]) : ConsentStatusDto

Get consent status

Parameters

$contentType : string = self::contentTypes['getConsentStatus'][0]: The value for the Content-Type header. Check self::contentTypes['getConsentStatus'] to see the possible values for this operation

Return values

ConsentStatusDto —

getConsentStatusAsync()

Operation getConsentStatusAsync


    public
                    getConsentStatusAsync([string $contentType = self::contentTypes['getConsentStatus'][0] ]) : PromiseInterface

Get consent status

Parameters

$contentType : string = self::contentTypes['getConsentStatus'][0]: The value for the Content-Type header. Check self::contentTypes['getConsentStatus'] to see the possible values for this operation

Return values

PromiseInterface —

getConsentStatusAsyncWithHttpInfo()

Operation getConsentStatusAsyncWithHttpInfo


    public
                    getConsentStatusAsyncWithHttpInfo([string $contentType = self::contentTypes['getConsentStatus'][0] ]) : PromiseInterface

Get consent status

Parameters

$contentType : string = self::contentTypes['getConsentStatus'][0]: The value for the Content-Type header. Check self::contentTypes['getConsentStatus'] to see the possible values for this operation

Return values

PromiseInterface —

getConsentStatusRequest()

Create request for operation 'getConsentStatus'


    public
                    getConsentStatusRequest([string $contentType = self::contentTypes['getConsentStatus'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['getConsentStatus'][0]: The value for the Content-Type header. Check self::contentTypes['getConsentStatus'] to see the possible values for this operation

Return values

Request —

getConsentStatusWithHttpInfo()

Operation getConsentStatusWithHttpInfo


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

Get consent status

Parameters

$contentType : string = self::contentTypes['getConsentStatus'][0]: The value for the Content-Type header. Check self::contentTypes['getConsentStatus'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

getEmergencyAddress()

Operation getEmergencyAddress


    public
                    getEmergencyAddress(string $address_id[, string $contentType = self::contentTypes['getEmergencyAddress'][0] ]) : EmergencyAddress

Get an emergency address

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

Return values

EmergencyAddress —

getEmergencyAddressAsync()

Operation getEmergencyAddressAsync


    public
                    getEmergencyAddressAsync(string $address_id[, string $contentType = self::contentTypes['getEmergencyAddress'][0] ]) : PromiseInterface

Get an emergency address

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

Return values

PromiseInterface —

getEmergencyAddressAsyncWithHttpInfo()

Operation getEmergencyAddressAsyncWithHttpInfo


    public
                    getEmergencyAddressAsyncWithHttpInfo(string $address_id[, string $contentType = self::contentTypes['getEmergencyAddress'][0] ]) : PromiseInterface

Get an emergency address

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

Return values

PromiseInterface —

getEmergencyAddresses()

Operation getEmergencyAddresses


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

Get emergency addresses

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

Return values

array<string|int, EmergencyAddressDto> —

getEmergencyAddressesAsync()

Operation getEmergencyAddressesAsync


    public
                    getEmergencyAddressesAsync([string $contentType = self::contentTypes['getEmergencyAddresses'][0] ]) : PromiseInterface

Get emergency addresses

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

Return values

PromiseInterface —

getEmergencyAddressesAsyncWithHttpInfo()

Operation getEmergencyAddressesAsyncWithHttpInfo


    public
                    getEmergencyAddressesAsyncWithHttpInfo([string $contentType = self::contentTypes['getEmergencyAddresses'][0] ]) : PromiseInterface

Get emergency addresses

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

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

Return values

Request —

getEmergencyAddressesWithHttpInfo()

Operation getEmergencyAddressesWithHttpInfo


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

Get emergency addresses

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

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

Return values

Request —

getEmergencyAddressWithHttpInfo()

Operation getEmergencyAddressWithHttpInfo


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

Get an emergency address

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

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

Get a phone number by ID

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

Return values

PhoneNumberDto —

getPhoneNumberAsync()

Operation getPhoneNumberAsync


    public
                    getPhoneNumberAsync(string $phone_number_id[, string $contentType = self::contentTypes['getPhoneNumber'][0] ]) : PromiseInterface

Get a phone number by ID

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

Return values

PromiseInterface —

getPhoneNumberAsyncWithHttpInfo()

Operation getPhoneNumberAsyncWithHttpInfo


    public
                    getPhoneNumberAsyncWithHttpInfo(string $phone_number_id[, string $contentType = self::contentTypes['getPhoneNumber'][0] ]) : PromiseInterface

Get a phone number by ID

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

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

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 $search = null ][, array<string|int, string> $include = null ][, bool $favourite = false ][, string $contentType = self::contentTypes['getPhoneNumbers'][0] ]) : PagePhoneNumberProjection

Get phone numbers

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)
$search : string = null: Optional search filter (optional)
$include : array<string|int, string> = null: Optional phoneIds to include in result (optional)
$favourite : bool = false: Optionally filter results for favourites only (optional, default to false)
$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

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 $search = null ][, array<string|int, string> $include = null ][, bool $favourite = false ][, string $contentType = self::contentTypes['getPhoneNumbers'][0] ]) : PromiseInterface

Get phone numbers

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)
$search : string = null: Optional search filter (optional)
$include : array<string|int, string> = null: Optional phoneIds to include in result (optional)
$favourite : bool = false: Optionally filter results for favourites only (optional, default to false)
$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

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 $search = null ][, array<string|int, string> $include = null ][, bool $favourite = false ][, string $contentType = self::contentTypes['getPhoneNumbers'][0] ]) : PromiseInterface

Get phone numbers

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)
$search : string = null: Optional search filter (optional)
$include : array<string|int, string> = null: Optional phoneIds to include in result (optional)
$favourite : bool = false: Optionally filter results for favourites only (optional, default to false)
$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

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 $search = null ][, array<string|int, string> $include = null ][, bool $favourite = false ][, 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)
$search : string = null: Optional search filter (optional)
$include : array<string|int, string> = null: Optional phoneIds to include in result (optional)
$favourite : bool = false: Optionally filter results for favourites only (optional, default to false)
$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

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 $search = null ][, array<string|int, string> $include = null ][, bool $favourite = false ][, string $contentType = self::contentTypes['getPhoneNumbers'][0] ]) : array<string|int, mixed>

Get phone numbers

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)
$search : string = null: Optional search filter (optional)
$include : array<string|int, string> = null: Optional phoneIds to include in result (optional)
$favourite : bool = false: Optionally filter results for favourites only (optional, default to false)
$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

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>

Get a phone number by ID

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

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>

Get phone plans

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

Return values

array<string|int, PhonePlanDto> —

getPhonePlansAsync()

Operation getPhonePlansAsync


    public
                    getPhonePlansAsync([string $contentType = self::contentTypes['getPhonePlans'][0] ]) : PromiseInterface

Get phone plans

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

Return values

PromiseInterface —

getPhonePlansAsyncWithHttpInfo()

Operation getPhonePlansAsyncWithHttpInfo


    public
                    getPhonePlansAsyncWithHttpInfo([string $contentType = self::contentTypes['getPhonePlans'][0] ]) : PromiseInterface

Get phone plans

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

Return values

PromiseInterface —

getPhonePlansAvailability()

Operation getPhonePlansAvailability


    public
                    getPhonePlansAvailability([string $contentType = self::contentTypes['getPhonePlansAvailability'][0] ]) : PhonePlanAvailability

Get phone plans availability

Parameters

$contentType : string = self::contentTypes['getPhonePlansAvailability'][0]: The value for the Content-Type header. Check self::contentTypes['getPhonePlansAvailability'] to see the possible values for this operation

Return values

PhonePlanAvailability —

getPhonePlansAvailabilityAsync()

Operation getPhonePlansAvailabilityAsync


    public
                    getPhonePlansAvailabilityAsync([string $contentType = self::contentTypes['getPhonePlansAvailability'][0] ]) : PromiseInterface

Get phone plans availability

Parameters

$contentType : string = self::contentTypes['getPhonePlansAvailability'][0]: The value for the Content-Type header. Check self::contentTypes['getPhonePlansAvailability'] to see the possible values for this operation

Return values

PromiseInterface —

getPhonePlansAvailabilityAsyncWithHttpInfo()

Operation getPhonePlansAvailabilityAsyncWithHttpInfo


    public
                    getPhonePlansAvailabilityAsyncWithHttpInfo([string $contentType = self::contentTypes['getPhonePlansAvailability'][0] ]) : PromiseInterface

Get phone plans availability

Parameters

$contentType : string = self::contentTypes['getPhonePlansAvailability'][0]: The value for the Content-Type header. Check self::contentTypes['getPhonePlansAvailability'] to see the possible values for this operation

Return values

PromiseInterface —

getPhonePlansAvailabilityRequest()

Create request for operation 'getPhonePlansAvailability'


    public
                    getPhonePlansAvailabilityRequest([string $contentType = self::contentTypes['getPhonePlansAvailability'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['getPhonePlansAvailability'][0]: The value for the Content-Type header. Check self::contentTypes['getPhonePlansAvailability'] to see the possible values for this operation

Return values

Request —

getPhonePlansAvailabilityWithHttpInfo()

Operation getPhonePlansAvailabilityWithHttpInfo


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

Get phone plans availability

Parameters

$contentType : string = self::contentTypes['getPhonePlansAvailability'][0]: The value for the Content-Type header. Check self::contentTypes['getPhonePlansAvailability'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

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

Return values

Request —

getPhonePlansWithHttpInfo()

Operation getPhonePlansWithHttpInfo


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

Get phone plans

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

Return values

array<string|int, mixed> —

of \MailSlurp\Models\PhonePlanDto[], HTTP status code, HTTP response headers (array of strings)

getSentSmsByPhoneNumber()

Operation getSentSmsByPhoneNumber


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

List sent TXT messages for a phone number

Parameters

$phone_number_id : string: phone_number_id (required)
$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['getSentSmsByPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['getSentSmsByPhoneNumber'] to see the possible values for this operation

Return values

PageSentSmsProjection —

getSentSmsByPhoneNumberAsync()

Operation getSentSmsByPhoneNumberAsync


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

List sent TXT messages for a phone number

Parameters

$phone_number_id : string: (required)
$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['getSentSmsByPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['getSentSmsByPhoneNumber'] to see the possible values for this operation

Return values

PromiseInterface —

getSentSmsByPhoneNumberAsyncWithHttpInfo()

Operation getSentSmsByPhoneNumberAsyncWithHttpInfo


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

List sent TXT messages for a phone number

Parameters

$phone_number_id : string: (required)
$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['getSentSmsByPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['getSentSmsByPhoneNumber'] to see the possible values for this operation

Return values

PromiseInterface —

getSentSmsByPhoneNumberRequest()

Create request for operation 'getSentSmsByPhoneNumber'


    public
                    getSentSmsByPhoneNumberRequest(string $phone_number_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $contentType = self::contentTypes['getSentSmsByPhoneNumber'][0] ]) : Request

Parameters

$phone_number_id : string: (required)
$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['getSentSmsByPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['getSentSmsByPhoneNumber'] to see the possible values for this operation

Return values

Request —

getSentSmsByPhoneNumberWithHttpInfo()

Operation getSentSmsByPhoneNumberWithHttpInfo


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

List sent TXT messages for a phone number

Parameters

$phone_number_id : string: (required)
$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['getSentSmsByPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['getSentSmsByPhoneNumber'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

getSmsByPhoneNumber()

Operation getSmsByPhoneNumber


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

List SMS messages for a phone number

Parameters

$phone_number_id : string: phone_number_id (required)
$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')
$unread_only : bool = false: Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
$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['getSmsByPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['getSmsByPhoneNumber'] to see the possible values for this operation

Return values

PageSmsProjection —

getSmsByPhoneNumberAsync()

Operation getSmsByPhoneNumberAsync


    public
                    getSmsByPhoneNumberAsync(string $phone_number_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, bool $favourite = false ][, string $contentType = self::contentTypes['getSmsByPhoneNumber'][0] ]) : PromiseInterface

List SMS messages for a phone number

Parameters

$phone_number_id : string: (required)
$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')
$unread_only : bool = false: Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
$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['getSmsByPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['getSmsByPhoneNumber'] to see the possible values for this operation

Return values

PromiseInterface —

getSmsByPhoneNumberAsyncWithHttpInfo()

Operation getSmsByPhoneNumberAsyncWithHttpInfo


    public
                    getSmsByPhoneNumberAsyncWithHttpInfo(string $phone_number_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, bool $favourite = false ][, string $contentType = self::contentTypes['getSmsByPhoneNumber'][0] ]) : PromiseInterface

List SMS messages for a phone number

Parameters

$phone_number_id : string: (required)
$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')
$unread_only : bool = false: Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
$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['getSmsByPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['getSmsByPhoneNumber'] to see the possible values for this operation

Return values

PromiseInterface —

getSmsByPhoneNumberRequest()

Create request for operation 'getSmsByPhoneNumber'


    public
                    getSmsByPhoneNumberRequest(string $phone_number_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, bool $favourite = false ][, string $contentType = self::contentTypes['getSmsByPhoneNumber'][0] ]) : Request

Parameters

$phone_number_id : string: (required)
$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')
$unread_only : bool = false: Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
$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['getSmsByPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['getSmsByPhoneNumber'] to see the possible values for this operation

Return values

Request —

getSmsByPhoneNumberWithHttpInfo()

Operation getSmsByPhoneNumberWithHttpInfo


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

List SMS messages for a phone number

Parameters

$phone_number_id : string: (required)
$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')
$unread_only : bool = false: Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
$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['getSmsByPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['getSmsByPhoneNumber'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

sendSmsFromPhoneNumber()

Operation sendSmsFromPhoneNumber


    public
                    sendSmsFromPhoneNumber(string $phone_number_id, SmsSendOptions $sms_send_options[, string $contentType = self::contentTypes['sendSmsFromPhoneNumber'][0] ]) : SentSmsDto

Send TXT message from a phone number

Parameters

$phone_number_id : string: phone_number_id (required)
$sms_send_options : SmsSendOptions: sms_send_options (required)
$contentType : string = self::contentTypes['sendSmsFromPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['sendSmsFromPhoneNumber'] to see the possible values for this operation

Return values

SentSmsDto —

sendSmsFromPhoneNumberAsync()

Operation sendSmsFromPhoneNumberAsync


    public
                    sendSmsFromPhoneNumberAsync(string $phone_number_id, SmsSendOptions $sms_send_options[, string $contentType = self::contentTypes['sendSmsFromPhoneNumber'][0] ]) : PromiseInterface

Send TXT message from a phone number

Parameters

$phone_number_id : string: (required)
$sms_send_options : SmsSendOptions: (required)
$contentType : string = self::contentTypes['sendSmsFromPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['sendSmsFromPhoneNumber'] to see the possible values for this operation

Return values

PromiseInterface —

sendSmsFromPhoneNumberAsyncWithHttpInfo()

Operation sendSmsFromPhoneNumberAsyncWithHttpInfo


    public
                    sendSmsFromPhoneNumberAsyncWithHttpInfo(string $phone_number_id, SmsSendOptions $sms_send_options[, string $contentType = self::contentTypes['sendSmsFromPhoneNumber'][0] ]) : PromiseInterface

Send TXT message from a phone number

Parameters

$phone_number_id : string: (required)
$sms_send_options : SmsSendOptions: (required)
$contentType : string = self::contentTypes['sendSmsFromPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['sendSmsFromPhoneNumber'] to see the possible values for this operation

Return values

PromiseInterface —

sendSmsFromPhoneNumberRequest()

Create request for operation 'sendSmsFromPhoneNumber'


    public
                    sendSmsFromPhoneNumberRequest(string $phone_number_id, SmsSendOptions $sms_send_options[, string $contentType = self::contentTypes['sendSmsFromPhoneNumber'][0] ]) : Request

Parameters

$phone_number_id : string: (required)
$sms_send_options : SmsSendOptions: (required)
$contentType : string = self::contentTypes['sendSmsFromPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['sendSmsFromPhoneNumber'] to see the possible values for this operation

Return values

Request —

sendSmsFromPhoneNumberWithHttpInfo()

Operation sendSmsFromPhoneNumberWithHttpInfo


    public
                    sendSmsFromPhoneNumberWithHttpInfo(string $phone_number_id, SmsSendOptions $sms_send_options[, string $contentType = self::contentTypes['sendSmsFromPhoneNumber'][0] ]) : array<string|int, mixed>

Send TXT message from a phone number

Parameters

$phone_number_id : string: (required)
$sms_send_options : SmsSendOptions: (required)
$contentType : string = self::contentTypes['sendSmsFromPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['sendSmsFromPhoneNumber'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

setConsentStatus()

Operation setConsentStatus


    public
                    setConsentStatus(bool $agree[, string $contentType = self::contentTypes['setConsentStatus'][0] ]) : ConsentStatusDto

Set consent status

Parameters

$agree : bool: agree (required)
$contentType : string = self::contentTypes['setConsentStatus'][0]: The value for the Content-Type header. Check self::contentTypes['setConsentStatus'] to see the possible values for this operation

Return values

ConsentStatusDto —

setConsentStatusAsync()

Operation setConsentStatusAsync


    public
                    setConsentStatusAsync(bool $agree[, string $contentType = self::contentTypes['setConsentStatus'][0] ]) : PromiseInterface

Set consent status

Parameters

$agree : bool: (required)
$contentType : string = self::contentTypes['setConsentStatus'][0]: The value for the Content-Type header. Check self::contentTypes['setConsentStatus'] to see the possible values for this operation

Return values

PromiseInterface —

setConsentStatusAsyncWithHttpInfo()

Operation setConsentStatusAsyncWithHttpInfo


    public
                    setConsentStatusAsyncWithHttpInfo(bool $agree[, string $contentType = self::contentTypes['setConsentStatus'][0] ]) : PromiseInterface

Set consent status

Parameters

$agree : bool: (required)
$contentType : string = self::contentTypes['setConsentStatus'][0]: The value for the Content-Type header. Check self::contentTypes['setConsentStatus'] to see the possible values for this operation

Return values

PromiseInterface —

setConsentStatusRequest()

Create request for operation 'setConsentStatus'


    public
                    setConsentStatusRequest(bool $agree[, string $contentType = self::contentTypes['setConsentStatus'][0] ]) : Request

Parameters

$agree : bool: (required)
$contentType : string = self::contentTypes['setConsentStatus'][0]: The value for the Content-Type header. Check self::contentTypes['setConsentStatus'] to see the possible values for this operation

Return values

Request —

setConsentStatusWithHttpInfo()

Operation setConsentStatusWithHttpInfo


    public
                    setConsentStatusWithHttpInfo(bool $agree[, string $contentType = self::contentTypes['setConsentStatus'][0] ]) : array<string|int, mixed>

Set consent status

Parameters

$agree : bool: (required)
$contentType : string = self::contentTypes['setConsentStatus'][0]: The value for the Content-Type header. Check self::contentTypes['setConsentStatus'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\ConsentStatusDto, 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 —

setPhoneFavourited()

Operation setPhoneFavourited


    public
                    setPhoneFavourited(string $phone_number_id, SetPhoneFavouritedOptions $set_phone_favourited_options[, string $contentType = self::contentTypes['setPhoneFavourited'][0] ]) : PhoneNumberDto

Set phone favourited state

Parameters

$phone_number_id : string: ID of phone to set favourite state (required)
$set_phone_favourited_options : SetPhoneFavouritedOptions: set_phone_favourited_options (required)
$contentType : string = self::contentTypes['setPhoneFavourited'][0]: The value for the Content-Type header. Check self::contentTypes['setPhoneFavourited'] to see the possible values for this operation

Return values

PhoneNumberDto —

setPhoneFavouritedAsync()

Operation setPhoneFavouritedAsync


    public
                    setPhoneFavouritedAsync(string $phone_number_id, SetPhoneFavouritedOptions $set_phone_favourited_options[, string $contentType = self::contentTypes['setPhoneFavourited'][0] ]) : PromiseInterface

Set phone favourited state

Parameters

$phone_number_id : string: ID of phone to set favourite state (required)
$set_phone_favourited_options : SetPhoneFavouritedOptions: (required)
$contentType : string = self::contentTypes['setPhoneFavourited'][0]: The value for the Content-Type header. Check self::contentTypes['setPhoneFavourited'] to see the possible values for this operation

Return values

PromiseInterface —

setPhoneFavouritedAsyncWithHttpInfo()

Operation setPhoneFavouritedAsyncWithHttpInfo


    public
                    setPhoneFavouritedAsyncWithHttpInfo(string $phone_number_id, SetPhoneFavouritedOptions $set_phone_favourited_options[, string $contentType = self::contentTypes['setPhoneFavourited'][0] ]) : PromiseInterface

Set phone favourited state

Parameters

$phone_number_id : string: ID of phone to set favourite state (required)
$set_phone_favourited_options : SetPhoneFavouritedOptions: (required)
$contentType : string = self::contentTypes['setPhoneFavourited'][0]: The value for the Content-Type header. Check self::contentTypes['setPhoneFavourited'] to see the possible values for this operation

Return values

PromiseInterface —

setPhoneFavouritedRequest()

Create request for operation 'setPhoneFavourited'


    public
                    setPhoneFavouritedRequest(string $phone_number_id, SetPhoneFavouritedOptions $set_phone_favourited_options[, string $contentType = self::contentTypes['setPhoneFavourited'][0] ]) : Request

Parameters

$phone_number_id : string: ID of phone to set favourite state (required)
$set_phone_favourited_options : SetPhoneFavouritedOptions: (required)
$contentType : string = self::contentTypes['setPhoneFavourited'][0]: The value for the Content-Type header. Check self::contentTypes['setPhoneFavourited'] to see the possible values for this operation

Return values

Request —

setPhoneFavouritedWithHttpInfo()

Operation setPhoneFavouritedWithHttpInfo


    public
                    setPhoneFavouritedWithHttpInfo(string $phone_number_id, SetPhoneFavouritedOptions $set_phone_favourited_options[, string $contentType = self::contentTypes['setPhoneFavourited'][0] ]) : array<string|int, mixed>

Set phone favourited state

Parameters

$phone_number_id : string: ID of phone to set favourite state (required)
$set_phone_favourited_options : SetPhoneFavouritedOptions: (required)
$contentType : string = self::contentTypes['setPhoneFavourited'][0]: The value for the Content-Type header. Check self::contentTypes['setPhoneFavourited'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

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

Test sending an SMS to a number

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

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

Test sending an SMS to a number

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

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

Test sending an SMS to a number

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

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

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>

Test sending an SMS to a number

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

Return values

array<string|int, mixed> —

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

updatePhoneNumber()

Operation updatePhoneNumber


    public
                    updatePhoneNumber(string $phone_number_id, UpdatePhoneNumberOptions $update_phone_number_options[, string $contentType = self::contentTypes['updatePhoneNumber'][0] ]) : PhoneNumberDto

Update a phone number

Parameters

$phone_number_id : string: ID of phone to set favourite state (required)
$update_phone_number_options : UpdatePhoneNumberOptions: update_phone_number_options (required)
$contentType : string = self::contentTypes['updatePhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['updatePhoneNumber'] to see the possible values for this operation

Return values

PhoneNumberDto —

updatePhoneNumberAsync()

Operation updatePhoneNumberAsync


    public
                    updatePhoneNumberAsync(string $phone_number_id, UpdatePhoneNumberOptions $update_phone_number_options[, string $contentType = self::contentTypes['updatePhoneNumber'][0] ]) : PromiseInterface

Update a phone number

Parameters

$phone_number_id : string: ID of phone to set favourite state (required)
$update_phone_number_options : UpdatePhoneNumberOptions: (required)
$contentType : string = self::contentTypes['updatePhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['updatePhoneNumber'] to see the possible values for this operation

Return values

PromiseInterface —

updatePhoneNumberAsyncWithHttpInfo()

Operation updatePhoneNumberAsyncWithHttpInfo


    public
                    updatePhoneNumberAsyncWithHttpInfo(string $phone_number_id, UpdatePhoneNumberOptions $update_phone_number_options[, string $contentType = self::contentTypes['updatePhoneNumber'][0] ]) : PromiseInterface

Update a phone number

Parameters

$phone_number_id : string: ID of phone to set favourite state (required)
$update_phone_number_options : UpdatePhoneNumberOptions: (required)
$contentType : string = self::contentTypes['updatePhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['updatePhoneNumber'] to see the possible values for this operation

Return values

PromiseInterface —

updatePhoneNumberRequest()

Create request for operation 'updatePhoneNumber'


    public
                    updatePhoneNumberRequest(string $phone_number_id, UpdatePhoneNumberOptions $update_phone_number_options[, string $contentType = self::contentTypes['updatePhoneNumber'][0] ]) : Request

Parameters

$phone_number_id : string: ID of phone to set favourite state (required)
$update_phone_number_options : UpdatePhoneNumberOptions: (required)
$contentType : string = self::contentTypes['updatePhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['updatePhoneNumber'] to see the possible values for this operation

Return values

Request —

updatePhoneNumberWithHttpInfo()

Operation updatePhoneNumberWithHttpInfo


    public
                    updatePhoneNumberWithHttpInfo(string $phone_number_id, UpdatePhoneNumberOptions $update_phone_number_options[, string $contentType = self::contentTypes['updatePhoneNumber'][0] ]) : array<string|int, mixed>

Update a phone number

Parameters

$phone_number_id : string: ID of phone to set favourite state (required)
$update_phone_number_options : UpdatePhoneNumberOptions: (required)
$contentType : string = self::contentTypes['updatePhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['updatePhoneNumber'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

validatePhoneNumber()

Operation validatePhoneNumber


    public
                    validatePhoneNumber(ValidatePhoneNumberOptions $validate_phone_number_options[, string $contentType = self::contentTypes['validatePhoneNumber'][0] ]) : PhoneNumberValidationDto

Verify validity of a phone number

Parameters

$validate_phone_number_options : ValidatePhoneNumberOptions: validate_phone_number_options (required)
$contentType : string = self::contentTypes['validatePhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['validatePhoneNumber'] to see the possible values for this operation

Return values

PhoneNumberValidationDto —

validatePhoneNumberAsync()

Operation validatePhoneNumberAsync


    public
                    validatePhoneNumberAsync(ValidatePhoneNumberOptions $validate_phone_number_options[, string $contentType = self::contentTypes['validatePhoneNumber'][0] ]) : PromiseInterface

Verify validity of a phone number

Parameters

$validate_phone_number_options : ValidatePhoneNumberOptions: (required)
$contentType : string = self::contentTypes['validatePhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['validatePhoneNumber'] to see the possible values for this operation

Return values

PromiseInterface —

validatePhoneNumberAsyncWithHttpInfo()

Operation validatePhoneNumberAsyncWithHttpInfo


    public
                    validatePhoneNumberAsyncWithHttpInfo(ValidatePhoneNumberOptions $validate_phone_number_options[, string $contentType = self::contentTypes['validatePhoneNumber'][0] ]) : PromiseInterface

Verify validity of a phone number

Parameters

$validate_phone_number_options : ValidatePhoneNumberOptions: (required)
$contentType : string = self::contentTypes['validatePhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['validatePhoneNumber'] to see the possible values for this operation

Return values

PromiseInterface —

validatePhoneNumberRequest()

Create request for operation 'validatePhoneNumber'


    public
                    validatePhoneNumberRequest(ValidatePhoneNumberOptions $validate_phone_number_options[, string $contentType = self::contentTypes['validatePhoneNumber'][0] ]) : Request

Parameters

$validate_phone_number_options : ValidatePhoneNumberOptions: (required)
$contentType : string = self::contentTypes['validatePhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['validatePhoneNumber'] to see the possible values for this operation

Return values

Request —

validatePhoneNumberWithHttpInfo()

Operation validatePhoneNumberWithHttpInfo


    public
                    validatePhoneNumberWithHttpInfo(ValidatePhoneNumberOptions $validate_phone_number_options[, string $contentType = self::contentTypes['validatePhoneNumber'][0] ]) : array<string|int, mixed>

Verify validity of a phone number

Parameters

$validate_phone_number_options : ValidatePhoneNumberOptions: (required)
$contentType : string = self::contentTypes['validatePhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['validatePhoneNumber'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

createHttpClientOption()

Create http client option


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

Return values

array<string|int, mixed> —

of http client options

PhoneControllerApi in package MailSlurp

Tags

Table of Contents

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

Return values

createEmergencyAddress()

Parameters

Tags

Return values

createEmergencyAddressAsync()

Parameters

Tags

Return values

createEmergencyAddressAsyncWithHttpInfo()

Parameters

Tags

Return values

createEmergencyAddressRequest()

Parameters

Tags

Return values

createEmergencyAddressWithHttpInfo()

Parameters

Tags

Return values

deleteEmergencyAddress()

Parameters

Tags

Return values

deleteEmergencyAddressAsync()

Parameters

Tags

Return values

deleteEmergencyAddressAsyncWithHttpInfo()

Parameters

Tags

Return values

deleteEmergencyAddressRequest()

Parameters

Tags

Return values

deleteEmergencyAddressWithHttpInfo()

Parameters

Tags

Return values

deletePhoneNumber()

Parameters

Tags

Return values

deletePhoneNumberAsync()

Parameters

Tags

Return values

deletePhoneNumberAsyncWithHttpInfo()

Parameters

Tags

Return values

deletePhoneNumberRequest()

Parameters

Tags

Return values

deletePhoneNumberWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getConsentStatus()

Parameters

Tags

Return values

PhoneControllerApi
in package

MailSlurp