Documentation

PhoneControllerApi
in package

MailSlurp

PhoneControllerApi Class Doc Comment

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['acquirePhonePoolLease' => ['application/json'], 'addAllPhoneNumbersToPhonePool' => ['application/json'], 'addPhoneNumberTags' => ['application/json'], 'addPhoneNumbersToPhonePool' => ['application/json'], 'createEmergencyAddress' => ['application/json'], 'createPhoneNumber' => ['application/json'], 'createPhonePool' => ['application/json'], 'createPhoneProvisioningJob' => ['application/json'], 'deleteAllPhoneNumber' => ['application/json'], 'deleteEmergencyAddress' => ['application/json'], 'deletePhoneMessageThreadItems' => ['application/json'], 'deletePhoneNumber' => ['application/json'], 'deletePhonePool' => ['application/json'], 'downloadPhoneNumberMedia' => ['application/json'], 'downloadPhoneNumberMediaBase64' => ['application/json'], 'exportPhoneNumbersCsv' => ['application/json'], 'getAllPhoneMessageThreads' => ['application/json'], 'getAllPhoneNumberReleases' => ['application/json'], 'getConsentStatus' => ['application/json'], 'getEmergencyAddress' => ['application/json'], 'getEmergencyAddresses' => ['application/json'], 'getOrCreatePhonePool' => ['application/json'], 'getPhoneMessageThreadItems' => ['application/json'], 'getPhoneMessageThreads' => ['application/json'], 'getPhoneNumber' => ['application/json'], 'getPhoneNumberByName' => ['application/json'], 'getPhoneNumberByPhoneNumber' => ['application/json'], 'getPhoneNumberLineTypeIntelligence' => ['application/json'], 'getPhoneNumberMedia' => ['application/json'], 'getPhoneNumberMedia1' => ['application/json'], 'getPhoneNumberMediaById' => ['application/json'], 'getPhoneNumberRelease' => ['application/json'], 'getPhoneNumberTags' => ['application/json'], 'getPhoneNumbers' => ['application/json'], 'getPhonePlans' => ['application/json'], 'getPhonePlansAvailability' => ['application/json'], 'getPhonePool' => ['application/json'], 'getPhonePoolByName' => ['application/json'], 'getPhonePools' => ['application/json'], 'getPhoneProvisioningCapabilities' => ['application/json'], 'getPhoneProvisioningJob' => ['application/json'], 'getPhoneSmsPrepaidCredit' => ['application/json'], 'getPhoneSmsPrepaidCredits' => ['application/json'], 'getPhoneSummary' => ['application/json'], 'getPhoneTags' => ['application/json'], 'getSentSmsByPhoneNumber' => ['application/json'], 'getSmsByPhoneNumber' => ['application/json'], 'reassignPhoneNumberRelease' => ['application/json'], 'releasePhonePoolLease' => ['application/json'], 'removePhoneNumberFromPhonePool' => ['application/json'], 'removePhoneNumberTags' => ['application/json'], 'searchAvailablePhoneNumbers' => ['application/json'], 'sendSmsFromPhoneNumber' => ['application/json'], 'setConsentStatus' => ['application/json'], 'setPhoneFavourited' => ['application/json'], 'setPhoneNumberTags' => ['application/json'], 'testPhoneNumberSendSms' => ['application/json'], 'updatePhoneNumber' => ['application/json'], 'updatePhonePool' => ['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 —

acquirePhonePoolLease()

Operation acquirePhonePoolLease


    public
                    acquirePhonePoolLease(string $pool_id, AcquirePhonePoolLeaseOptions $acquire_phone_pool_lease_options[, string $contentType = self::contentTypes['acquirePhonePoolLease'][0] ]) : PhonePoolLeaseDto

Acquire phone pool lease

Parameters

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

Return values

PhonePoolLeaseDto —

acquirePhonePoolLeaseAsync()

Operation acquirePhonePoolLeaseAsync


    public
                    acquirePhonePoolLeaseAsync(string $pool_id, AcquirePhonePoolLeaseOptions $acquire_phone_pool_lease_options[, string $contentType = self::contentTypes['acquirePhonePoolLease'][0] ]) : PromiseInterface

Acquire phone pool lease

Parameters

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

Return values

PromiseInterface —

acquirePhonePoolLeaseAsyncWithHttpInfo()

Operation acquirePhonePoolLeaseAsyncWithHttpInfo


    public
                    acquirePhonePoolLeaseAsyncWithHttpInfo(string $pool_id, AcquirePhonePoolLeaseOptions $acquire_phone_pool_lease_options[, string $contentType = self::contentTypes['acquirePhonePoolLease'][0] ]) : PromiseInterface

Acquire phone pool lease

Parameters

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

Return values

PromiseInterface —

acquirePhonePoolLeaseRequest()

Create request for operation 'acquirePhonePoolLease'


    public
                    acquirePhonePoolLeaseRequest(string $pool_id, AcquirePhonePoolLeaseOptions $acquire_phone_pool_lease_options[, string $contentType = self::contentTypes['acquirePhonePoolLease'][0] ]) : Request

Parameters

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

Return values

Request —

acquirePhonePoolLeaseWithHttpInfo()

Operation acquirePhonePoolLeaseWithHttpInfo


    public
                    acquirePhonePoolLeaseWithHttpInfo(string $pool_id, AcquirePhonePoolLeaseOptions $acquire_phone_pool_lease_options[, string $contentType = self::contentTypes['acquirePhonePoolLease'][0] ]) : array<string|int, mixed>

Acquire phone pool lease

Parameters

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

Return values

array<string|int, mixed> —

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

addAllPhoneNumbersToPhonePool()

Operation addAllPhoneNumbersToPhonePool


    public
                    addAllPhoneNumbersToPhonePool(string $pool_id[, string $contentType = self::contentTypes['addAllPhoneNumbersToPhonePool'][0] ]) : PhonePoolDetailDto

Add all phone numbers to phone pool

Parameters

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

Return values

PhonePoolDetailDto —

addAllPhoneNumbersToPhonePoolAsync()

Operation addAllPhoneNumbersToPhonePoolAsync


    public
                    addAllPhoneNumbersToPhonePoolAsync(string $pool_id[, string $contentType = self::contentTypes['addAllPhoneNumbersToPhonePool'][0] ]) : PromiseInterface

Add all phone numbers to phone pool

Parameters

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

Return values

PromiseInterface —

addAllPhoneNumbersToPhonePoolAsyncWithHttpInfo()

Operation addAllPhoneNumbersToPhonePoolAsyncWithHttpInfo


    public
                    addAllPhoneNumbersToPhonePoolAsyncWithHttpInfo(string $pool_id[, string $contentType = self::contentTypes['addAllPhoneNumbersToPhonePool'][0] ]) : PromiseInterface

Add all phone numbers to phone pool

Parameters

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

Return values

PromiseInterface —

addAllPhoneNumbersToPhonePoolRequest()

Create request for operation 'addAllPhoneNumbersToPhonePool'


    public
                    addAllPhoneNumbersToPhonePoolRequest(string $pool_id[, string $contentType = self::contentTypes['addAllPhoneNumbersToPhonePool'][0] ]) : Request

Parameters

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

Return values

Request —

addAllPhoneNumbersToPhonePoolWithHttpInfo()

Operation addAllPhoneNumbersToPhonePoolWithHttpInfo


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

Add all phone numbers to phone pool

Parameters

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

Return values

array<string|int, mixed> —

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

addPhoneNumbersToPhonePool()

Operation addPhoneNumbersToPhonePool


    public
                    addPhoneNumbersToPhonePool(string $pool_id, AddPhonePoolNumbersOptions $add_phone_pool_numbers_options[, string $contentType = self::contentTypes['addPhoneNumbersToPhonePool'][0] ]) : PhonePoolDetailDto

Add phone numbers to phone pool

Parameters

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

Return values

PhonePoolDetailDto —

addPhoneNumbersToPhonePoolAsync()

Operation addPhoneNumbersToPhonePoolAsync


    public
                    addPhoneNumbersToPhonePoolAsync(string $pool_id, AddPhonePoolNumbersOptions $add_phone_pool_numbers_options[, string $contentType = self::contentTypes['addPhoneNumbersToPhonePool'][0] ]) : PromiseInterface

Add phone numbers to phone pool

Parameters

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

Return values

PromiseInterface —

addPhoneNumbersToPhonePoolAsyncWithHttpInfo()

Operation addPhoneNumbersToPhonePoolAsyncWithHttpInfo


    public
                    addPhoneNumbersToPhonePoolAsyncWithHttpInfo(string $pool_id, AddPhonePoolNumbersOptions $add_phone_pool_numbers_options[, string $contentType = self::contentTypes['addPhoneNumbersToPhonePool'][0] ]) : PromiseInterface

Add phone numbers to phone pool

Parameters

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

Return values

PromiseInterface —

addPhoneNumbersToPhonePoolRequest()

Create request for operation 'addPhoneNumbersToPhonePool'


    public
                    addPhoneNumbersToPhonePoolRequest(string $pool_id, AddPhonePoolNumbersOptions $add_phone_pool_numbers_options[, string $contentType = self::contentTypes['addPhoneNumbersToPhonePool'][0] ]) : Request

Parameters

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

Return values

Request —

addPhoneNumbersToPhonePoolWithHttpInfo()

Operation addPhoneNumbersToPhonePoolWithHttpInfo


    public
                    addPhoneNumbersToPhonePoolWithHttpInfo(string $pool_id, AddPhonePoolNumbersOptions $add_phone_pool_numbers_options[, string $contentType = self::contentTypes['addPhoneNumbersToPhonePool'][0] ]) : array<string|int, mixed>

Add phone numbers to phone pool

Parameters

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

Return values

array<string|int, mixed> —

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

addPhoneNumberTags()

Operation addPhoneNumberTags


    public
                    addPhoneNumberTags(string $phone_number_id, PhoneNumberTagsOptions $phone_number_tags_options[, string $contentType = self::contentTypes['addPhoneNumberTags'][0] ]) : PhoneNumberDto

Add phone number tags

Parameters

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

Return values

PhoneNumberDto —

addPhoneNumberTagsAsync()

Operation addPhoneNumberTagsAsync


    public
                    addPhoneNumberTagsAsync(string $phone_number_id, PhoneNumberTagsOptions $phone_number_tags_options[, string $contentType = self::contentTypes['addPhoneNumberTags'][0] ]) : PromiseInterface

Add phone number tags

Parameters

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

Return values

PromiseInterface —

addPhoneNumberTagsAsyncWithHttpInfo()

Operation addPhoneNumberTagsAsyncWithHttpInfo


    public
                    addPhoneNumberTagsAsyncWithHttpInfo(string $phone_number_id, PhoneNumberTagsOptions $phone_number_tags_options[, string $contentType = self::contentTypes['addPhoneNumberTags'][0] ]) : PromiseInterface

Add phone number tags

Parameters

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

Return values

PromiseInterface —

addPhoneNumberTagsRequest()

Create request for operation 'addPhoneNumberTags'


    public
                    addPhoneNumberTagsRequest(string $phone_number_id, PhoneNumberTagsOptions $phone_number_tags_options[, string $contentType = self::contentTypes['addPhoneNumberTags'][0] ]) : Request

Parameters

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

Return values

Request —

addPhoneNumberTagsWithHttpInfo()

Operation addPhoneNumberTagsWithHttpInfo


    public
                    addPhoneNumberTagsWithHttpInfo(string $phone_number_id, PhoneNumberTagsOptions $phone_number_tags_options[, string $contentType = self::contentTypes['addPhoneNumberTags'][0] ]) : array<string|int, mixed>

Add phone number tags

Parameters

$phone_number_id : string: (required)
$phone_number_tags_options : PhoneNumberTagsOptions: (required)
$contentType : string = self::contentTypes['addPhoneNumberTags'][0]: The value for the Content-Type header. Check self::contentTypes['addPhoneNumberTags'] 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)

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)

createPhoneNumber()

Operation createPhoneNumber


    public
                    createPhoneNumber(CreatePhoneNumberOptions $create_phone_number_options[, string $contentType = self::contentTypes['createPhoneNumber'][0] ]) : PhoneNumberDto

Add phone number to your account. Only works if you have already added a plan and an initial phone number in your account and acknowledged the pricing and terms of service by enabling API phone creation.

Parameters

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

Return values

PhoneNumberDto —

createPhoneNumberAsync()

Operation createPhoneNumberAsync


    public
                    createPhoneNumberAsync(CreatePhoneNumberOptions $create_phone_number_options[, string $contentType = self::contentTypes['createPhoneNumber'][0] ]) : PromiseInterface

Parameters

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

Return values

PromiseInterface —

createPhoneNumberAsyncWithHttpInfo()

Operation createPhoneNumberAsyncWithHttpInfo


    public
                    createPhoneNumberAsyncWithHttpInfo(CreatePhoneNumberOptions $create_phone_number_options[, string $contentType = self::contentTypes['createPhoneNumber'][0] ]) : PromiseInterface

Parameters

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

Return values

PromiseInterface —

createPhoneNumberRequest()

Create request for operation 'createPhoneNumber'


    public
                    createPhoneNumberRequest(CreatePhoneNumberOptions $create_phone_number_options[, string $contentType = self::contentTypes['createPhoneNumber'][0] ]) : Request

Parameters

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

Return values

Request —

createPhoneNumberWithHttpInfo()

Operation createPhoneNumberWithHttpInfo


    public
                    createPhoneNumberWithHttpInfo(CreatePhoneNumberOptions $create_phone_number_options[, string $contentType = self::contentTypes['createPhoneNumber'][0] ]) : array<string|int, mixed>

Parameters

$create_phone_number_options : CreatePhoneNumberOptions: (required)
$contentType : string = self::contentTypes['createPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['createPhoneNumber'] 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)

createPhonePool()

Operation createPhonePool


    public
                    createPhonePool(CreatePhonePoolOptions $create_phone_pool_options[, string $contentType = self::contentTypes['createPhonePool'][0] ]) : PhonePoolDetailDto

Create phone pool

Parameters

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

Return values

PhonePoolDetailDto —

createPhonePoolAsync()

Operation createPhonePoolAsync


    public
                    createPhonePoolAsync(CreatePhonePoolOptions $create_phone_pool_options[, string $contentType = self::contentTypes['createPhonePool'][0] ]) : PromiseInterface

Create phone pool

Parameters

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

Return values

PromiseInterface —

createPhonePoolAsyncWithHttpInfo()

Operation createPhonePoolAsyncWithHttpInfo


    public
                    createPhonePoolAsyncWithHttpInfo(CreatePhonePoolOptions $create_phone_pool_options[, string $contentType = self::contentTypes['createPhonePool'][0] ]) : PromiseInterface

Create phone pool

Parameters

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

Return values

PromiseInterface —

createPhonePoolRequest()

Create request for operation 'createPhonePool'


    public
                    createPhonePoolRequest(CreatePhonePoolOptions $create_phone_pool_options[, string $contentType = self::contentTypes['createPhonePool'][0] ]) : Request

Parameters

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

Return values

Request —

createPhonePoolWithHttpInfo()

Operation createPhonePoolWithHttpInfo


    public
                    createPhonePoolWithHttpInfo(CreatePhonePoolOptions $create_phone_pool_options[, string $contentType = self::contentTypes['createPhonePool'][0] ]) : array<string|int, mixed>

Create phone pool

Parameters

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

Return values

array<string|int, mixed> —

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

createPhoneProvisioningJob()

Operation createPhoneProvisioningJob


    public
                    createPhoneProvisioningJob(CreatePhoneProvisioningJobOptions $create_phone_provisioning_job_options[, string $contentType = self::contentTypes['createPhoneProvisioningJob'][0] ]) : PhoneProvisioningJobDto

Create a phone provisioning job

Parameters

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

Return values

PhoneProvisioningJobDto —

createPhoneProvisioningJobAsync()

Operation createPhoneProvisioningJobAsync


    public
                    createPhoneProvisioningJobAsync(CreatePhoneProvisioningJobOptions $create_phone_provisioning_job_options[, string $contentType = self::contentTypes['createPhoneProvisioningJob'][0] ]) : PromiseInterface

Create a phone provisioning job

Parameters

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

Return values

PromiseInterface —

createPhoneProvisioningJobAsyncWithHttpInfo()

Operation createPhoneProvisioningJobAsyncWithHttpInfo


    public
                    createPhoneProvisioningJobAsyncWithHttpInfo(CreatePhoneProvisioningJobOptions $create_phone_provisioning_job_options[, string $contentType = self::contentTypes['createPhoneProvisioningJob'][0] ]) : PromiseInterface

Create a phone provisioning job

Parameters

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

Return values

PromiseInterface —

createPhoneProvisioningJobRequest()

Create request for operation 'createPhoneProvisioningJob'


    public
                    createPhoneProvisioningJobRequest(CreatePhoneProvisioningJobOptions $create_phone_provisioning_job_options[, string $contentType = self::contentTypes['createPhoneProvisioningJob'][0] ]) : Request

Parameters

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

Return values

Request —

createPhoneProvisioningJobWithHttpInfo()

Operation createPhoneProvisioningJobWithHttpInfo


    public
                    createPhoneProvisioningJobWithHttpInfo(CreatePhoneProvisioningJobOptions $create_phone_provisioning_job_options[, string $contentType = self::contentTypes['createPhoneProvisioningJob'][0] ]) : array<string|int, mixed>

Create a phone provisioning job

Parameters

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

Return values

array<string|int, mixed> —

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

deleteAllPhoneNumber()

Operation deleteAllPhoneNumber


    public
                    deleteAllPhoneNumber([string $contentType = self::contentTypes['deleteAllPhoneNumber'][0] ]) : void

Delete all phone numbers

Parameters

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

Return values

void —

deleteAllPhoneNumberAsync()

Operation deleteAllPhoneNumberAsync


    public
                    deleteAllPhoneNumberAsync([string $contentType = self::contentTypes['deleteAllPhoneNumber'][0] ]) : PromiseInterface

Delete all phone numbers

Parameters

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

Return values

PromiseInterface —

deleteAllPhoneNumberAsyncWithHttpInfo()

Operation deleteAllPhoneNumberAsyncWithHttpInfo


    public
                    deleteAllPhoneNumberAsyncWithHttpInfo([string $contentType = self::contentTypes['deleteAllPhoneNumber'][0] ]) : PromiseInterface

Delete all phone numbers

Parameters

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

Return values

PromiseInterface —

deleteAllPhoneNumberRequest()

Create request for operation 'deleteAllPhoneNumber'


    public
                    deleteAllPhoneNumberRequest([string $contentType = self::contentTypes['deleteAllPhoneNumber'][0] ]) : Request

Parameters

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

Return values

Request —

deleteAllPhoneNumberWithHttpInfo()

Operation deleteAllPhoneNumberWithHttpInfo


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

Delete all phone numbers

Parameters

$contentType : string = self::contentTypes['deleteAllPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['deleteAllPhoneNumber'] 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)

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)

deletePhoneMessageThreadItems()

Operation deletePhoneMessageThreadItems


    public
                    deletePhoneMessageThreadItems(string $phone_number_id, string $other_number[, string $contentType = self::contentTypes['deletePhoneMessageThreadItems'][0] ]) : EmptyResponseDto

Delete messages in a phone thread

Parameters

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

Return values

EmptyResponseDto —

deletePhoneMessageThreadItemsAsync()

Operation deletePhoneMessageThreadItemsAsync


    public
                    deletePhoneMessageThreadItemsAsync(string $phone_number_id, string $other_number[, string $contentType = self::contentTypes['deletePhoneMessageThreadItems'][0] ]) : PromiseInterface

Delete messages in a phone thread

Parameters

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

Return values

PromiseInterface —

deletePhoneMessageThreadItemsAsyncWithHttpInfo()

Operation deletePhoneMessageThreadItemsAsyncWithHttpInfo


    public
                    deletePhoneMessageThreadItemsAsyncWithHttpInfo(string $phone_number_id, string $other_number[, string $contentType = self::contentTypes['deletePhoneMessageThreadItems'][0] ]) : PromiseInterface

Delete messages in a phone thread

Parameters

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

Return values

PromiseInterface —

deletePhoneMessageThreadItemsRequest()

Create request for operation 'deletePhoneMessageThreadItems'


    public
                    deletePhoneMessageThreadItemsRequest(string $phone_number_id, string $other_number[, string $contentType = self::contentTypes['deletePhoneMessageThreadItems'][0] ]) : Request

Parameters

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

Return values

Request —

deletePhoneMessageThreadItemsWithHttpInfo()

Operation deletePhoneMessageThreadItemsWithHttpInfo


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

Delete messages in a phone thread

Parameters

$phone_number_id : string: (required)
$other_number : string: (required)
$contentType : string = self::contentTypes['deletePhoneMessageThreadItems'][0]: The value for the Content-Type header. Check self::contentTypes['deletePhoneMessageThreadItems'] 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)

deletePhonePool()

Operation deletePhonePool


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

Delete phone pool

Parameters

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

Return values

void —

deletePhonePoolAsync()

Operation deletePhonePoolAsync


    public
                    deletePhonePoolAsync(string $pool_id[, string $contentType = self::contentTypes['deletePhonePool'][0] ]) : PromiseInterface

Delete phone pool

Parameters

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

Return values

PromiseInterface —

deletePhonePoolAsyncWithHttpInfo()

Operation deletePhonePoolAsyncWithHttpInfo


    public
                    deletePhonePoolAsyncWithHttpInfo(string $pool_id[, string $contentType = self::contentTypes['deletePhonePool'][0] ]) : PromiseInterface

Delete phone pool

Parameters

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

Return values

PromiseInterface —

deletePhonePoolRequest()

Create request for operation 'deletePhonePool'


    public
                    deletePhonePoolRequest(string $pool_id[, string $contentType = self::contentTypes['deletePhonePool'][0] ]) : Request

Parameters

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

Return values

Request —

deletePhonePoolWithHttpInfo()

Operation deletePhonePoolWithHttpInfo


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

Delete phone pool

Parameters

$pool_id : string: (required)
$contentType : string = self::contentTypes['deletePhonePool'][0]: The value for the Content-Type header. Check self::contentTypes['deletePhonePool'] 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)

downloadPhoneNumberMedia()

Operation downloadPhoneNumberMedia


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

Parameters

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

Return values

void —

downloadPhoneNumberMediaAsync()

Operation downloadPhoneNumberMediaAsync


    public
                    downloadPhoneNumberMediaAsync(string $media_id[, string $contentType = self::contentTypes['downloadPhoneNumberMedia'][0] ]) : PromiseInterface

Parameters

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

Return values

PromiseInterface —

downloadPhoneNumberMediaAsyncWithHttpInfo()

Operation downloadPhoneNumberMediaAsyncWithHttpInfo


    public
                    downloadPhoneNumberMediaAsyncWithHttpInfo(string $media_id[, string $contentType = self::contentTypes['downloadPhoneNumberMedia'][0] ]) : PromiseInterface

Parameters

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

Return values

PromiseInterface —

downloadPhoneNumberMediaBase64()

Operation downloadPhoneNumberMediaBase64


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

Parameters

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

Return values

void —

downloadPhoneNumberMediaBase64Async()

Operation downloadPhoneNumberMediaBase64Async


    public
                    downloadPhoneNumberMediaBase64Async(string $media_id[, string $contentType = self::contentTypes['downloadPhoneNumberMediaBase64'][0] ]) : PromiseInterface

Parameters

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

Return values

PromiseInterface —

downloadPhoneNumberMediaBase64AsyncWithHttpInfo()

Operation downloadPhoneNumberMediaBase64AsyncWithHttpInfo


    public
                    downloadPhoneNumberMediaBase64AsyncWithHttpInfo(string $media_id[, string $contentType = self::contentTypes['downloadPhoneNumberMediaBase64'][0] ]) : PromiseInterface

Parameters

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

Return values

PromiseInterface —

downloadPhoneNumberMediaBase64Request()

Create request for operation 'downloadPhoneNumberMediaBase64'


    public
                    downloadPhoneNumberMediaBase64Request(string $media_id[, string $contentType = self::contentTypes['downloadPhoneNumberMediaBase64'][0] ]) : Request

Parameters

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

Return values

Request —

downloadPhoneNumberMediaBase64WithHttpInfo()

Operation downloadPhoneNumberMediaBase64WithHttpInfo


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

Parameters

$media_id : string: (required)
$contentType : string = self::contentTypes['downloadPhoneNumberMediaBase64'][0]: The value for the Content-Type header. Check self::contentTypes['downloadPhoneNumberMediaBase64'] 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)

downloadPhoneNumberMediaRequest()

Create request for operation 'downloadPhoneNumberMedia'


    public
                    downloadPhoneNumberMediaRequest(string $media_id[, string $contentType = self::contentTypes['downloadPhoneNumberMedia'][0] ]) : Request

Parameters

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

Return values

Request —

downloadPhoneNumberMediaWithHttpInfo()

Operation downloadPhoneNumberMediaWithHttpInfo


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

Parameters

$media_id : string: (required)
$contentType : string = self::contentTypes['downloadPhoneNumberMedia'][0]: The value for the Content-Type header. Check self::contentTypes['downloadPhoneNumberMedia'] 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)

exportPhoneNumbersCsv()

Operation exportPhoneNumbersCsv


    public
                    exportPhoneNumbersCsv([string $contentType = self::contentTypes['exportPhoneNumbersCsv'][0] ]) : void

Export phone numbers CSV

Parameters

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

Return values

void —

exportPhoneNumbersCsvAsync()

Operation exportPhoneNumbersCsvAsync


    public
                    exportPhoneNumbersCsvAsync([string $contentType = self::contentTypes['exportPhoneNumbersCsv'][0] ]) : PromiseInterface

Export phone numbers CSV

Parameters

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

Return values

PromiseInterface —

exportPhoneNumbersCsvAsyncWithHttpInfo()

Operation exportPhoneNumbersCsvAsyncWithHttpInfo


    public
                    exportPhoneNumbersCsvAsyncWithHttpInfo([string $contentType = self::contentTypes['exportPhoneNumbersCsv'][0] ]) : PromiseInterface

Export phone numbers CSV

Parameters

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

Return values

PromiseInterface —

exportPhoneNumbersCsvRequest()

Create request for operation 'exportPhoneNumbersCsv'


    public
                    exportPhoneNumbersCsvRequest([string $contentType = self::contentTypes['exportPhoneNumbersCsv'][0] ]) : Request

Parameters

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

Return values

Request —

exportPhoneNumbersCsvWithHttpInfo()

Operation exportPhoneNumbersCsvWithHttpInfo


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

Export phone numbers CSV

Parameters

$contentType : string = self::contentTypes['exportPhoneNumbersCsv'][0]: The value for the Content-Type header. Check self::contentTypes['exportPhoneNumbersCsv'] 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)

getAllPhoneMessageThreads()

Operation getAllPhoneMessageThreads


    public
                    getAllPhoneMessageThreads(int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getAllPhoneMessageThreads'][0] ]) : PagePhoneMessageThreadProjection

Get the latest messages for all phones

Parameters

$page : int: page (optional, default to 0)
$size : int = 20: size (optional, default to 20)
$contentType : string = self::contentTypes['getAllPhoneMessageThreads'][0]: The value for the Content-Type header. Check self::contentTypes['getAllPhoneMessageThreads'] to see the possible values for this operation

Return values

PagePhoneMessageThreadProjection —

getAllPhoneMessageThreadsAsync()

Operation getAllPhoneMessageThreadsAsync


    public
                    getAllPhoneMessageThreadsAsync(int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getAllPhoneMessageThreads'][0] ]) : PromiseInterface

Get the latest messages for all phones

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['getAllPhoneMessageThreads'][0]: The value for the Content-Type header. Check self::contentTypes['getAllPhoneMessageThreads'] to see the possible values for this operation

Return values

PromiseInterface —

getAllPhoneMessageThreadsAsyncWithHttpInfo()

Operation getAllPhoneMessageThreadsAsyncWithHttpInfo


    public
                    getAllPhoneMessageThreadsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getAllPhoneMessageThreads'][0] ]) : PromiseInterface

Get the latest messages for all phones

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['getAllPhoneMessageThreads'][0]: The value for the Content-Type header. Check self::contentTypes['getAllPhoneMessageThreads'] to see the possible values for this operation

Return values

PromiseInterface —

getAllPhoneMessageThreadsRequest()

Create request for operation 'getAllPhoneMessageThreads'


    public
                    getAllPhoneMessageThreadsRequest(int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getAllPhoneMessageThreads'][0] ]) : Request

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['getAllPhoneMessageThreads'][0]: The value for the Content-Type header. Check self::contentTypes['getAllPhoneMessageThreads'] to see the possible values for this operation

Return values

Request —

getAllPhoneMessageThreadsWithHttpInfo()

Operation getAllPhoneMessageThreadsWithHttpInfo


    public
                    getAllPhoneMessageThreadsWithHttpInfo(int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getAllPhoneMessageThreads'][0] ]) : array<string|int, mixed>

Get the latest messages for all phones

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['getAllPhoneMessageThreads'][0]: The value for the Content-Type header. Check self::contentTypes['getAllPhoneMessageThreads'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

getAllPhoneNumberReleases()

Operation getAllPhoneNumberReleases


    public
                    getAllPhoneNumberReleases(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getAllPhoneNumberReleases'][0] ]) : PagePhoneNumberReleaseProjection

Get all phone number releases

Parameters

$page : int: page (optional, default to 0)
$size : int = 20: size (optional, default to 20)
$sort : string = 'DESC': Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
$contentType : string = self::contentTypes['getAllPhoneNumberReleases'][0]: The value for the Content-Type header. Check self::contentTypes['getAllPhoneNumberReleases'] to see the possible values for this operation

Return values

PagePhoneNumberReleaseProjection —

getAllPhoneNumberReleasesAsync()

Operation getAllPhoneNumberReleasesAsync


    public
                    getAllPhoneNumberReleasesAsync(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getAllPhoneNumberReleases'][0] ]) : PromiseInterface

Get all phone number releases

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
$contentType : string = self::contentTypes['getAllPhoneNumberReleases'][0]: The value for the Content-Type header. Check self::contentTypes['getAllPhoneNumberReleases'] to see the possible values for this operation

Return values

PromiseInterface —

getAllPhoneNumberReleasesAsyncWithHttpInfo()

Operation getAllPhoneNumberReleasesAsyncWithHttpInfo


    public
                    getAllPhoneNumberReleasesAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getAllPhoneNumberReleases'][0] ]) : PromiseInterface

Get all phone number releases

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
$contentType : string = self::contentTypes['getAllPhoneNumberReleases'][0]: The value for the Content-Type header. Check self::contentTypes['getAllPhoneNumberReleases'] to see the possible values for this operation

Return values

PromiseInterface —

getAllPhoneNumberReleasesRequest()

Create request for operation 'getAllPhoneNumberReleases'


    public
                    getAllPhoneNumberReleasesRequest(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getAllPhoneNumberReleases'][0] ]) : Request

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
$contentType : string = self::contentTypes['getAllPhoneNumberReleases'][0]: The value for the Content-Type header. Check self::contentTypes['getAllPhoneNumberReleases'] to see the possible values for this operation

Return values

Request —

getAllPhoneNumberReleasesWithHttpInfo()

Operation getAllPhoneNumberReleasesWithHttpInfo


    public
                    getAllPhoneNumberReleasesWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getAllPhoneNumberReleases'][0] ]) : array<string|int, mixed>

Get all phone number releases

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
$contentType : string = self::contentTypes['getAllPhoneNumberReleases'][0]: The value for the Content-Type header. Check self::contentTypes['getAllPhoneNumberReleases'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

getOrCreatePhonePool()

Operation getOrCreatePhonePool


    public
                    getOrCreatePhonePool(GetOrCreatePhonePoolOptions $get_or_create_phone_pool_options[, string $contentType = self::contentTypes['getOrCreatePhonePool'][0] ]) : PhonePoolDetailDto

Get or create phone pool

Parameters

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

Return values

PhonePoolDetailDto —

getOrCreatePhonePoolAsync()

Operation getOrCreatePhonePoolAsync


    public
                    getOrCreatePhonePoolAsync(GetOrCreatePhonePoolOptions $get_or_create_phone_pool_options[, string $contentType = self::contentTypes['getOrCreatePhonePool'][0] ]) : PromiseInterface

Get or create phone pool

Parameters

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

Return values

PromiseInterface —

getOrCreatePhonePoolAsyncWithHttpInfo()

Operation getOrCreatePhonePoolAsyncWithHttpInfo


    public
                    getOrCreatePhonePoolAsyncWithHttpInfo(GetOrCreatePhonePoolOptions $get_or_create_phone_pool_options[, string $contentType = self::contentTypes['getOrCreatePhonePool'][0] ]) : PromiseInterface

Get or create phone pool

Parameters

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

Return values

PromiseInterface —

getOrCreatePhonePoolRequest()

Create request for operation 'getOrCreatePhonePool'


    public
                    getOrCreatePhonePoolRequest(GetOrCreatePhonePoolOptions $get_or_create_phone_pool_options[, string $contentType = self::contentTypes['getOrCreatePhonePool'][0] ]) : Request

Parameters

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

Return values

Request —

getOrCreatePhonePoolWithHttpInfo()

Operation getOrCreatePhonePoolWithHttpInfo


    public
                    getOrCreatePhonePoolWithHttpInfo(GetOrCreatePhonePoolOptions $get_or_create_phone_pool_options[, string $contentType = self::contentTypes['getOrCreatePhonePool'][0] ]) : array<string|int, mixed>

Get or create phone pool

Parameters

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

Return values

array<string|int, mixed> —

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

getPhoneMessageThreadItems()

Operation getPhoneMessageThreadItems


    public
                    getPhoneMessageThreadItems(string $phone_number_id, string $other_number, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getPhoneMessageThreadItems'][0] ]) : PagePhoneMessageThreadItemProjection

Get messages in a phone thread

Parameters

$phone_number_id : string: phone_number_id (required)
$other_number : string: other_number (required)
$page : int: page (optional, default to 0)
$size : int = 20: size (optional, default to 20)
$contentType : string = self::contentTypes['getPhoneMessageThreadItems'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneMessageThreadItems'] to see the possible values for this operation

Return values

PagePhoneMessageThreadItemProjection —

getPhoneMessageThreadItemsAsync()

Operation getPhoneMessageThreadItemsAsync


    public
                    getPhoneMessageThreadItemsAsync(string $phone_number_id, string $other_number, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getPhoneMessageThreadItems'][0] ]) : PromiseInterface

Get messages in a phone thread

Parameters

$phone_number_id : string: (required)
$other_number : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['getPhoneMessageThreadItems'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneMessageThreadItems'] to see the possible values for this operation

Return values

PromiseInterface —

getPhoneMessageThreadItemsAsyncWithHttpInfo()

Operation getPhoneMessageThreadItemsAsyncWithHttpInfo


    public
                    getPhoneMessageThreadItemsAsyncWithHttpInfo(string $phone_number_id, string $other_number, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getPhoneMessageThreadItems'][0] ]) : PromiseInterface

Get messages in a phone thread

Parameters

$phone_number_id : string: (required)
$other_number : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['getPhoneMessageThreadItems'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneMessageThreadItems'] to see the possible values for this operation

Return values

PromiseInterface —

getPhoneMessageThreadItemsRequest()

Create request for operation 'getPhoneMessageThreadItems'


    public
                    getPhoneMessageThreadItemsRequest(string $phone_number_id, string $other_number, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getPhoneMessageThreadItems'][0] ]) : Request

Parameters

$phone_number_id : string: (required)
$other_number : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['getPhoneMessageThreadItems'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneMessageThreadItems'] to see the possible values for this operation

Return values

Request —

getPhoneMessageThreadItemsWithHttpInfo()

Operation getPhoneMessageThreadItemsWithHttpInfo


    public
                    getPhoneMessageThreadItemsWithHttpInfo(string $phone_number_id, string $other_number, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getPhoneMessageThreadItems'][0] ]) : array<string|int, mixed>

Get messages in a phone thread

Parameters

$phone_number_id : string: (required)
$other_number : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['getPhoneMessageThreadItems'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneMessageThreadItems'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

getPhoneMessageThreads()

Operation getPhoneMessageThreads


    public
                    getPhoneMessageThreads(string $phone_number_id, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getPhoneMessageThreads'][0] ]) : PagePhoneMessageThreadProjection

Get the latest message preview for a thread

Parameters

$phone_number_id : string: phone_number_id (required)
$page : int: page (optional, default to 0)
$size : int = 20: size (optional, default to 20)
$contentType : string = self::contentTypes['getPhoneMessageThreads'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneMessageThreads'] to see the possible values for this operation

Return values

PagePhoneMessageThreadProjection —

getPhoneMessageThreadsAsync()

Operation getPhoneMessageThreadsAsync


    public
                    getPhoneMessageThreadsAsync(string $phone_number_id, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getPhoneMessageThreads'][0] ]) : PromiseInterface

Get the latest message preview for a thread

Parameters

$phone_number_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['getPhoneMessageThreads'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneMessageThreads'] to see the possible values for this operation

Return values

PromiseInterface —

getPhoneMessageThreadsAsyncWithHttpInfo()

Operation getPhoneMessageThreadsAsyncWithHttpInfo


    public
                    getPhoneMessageThreadsAsyncWithHttpInfo(string $phone_number_id, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getPhoneMessageThreads'][0] ]) : PromiseInterface

Get the latest message preview for a thread

Parameters

$phone_number_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['getPhoneMessageThreads'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneMessageThreads'] to see the possible values for this operation

Return values

PromiseInterface —

getPhoneMessageThreadsRequest()

Create request for operation 'getPhoneMessageThreads'


    public
                    getPhoneMessageThreadsRequest(string $phone_number_id, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getPhoneMessageThreads'][0] ]) : Request

Parameters

$phone_number_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['getPhoneMessageThreads'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneMessageThreads'] to see the possible values for this operation

Return values

Request —

getPhoneMessageThreadsWithHttpInfo()

Operation getPhoneMessageThreadsWithHttpInfo


    public
                    getPhoneMessageThreadsWithHttpInfo(string $phone_number_id, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getPhoneMessageThreads'][0] ]) : array<string|int, mixed>

Get the latest message preview for a thread

Parameters

$phone_number_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['getPhoneMessageThreads'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneMessageThreads'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

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 —

getPhoneNumberByName()

Operation getPhoneNumberByName


    public
                    getPhoneNumberByName(string $name[, string $contentType = self::contentTypes['getPhoneNumberByName'][0] ]) : PhoneNumberDto

Get a phone number by name

Parameters

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

Return values

PhoneNumberDto —

getPhoneNumberByNameAsync()

Operation getPhoneNumberByNameAsync


    public
                    getPhoneNumberByNameAsync(string $name[, string $contentType = self::contentTypes['getPhoneNumberByName'][0] ]) : PromiseInterface

Get a phone number by name

Parameters

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

Return values

PromiseInterface —

getPhoneNumberByNameAsyncWithHttpInfo()

Operation getPhoneNumberByNameAsyncWithHttpInfo


    public
                    getPhoneNumberByNameAsyncWithHttpInfo(string $name[, string $contentType = self::contentTypes['getPhoneNumberByName'][0] ]) : PromiseInterface

Get a phone number by name

Parameters

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

Return values

PromiseInterface —

getPhoneNumberByNameRequest()

Create request for operation 'getPhoneNumberByName'


    public
                    getPhoneNumberByNameRequest(string $name[, string $contentType = self::contentTypes['getPhoneNumberByName'][0] ]) : Request

Parameters

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

Return values

Request —

getPhoneNumberByNameWithHttpInfo()

Operation getPhoneNumberByNameWithHttpInfo


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

Get a phone number by name

Parameters

$name : string: (required)
$contentType : string = self::contentTypes['getPhoneNumberByName'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneNumberByName'] 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)

getPhoneNumberByPhoneNumber()

Operation getPhoneNumberByPhoneNumber


    public
                    getPhoneNumberByPhoneNumber(string $phone_number[, string $contentType = self::contentTypes['getPhoneNumberByPhoneNumber'][0] ]) : PhoneNumberDto

Get a phone number by phone number

Parameters

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

Return values

PhoneNumberDto —

getPhoneNumberByPhoneNumberAsync()

Operation getPhoneNumberByPhoneNumberAsync


    public
                    getPhoneNumberByPhoneNumberAsync(string $phone_number[, string $contentType = self::contentTypes['getPhoneNumberByPhoneNumber'][0] ]) : PromiseInterface

Get a phone number by phone number

Parameters

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

Return values

PromiseInterface —

getPhoneNumberByPhoneNumberAsyncWithHttpInfo()

Operation getPhoneNumberByPhoneNumberAsyncWithHttpInfo


    public
                    getPhoneNumberByPhoneNumberAsyncWithHttpInfo(string $phone_number[, string $contentType = self::contentTypes['getPhoneNumberByPhoneNumber'][0] ]) : PromiseInterface

Get a phone number by phone number

Parameters

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

Return values

PromiseInterface —

getPhoneNumberByPhoneNumberRequest()

Create request for operation 'getPhoneNumberByPhoneNumber'


    public
                    getPhoneNumberByPhoneNumberRequest(string $phone_number[, string $contentType = self::contentTypes['getPhoneNumberByPhoneNumber'][0] ]) : Request

Parameters

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

Return values

Request —

getPhoneNumberByPhoneNumberWithHttpInfo()

Operation getPhoneNumberByPhoneNumberWithHttpInfo


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

Get a phone number by phone number

Parameters

$phone_number : string: (required)
$contentType : string = self::contentTypes['getPhoneNumberByPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneNumberByPhoneNumber'] 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)

getPhoneNumberLineTypeIntelligence()

Operation getPhoneNumberLineTypeIntelligence


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

Get line type intelligence for a phone number

Parameters

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

Return values

PhoneNumberLineTypeLookupDto —

getPhoneNumberLineTypeIntelligenceAsync()

Operation getPhoneNumberLineTypeIntelligenceAsync


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

Get line type intelligence for a phone number

Parameters

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

Return values

PromiseInterface —

getPhoneNumberLineTypeIntelligenceAsyncWithHttpInfo()

Operation getPhoneNumberLineTypeIntelligenceAsyncWithHttpInfo


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

Get line type intelligence for a phone number

Parameters

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

Return values

PromiseInterface —

getPhoneNumberLineTypeIntelligenceRequest()

Create request for operation 'getPhoneNumberLineTypeIntelligence'


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

Parameters

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

Return values

Request —

getPhoneNumberLineTypeIntelligenceWithHttpInfo()

Operation getPhoneNumberLineTypeIntelligenceWithHttpInfo


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

Get line type intelligence for a phone number

Parameters

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

Return values

array<string|int, mixed> —

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

getPhoneNumberMedia()

Operation getPhoneNumberMedia


    public
                    getPhoneNumberMedia(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['getPhoneNumberMedia'][0] ]) : PageSmsMessageMedia

Parameters

$phone_number_id : string: phone_number_id (required)
$page : int: Optional page index in SMS media list pagination (optional, default to 0)
$size : int = 20: Optional page size in SMS media 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 SMS media created after given date time (optional)
$before : DateTime = null: Optional filter SMS media created before given date time (optional)
$search : string = null: Optional search filter (optional)
$contentType : string = self::contentTypes['getPhoneNumberMedia'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneNumberMedia'] to see the possible values for this operation

Return values

PageSmsMessageMedia —

getPhoneNumberMedia1()

Operation getPhoneNumberMedia1


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

Parameters

$page : int: Optional page index in SMS media list pagination (optional, default to 0)
$size : int = 20: Optional page size in SMS media 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 SMS media created after given date time (optional)
$before : DateTime = null: Optional filter SMS media created before given date time (optional)
$search : string = null: Optional search filter (optional)
$contentType : string = self::contentTypes['getPhoneNumberMedia1'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneNumberMedia1'] to see the possible values for this operation

Return values

PageSmsMessageMedia —

getPhoneNumberMedia1Async()

Operation getPhoneNumberMedia1Async


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

Parameters

$page : int: Optional page index in SMS media list pagination (optional, default to 0)
$size : int = 20: Optional page size in SMS media 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 SMS media created after given date time (optional)
$before : DateTime = null: Optional filter SMS media created before given date time (optional)
$search : string = null: Optional search filter (optional)
$contentType : string = self::contentTypes['getPhoneNumberMedia1'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneNumberMedia1'] to see the possible values for this operation

Return values

PromiseInterface —

getPhoneNumberMedia1AsyncWithHttpInfo()

Operation getPhoneNumberMedia1AsyncWithHttpInfo


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

Parameters

$page : int: Optional page index in SMS media list pagination (optional, default to 0)
$size : int = 20: Optional page size in SMS media 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 SMS media created after given date time (optional)
$before : DateTime = null: Optional filter SMS media created before given date time (optional)
$search : string = null: Optional search filter (optional)
$contentType : string = self::contentTypes['getPhoneNumberMedia1'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneNumberMedia1'] to see the possible values for this operation

Return values

PromiseInterface —

getPhoneNumberMedia1Request()

Create request for operation 'getPhoneNumberMedia1'


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

Parameters

$page : int: Optional page index in SMS media list pagination (optional, default to 0)
$size : int = 20: Optional page size in SMS media 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 SMS media created after given date time (optional)
$before : DateTime = null: Optional filter SMS media created before given date time (optional)
$search : string = null: Optional search filter (optional)
$contentType : string = self::contentTypes['getPhoneNumberMedia1'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneNumberMedia1'] to see the possible values for this operation

Return values

Request —

getPhoneNumberMedia1WithHttpInfo()

Operation getPhoneNumberMedia1WithHttpInfo


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

Parameters

$page : int: Optional page index in SMS media list pagination (optional, default to 0)
$size : int = 20: Optional page size in SMS media 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 SMS media created after given date time (optional)
$before : DateTime = null: Optional filter SMS media created before given date time (optional)
$search : string = null: Optional search filter (optional)
$contentType : string = self::contentTypes['getPhoneNumberMedia1'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneNumberMedia1'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

getPhoneNumberMediaAsync()

Operation getPhoneNumberMediaAsync


    public
                    getPhoneNumberMediaAsync(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['getPhoneNumberMedia'][0] ]) : PromiseInterface

Parameters

$phone_number_id : string: (required)
$page : int: Optional page index in SMS media list pagination (optional, default to 0)
$size : int = 20: Optional page size in SMS media 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 SMS media created after given date time (optional)
$before : DateTime = null: Optional filter SMS media created before given date time (optional)
$search : string = null: Optional search filter (optional)
$contentType : string = self::contentTypes['getPhoneNumberMedia'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneNumberMedia'] to see the possible values for this operation

Return values

PromiseInterface —

getPhoneNumberMediaAsyncWithHttpInfo()

Operation getPhoneNumberMediaAsyncWithHttpInfo


    public
                    getPhoneNumberMediaAsyncWithHttpInfo(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['getPhoneNumberMedia'][0] ]) : PromiseInterface

Parameters

$phone_number_id : string: (required)
$page : int: Optional page index in SMS media list pagination (optional, default to 0)
$size : int = 20: Optional page size in SMS media 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 SMS media created after given date time (optional)
$before : DateTime = null: Optional filter SMS media created before given date time (optional)
$search : string = null: Optional search filter (optional)
$contentType : string = self::contentTypes['getPhoneNumberMedia'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneNumberMedia'] to see the possible values for this operation

Return values

PromiseInterface —

getPhoneNumberMediaById()

Operation getPhoneNumberMediaById


    public
                    getPhoneNumberMediaById(string $media_id[, string $contentType = self::contentTypes['getPhoneNumberMediaById'][0] ]) : SmsMessageMediaDto

Parameters

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

Return values

SmsMessageMediaDto —

getPhoneNumberMediaByIdAsync()

Operation getPhoneNumberMediaByIdAsync


    public
                    getPhoneNumberMediaByIdAsync(string $media_id[, string $contentType = self::contentTypes['getPhoneNumberMediaById'][0] ]) : PromiseInterface

Parameters

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

Return values

PromiseInterface —

getPhoneNumberMediaByIdAsyncWithHttpInfo()

Operation getPhoneNumberMediaByIdAsyncWithHttpInfo


    public
                    getPhoneNumberMediaByIdAsyncWithHttpInfo(string $media_id[, string $contentType = self::contentTypes['getPhoneNumberMediaById'][0] ]) : PromiseInterface

Parameters

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

Return values

PromiseInterface —

getPhoneNumberMediaByIdRequest()

Create request for operation 'getPhoneNumberMediaById'


    public
                    getPhoneNumberMediaByIdRequest(string $media_id[, string $contentType = self::contentTypes['getPhoneNumberMediaById'][0] ]) : Request

Parameters

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

Return values

Request —

getPhoneNumberMediaByIdWithHttpInfo()

Operation getPhoneNumberMediaByIdWithHttpInfo


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

Parameters

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

Return values

array<string|int, mixed> —

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

getPhoneNumberMediaRequest()

Create request for operation 'getPhoneNumberMedia'


    public
                    getPhoneNumberMediaRequest(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['getPhoneNumberMedia'][0] ]) : Request

Parameters

$phone_number_id : string: (required)
$page : int: Optional page index in SMS media list pagination (optional, default to 0)
$size : int = 20: Optional page size in SMS media 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 SMS media created after given date time (optional)
$before : DateTime = null: Optional filter SMS media created before given date time (optional)
$search : string = null: Optional search filter (optional)
$contentType : string = self::contentTypes['getPhoneNumberMedia'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneNumberMedia'] to see the possible values for this operation

Return values

Request —

getPhoneNumberMediaWithHttpInfo()

Operation getPhoneNumberMediaWithHttpInfo


    public
                    getPhoneNumberMediaWithHttpInfo(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['getPhoneNumberMedia'][0] ]) : array<string|int, mixed>

Parameters

$phone_number_id : string: (required)
$page : int: Optional page index in SMS media list pagination (optional, default to 0)
$size : int = 20: Optional page size in SMS media 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 SMS media created after given date time (optional)
$before : DateTime = null: Optional filter SMS media created before given date time (optional)
$search : string = null: Optional search filter (optional)
$contentType : string = self::contentTypes['getPhoneNumberMedia'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneNumberMedia'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

getPhoneNumberRelease()

Operation getPhoneNumberRelease


    public
                    getPhoneNumberRelease(string $release_id[, string $contentType = self::contentTypes['getPhoneNumberRelease'][0] ]) : PhoneNumberReleaseProjection

Get phone number release

Parameters

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

Return values

PhoneNumberReleaseProjection —

getPhoneNumberReleaseAsync()

Operation getPhoneNumberReleaseAsync


    public
                    getPhoneNumberReleaseAsync(string $release_id[, string $contentType = self::contentTypes['getPhoneNumberRelease'][0] ]) : PromiseInterface

Get phone number release

Parameters

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

Return values

PromiseInterface —

getPhoneNumberReleaseAsyncWithHttpInfo()

Operation getPhoneNumberReleaseAsyncWithHttpInfo


    public
                    getPhoneNumberReleaseAsyncWithHttpInfo(string $release_id[, string $contentType = self::contentTypes['getPhoneNumberRelease'][0] ]) : PromiseInterface

Get phone number release

Parameters

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

Return values

PromiseInterface —

getPhoneNumberReleaseRequest()

Create request for operation 'getPhoneNumberRelease'


    public
                    getPhoneNumberReleaseRequest(string $release_id[, string $contentType = self::contentTypes['getPhoneNumberRelease'][0] ]) : Request

Parameters

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

Return values

Request —

getPhoneNumberReleaseWithHttpInfo()

Operation getPhoneNumberReleaseWithHttpInfo


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

Get phone number release

Parameters

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

Return values

array<string|int, mixed> —

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

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 ][, string $line_type = null ][, string $carrier_name = null ][, string $mobile_country_code = null ][, string $mobile_network_code = null ][, string $provider_label = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, array<string|int, string> $tag = 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)
$line_type : string = null: Optional line type filter (optional)
$carrier_name : string = null: Optional carrier name filter (optional)
$mobile_country_code : string = null: Optional mobile country code filter (optional)
$mobile_network_code : string = null: Optional mobile network code filter (optional)
$provider_label : string = null: Optional provider label filter such as T1 or T2 (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)
$tag : array<string|int, string> = null: Optional tags to filter by. A phone must include all provided tags (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 ][, string $line_type = null ][, string $carrier_name = null ][, string $mobile_country_code = null ][, string $mobile_network_code = null ][, string $provider_label = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, array<string|int, string> $tag = 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)
$line_type : string = null: Optional line type filter (optional)
$carrier_name : string = null: Optional carrier name filter (optional)
$mobile_country_code : string = null: Optional mobile country code filter (optional)
$mobile_network_code : string = null: Optional mobile network code filter (optional)
$provider_label : string = null: Optional provider label filter such as T1 or T2 (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)
$tag : array<string|int, string> = null: Optional tags to filter by. A phone must include all provided tags (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 ][, string $line_type = null ][, string $carrier_name = null ][, string $mobile_country_code = null ][, string $mobile_network_code = null ][, string $provider_label = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, array<string|int, string> $tag = 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)
$line_type : string = null: Optional line type filter (optional)
$carrier_name : string = null: Optional carrier name filter (optional)
$mobile_country_code : string = null: Optional mobile country code filter (optional)
$mobile_network_code : string = null: Optional mobile network code filter (optional)
$provider_label : string = null: Optional provider label filter such as T1 or T2 (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)
$tag : array<string|int, string> = null: Optional tags to filter by. A phone must include all provided tags (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 ][, string $line_type = null ][, string $carrier_name = null ][, string $mobile_country_code = null ][, string $mobile_network_code = null ][, string $provider_label = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, array<string|int, string> $tag = 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)
$line_type : string = null: Optional line type filter (optional)
$carrier_name : string = null: Optional carrier name filter (optional)
$mobile_country_code : string = null: Optional mobile country code filter (optional)
$mobile_network_code : string = null: Optional mobile network code filter (optional)
$provider_label : string = null: Optional provider label filter such as T1 or T2 (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)
$tag : array<string|int, string> = null: Optional tags to filter by. A phone must include all provided tags (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 ][, string $line_type = null ][, string $carrier_name = null ][, string $mobile_country_code = null ][, string $mobile_network_code = null ][, string $provider_label = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, array<string|int, string> $tag = 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)
$line_type : string = null: Optional line type filter (optional)
$carrier_name : string = null: Optional carrier name filter (optional)
$mobile_country_code : string = null: Optional mobile country code filter (optional)
$mobile_network_code : string = null: Optional mobile network code filter (optional)
$provider_label : string = null: Optional provider label filter such as T1 or T2 (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)
$tag : array<string|int, string> = null: Optional tags to filter by. A phone must include all provided tags (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)

getPhoneNumberTags()

Operation getPhoneNumberTags


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

Get phone number tags

Parameters

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

Return values

array<string|int, string> —

getPhoneNumberTagsAsync()

Operation getPhoneNumberTagsAsync


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

Get phone number tags

Parameters

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

Return values

PromiseInterface —

getPhoneNumberTagsAsyncWithHttpInfo()

Operation getPhoneNumberTagsAsyncWithHttpInfo


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

Get phone number tags

Parameters

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

Return values

PromiseInterface —

getPhoneNumberTagsRequest()

Create request for operation 'getPhoneNumberTags'


    public
                    getPhoneNumberTagsRequest(string $phone_number_id[, string $contentType = self::contentTypes['getPhoneNumberTags'][0] ]) : Request

Parameters

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

Return values

Request —

getPhoneNumberTagsWithHttpInfo()

Operation getPhoneNumberTagsWithHttpInfo


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

Get phone number tags

Parameters

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

Return values

array<string|int, mixed> —

of string[], 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)

getPhonePool()

Operation getPhonePool


    public
                    getPhonePool(string $pool_id[, string $contentType = self::contentTypes['getPhonePool'][0] ]) : PhonePoolDetailDto

Get phone pool

Parameters

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

Return values

PhonePoolDetailDto —

getPhonePoolAsync()

Operation getPhonePoolAsync


    public
                    getPhonePoolAsync(string $pool_id[, string $contentType = self::contentTypes['getPhonePool'][0] ]) : PromiseInterface

Get phone pool

Parameters

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

Return values

PromiseInterface —

getPhonePoolAsyncWithHttpInfo()

Operation getPhonePoolAsyncWithHttpInfo


    public
                    getPhonePoolAsyncWithHttpInfo(string $pool_id[, string $contentType = self::contentTypes['getPhonePool'][0] ]) : PromiseInterface

Get phone pool

Parameters

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

Return values

PromiseInterface —

getPhonePoolByName()

Operation getPhonePoolByName


    public
                    getPhonePoolByName(string $name[, string $contentType = self::contentTypes['getPhonePoolByName'][0] ]) : PhonePoolDetailDto

Get phone pool by name

Parameters

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

Return values

PhonePoolDetailDto —

getPhonePoolByNameAsync()

Operation getPhonePoolByNameAsync


    public
                    getPhonePoolByNameAsync(string $name[, string $contentType = self::contentTypes['getPhonePoolByName'][0] ]) : PromiseInterface

Get phone pool by name

Parameters

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

Return values

PromiseInterface —

getPhonePoolByNameAsyncWithHttpInfo()

Operation getPhonePoolByNameAsyncWithHttpInfo


    public
                    getPhonePoolByNameAsyncWithHttpInfo(string $name[, string $contentType = self::contentTypes['getPhonePoolByName'][0] ]) : PromiseInterface

Get phone pool by name

Parameters

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

Return values

PromiseInterface —

getPhonePoolByNameRequest()

Create request for operation 'getPhonePoolByName'


    public
                    getPhonePoolByNameRequest(string $name[, string $contentType = self::contentTypes['getPhonePoolByName'][0] ]) : Request

Parameters

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

Return values

Request —

getPhonePoolByNameWithHttpInfo()

Operation getPhonePoolByNameWithHttpInfo


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

Get phone pool by name

Parameters

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

Return values

array<string|int, mixed> —

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

getPhonePoolRequest()

Create request for operation 'getPhonePool'


    public
                    getPhonePoolRequest(string $pool_id[, string $contentType = self::contentTypes['getPhonePool'][0] ]) : Request

Parameters

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

Return values

Request —

getPhonePools()

Operation getPhonePools


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

Get phone pools

Parameters

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

Return values

array<string|int, PhonePoolDto> —

getPhonePoolsAsync()

Operation getPhonePoolsAsync


    public
                    getPhonePoolsAsync([string $contentType = self::contentTypes['getPhonePools'][0] ]) : PromiseInterface

Get phone pools

Parameters

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

Return values

PromiseInterface —

getPhonePoolsAsyncWithHttpInfo()

Operation getPhonePoolsAsyncWithHttpInfo


    public
                    getPhonePoolsAsyncWithHttpInfo([string $contentType = self::contentTypes['getPhonePools'][0] ]) : PromiseInterface

Get phone pools

Parameters

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

Return values

PromiseInterface —

getPhonePoolsRequest()

Create request for operation 'getPhonePools'


    public
                    getPhonePoolsRequest([string $contentType = self::contentTypes['getPhonePools'][0] ]) : Request

Parameters

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

Return values

Request —

getPhonePoolsWithHttpInfo()

Operation getPhonePoolsWithHttpInfo


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

Get phone pools

Parameters

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

Return values

array<string|int, mixed> —

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

getPhonePoolWithHttpInfo()

Operation getPhonePoolWithHttpInfo


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

Get phone pool

Parameters

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

Return values

array<string|int, mixed> —

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

getPhoneProvisioningCapabilities()

Operation getPhoneProvisioningCapabilities


    public
                    getPhoneProvisioningCapabilities(string $phone_country[, string $provider_label = null ][, string $contentType = self::contentTypes['getPhoneProvisioningCapabilities'][0] ]) : PhoneProviderCapabilitiesResult

Get phone provisioning capabilities

Parameters

$phone_country : string: phone_country (required)
$provider_label : string = null: provider_label (optional)
$contentType : string = self::contentTypes['getPhoneProvisioningCapabilities'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneProvisioningCapabilities'] to see the possible values for this operation

Return values

PhoneProviderCapabilitiesResult —

getPhoneProvisioningCapabilitiesAsync()

Operation getPhoneProvisioningCapabilitiesAsync


    public
                    getPhoneProvisioningCapabilitiesAsync(string $phone_country[, string $provider_label = null ][, string $contentType = self::contentTypes['getPhoneProvisioningCapabilities'][0] ]) : PromiseInterface

Get phone provisioning capabilities

Parameters

$phone_country : string: (required)
$provider_label : string = null: (optional)
$contentType : string = self::contentTypes['getPhoneProvisioningCapabilities'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneProvisioningCapabilities'] to see the possible values for this operation

Return values

PromiseInterface —

getPhoneProvisioningCapabilitiesAsyncWithHttpInfo()

Operation getPhoneProvisioningCapabilitiesAsyncWithHttpInfo


    public
                    getPhoneProvisioningCapabilitiesAsyncWithHttpInfo(string $phone_country[, string $provider_label = null ][, string $contentType = self::contentTypes['getPhoneProvisioningCapabilities'][0] ]) : PromiseInterface

Get phone provisioning capabilities

Parameters

$phone_country : string: (required)
$provider_label : string = null: (optional)
$contentType : string = self::contentTypes['getPhoneProvisioningCapabilities'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneProvisioningCapabilities'] to see the possible values for this operation

Return values

PromiseInterface —

getPhoneProvisioningCapabilitiesRequest()

Create request for operation 'getPhoneProvisioningCapabilities'


    public
                    getPhoneProvisioningCapabilitiesRequest(string $phone_country[, string $provider_label = null ][, string $contentType = self::contentTypes['getPhoneProvisioningCapabilities'][0] ]) : Request

Parameters

$phone_country : string: (required)
$provider_label : string = null: (optional)
$contentType : string = self::contentTypes['getPhoneProvisioningCapabilities'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneProvisioningCapabilities'] to see the possible values for this operation

Return values

Request —

getPhoneProvisioningCapabilitiesWithHttpInfo()

Operation getPhoneProvisioningCapabilitiesWithHttpInfo


    public
                    getPhoneProvisioningCapabilitiesWithHttpInfo(string $phone_country[, string $provider_label = null ][, string $contentType = self::contentTypes['getPhoneProvisioningCapabilities'][0] ]) : array<string|int, mixed>

Get phone provisioning capabilities

Parameters

$phone_country : string: (required)
$provider_label : string = null: (optional)
$contentType : string = self::contentTypes['getPhoneProvisioningCapabilities'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneProvisioningCapabilities'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

getPhoneProvisioningJob()

Operation getPhoneProvisioningJob


    public
                    getPhoneProvisioningJob(string $job_id[, string $contentType = self::contentTypes['getPhoneProvisioningJob'][0] ]) : PhoneProvisioningJobDto

Get phone provisioning job

Parameters

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

Return values

PhoneProvisioningJobDto —

getPhoneProvisioningJobAsync()

Operation getPhoneProvisioningJobAsync


    public
                    getPhoneProvisioningJobAsync(string $job_id[, string $contentType = self::contentTypes['getPhoneProvisioningJob'][0] ]) : PromiseInterface

Get phone provisioning job

Parameters

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

Return values

PromiseInterface —

getPhoneProvisioningJobAsyncWithHttpInfo()

Operation getPhoneProvisioningJobAsyncWithHttpInfo


    public
                    getPhoneProvisioningJobAsyncWithHttpInfo(string $job_id[, string $contentType = self::contentTypes['getPhoneProvisioningJob'][0] ]) : PromiseInterface

Get phone provisioning job

Parameters

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

Return values

PromiseInterface —

getPhoneProvisioningJobRequest()

Create request for operation 'getPhoneProvisioningJob'


    public
                    getPhoneProvisioningJobRequest(string $job_id[, string $contentType = self::contentTypes['getPhoneProvisioningJob'][0] ]) : Request

Parameters

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

Return values

Request —

getPhoneProvisioningJobWithHttpInfo()

Operation getPhoneProvisioningJobWithHttpInfo


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

Get phone provisioning job

Parameters

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

Return values

array<string|int, mixed> —

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

getPhoneSmsPrepaidCredit()

Operation getPhoneSmsPrepaidCredit


    public
                    getPhoneSmsPrepaidCredit(string $credit_id[, string $contentType = self::contentTypes['getPhoneSmsPrepaidCredit'][0] ]) : PhoneSmsPrepaidCreditDto

Get SMS prepaid credit

Parameters

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

Return values

PhoneSmsPrepaidCreditDto —

getPhoneSmsPrepaidCreditAsync()

Operation getPhoneSmsPrepaidCreditAsync


    public
                    getPhoneSmsPrepaidCreditAsync(string $credit_id[, string $contentType = self::contentTypes['getPhoneSmsPrepaidCredit'][0] ]) : PromiseInterface

Get SMS prepaid credit

Parameters

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

Return values

PromiseInterface —

getPhoneSmsPrepaidCreditAsyncWithHttpInfo()

Operation getPhoneSmsPrepaidCreditAsyncWithHttpInfo


    public
                    getPhoneSmsPrepaidCreditAsyncWithHttpInfo(string $credit_id[, string $contentType = self::contentTypes['getPhoneSmsPrepaidCredit'][0] ]) : PromiseInterface

Get SMS prepaid credit

Parameters

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

Return values

PromiseInterface —

getPhoneSmsPrepaidCreditRequest()

Create request for operation 'getPhoneSmsPrepaidCredit'


    public
                    getPhoneSmsPrepaidCreditRequest(string $credit_id[, string $contentType = self::contentTypes['getPhoneSmsPrepaidCredit'][0] ]) : Request

Parameters

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

Return values

Request —

getPhoneSmsPrepaidCredits()

Operation getPhoneSmsPrepaidCredits


    public
                    getPhoneSmsPrepaidCredits([string $contentType = self::contentTypes['getPhoneSmsPrepaidCredits'][0] ]) : PhoneSmsPrepaidCreditsDto

Get SMS prepaid credits

Parameters

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

Return values

PhoneSmsPrepaidCreditsDto —

getPhoneSmsPrepaidCreditsAsync()

Operation getPhoneSmsPrepaidCreditsAsync


    public
                    getPhoneSmsPrepaidCreditsAsync([string $contentType = self::contentTypes['getPhoneSmsPrepaidCredits'][0] ]) : PromiseInterface

Get SMS prepaid credits

Parameters

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

Return values

PromiseInterface —

getPhoneSmsPrepaidCreditsAsyncWithHttpInfo()

Operation getPhoneSmsPrepaidCreditsAsyncWithHttpInfo


    public
                    getPhoneSmsPrepaidCreditsAsyncWithHttpInfo([string $contentType = self::contentTypes['getPhoneSmsPrepaidCredits'][0] ]) : PromiseInterface

Get SMS prepaid credits

Parameters

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

Return values

PromiseInterface —

getPhoneSmsPrepaidCreditsRequest()

Create request for operation 'getPhoneSmsPrepaidCredits'


    public
                    getPhoneSmsPrepaidCreditsRequest([string $contentType = self::contentTypes['getPhoneSmsPrepaidCredits'][0] ]) : Request

Parameters

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

Return values

Request —

getPhoneSmsPrepaidCreditsWithHttpInfo()

Operation getPhoneSmsPrepaidCreditsWithHttpInfo


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

Get SMS prepaid credits

Parameters

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

Return values

array<string|int, mixed> —

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

getPhoneSmsPrepaidCreditWithHttpInfo()

Operation getPhoneSmsPrepaidCreditWithHttpInfo


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

Get SMS prepaid credit

Parameters

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

Return values

array<string|int, mixed> —

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

getPhoneSummary()

Operation getPhoneSummary


    public
                    getPhoneSummary([string $contentType = self::contentTypes['getPhoneSummary'][0] ]) : PhoneSummaryDto

Get phone summary

Parameters

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

Return values

PhoneSummaryDto —

getPhoneSummaryAsync()

Operation getPhoneSummaryAsync


    public
                    getPhoneSummaryAsync([string $contentType = self::contentTypes['getPhoneSummary'][0] ]) : PromiseInterface

Get phone summary

Parameters

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

Return values

PromiseInterface —

getPhoneSummaryAsyncWithHttpInfo()

Operation getPhoneSummaryAsyncWithHttpInfo


    public
                    getPhoneSummaryAsyncWithHttpInfo([string $contentType = self::contentTypes['getPhoneSummary'][0] ]) : PromiseInterface

Get phone summary

Parameters

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

Return values

PromiseInterface —

getPhoneSummaryRequest()

Create request for operation 'getPhoneSummary'


    public
                    getPhoneSummaryRequest([string $contentType = self::contentTypes['getPhoneSummary'][0] ]) : Request

Parameters

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

Return values

Request —

getPhoneSummaryWithHttpInfo()

Operation getPhoneSummaryWithHttpInfo


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

Get phone summary

Parameters

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

Return values

array<string|int, mixed> —

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

getPhoneTags()

Operation getPhoneTags


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

Get phone tags

Parameters

$search : string = null: Optional search filter (optional)
$contentType : string = self::contentTypes['getPhoneTags'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneTags'] to see the possible values for this operation

Return values

array<string|int, string> —

getPhoneTagsAsync()

Operation getPhoneTagsAsync


    public
                    getPhoneTagsAsync([string $search = null ][, string $contentType = self::contentTypes['getPhoneTags'][0] ]) : PromiseInterface

Get phone tags

Parameters

$search : string = null: Optional search filter (optional)
$contentType : string = self::contentTypes['getPhoneTags'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneTags'] to see the possible values for this operation

Return values

PromiseInterface —

getPhoneTagsAsyncWithHttpInfo()

Operation getPhoneTagsAsyncWithHttpInfo


    public
                    getPhoneTagsAsyncWithHttpInfo([string $search = null ][, string $contentType = self::contentTypes['getPhoneTags'][0] ]) : PromiseInterface

Get phone tags

Parameters

$search : string = null: Optional search filter (optional)
$contentType : string = self::contentTypes['getPhoneTags'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneTags'] to see the possible values for this operation

Return values

PromiseInterface —

getPhoneTagsRequest()

Create request for operation 'getPhoneTags'


    public
                    getPhoneTagsRequest([string $search = null ][, string $contentType = self::contentTypes['getPhoneTags'][0] ]) : Request

Parameters

$search : string = null: Optional search filter (optional)
$contentType : string = self::contentTypes['getPhoneTags'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneTags'] to see the possible values for this operation

Return values

Request —

getPhoneTagsWithHttpInfo()

Operation getPhoneTagsWithHttpInfo


    public
                    getPhoneTagsWithHttpInfo([string $search = null ][, string $contentType = self::contentTypes['getPhoneTags'][0] ]) : array<string|int, mixed>

Get phone tags

Parameters

$search : string = null: Optional search filter (optional)
$contentType : string = self::contentTypes['getPhoneTags'][0]: The value for the Content-Type header. Check self::contentTypes['getPhoneTags'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of string[], 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)

reassignPhoneNumberRelease()

Operation reassignPhoneNumberRelease


    public
                    reassignPhoneNumberRelease(string $release_id[, string $contentType = self::contentTypes['reassignPhoneNumberRelease'][0] ]) : PhoneNumberDto

Reassign phone number release

Parameters

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

Return values

PhoneNumberDto —

reassignPhoneNumberReleaseAsync()

Operation reassignPhoneNumberReleaseAsync


    public
                    reassignPhoneNumberReleaseAsync(string $release_id[, string $contentType = self::contentTypes['reassignPhoneNumberRelease'][0] ]) : PromiseInterface

Reassign phone number release

Parameters

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

Return values

PromiseInterface —

reassignPhoneNumberReleaseAsyncWithHttpInfo()

Operation reassignPhoneNumberReleaseAsyncWithHttpInfo


    public
                    reassignPhoneNumberReleaseAsyncWithHttpInfo(string $release_id[, string $contentType = self::contentTypes['reassignPhoneNumberRelease'][0] ]) : PromiseInterface

Reassign phone number release

Parameters

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

Return values

PromiseInterface —

reassignPhoneNumberReleaseRequest()

Create request for operation 'reassignPhoneNumberRelease'


    public
                    reassignPhoneNumberReleaseRequest(string $release_id[, string $contentType = self::contentTypes['reassignPhoneNumberRelease'][0] ]) : Request

Parameters

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

Return values

Request —

reassignPhoneNumberReleaseWithHttpInfo()

Operation reassignPhoneNumberReleaseWithHttpInfo


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

Reassign phone number release

Parameters

$release_id : string: (required)
$contentType : string = self::contentTypes['reassignPhoneNumberRelease'][0]: The value for the Content-Type header. Check self::contentTypes['reassignPhoneNumberRelease'] 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)

releasePhonePoolLease()

Operation releasePhonePoolLease


    public
                    releasePhonePoolLease(string $pool_id, string $lease_id[, string $contentType = self::contentTypes['releasePhonePoolLease'][0] ]) : void

Release phone pool lease

Parameters

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

Return values

void —

releasePhonePoolLeaseAsync()

Operation releasePhonePoolLeaseAsync


    public
                    releasePhonePoolLeaseAsync(string $pool_id, string $lease_id[, string $contentType = self::contentTypes['releasePhonePoolLease'][0] ]) : PromiseInterface

Release phone pool lease

Parameters

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

Return values

PromiseInterface —

releasePhonePoolLeaseAsyncWithHttpInfo()

Operation releasePhonePoolLeaseAsyncWithHttpInfo


    public
                    releasePhonePoolLeaseAsyncWithHttpInfo(string $pool_id, string $lease_id[, string $contentType = self::contentTypes['releasePhonePoolLease'][0] ]) : PromiseInterface

Release phone pool lease

Parameters

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

Return values

PromiseInterface —

releasePhonePoolLeaseRequest()

Create request for operation 'releasePhonePoolLease'


    public
                    releasePhonePoolLeaseRequest(string $pool_id, string $lease_id[, string $contentType = self::contentTypes['releasePhonePoolLease'][0] ]) : Request

Parameters

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

Return values

Request —

releasePhonePoolLeaseWithHttpInfo()

Operation releasePhonePoolLeaseWithHttpInfo


    public
                    releasePhonePoolLeaseWithHttpInfo(string $pool_id, string $lease_id[, string $contentType = self::contentTypes['releasePhonePoolLease'][0] ]) : array<string|int, mixed>

Release phone pool lease

Parameters

$pool_id : string: (required)
$lease_id : string: (required)
$contentType : string = self::contentTypes['releasePhonePoolLease'][0]: The value for the Content-Type header. Check self::contentTypes['releasePhonePoolLease'] 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)

removePhoneNumberFromPhonePool()

Operation removePhoneNumberFromPhonePool


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

Remove phone number from phone pool

Parameters

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

Return values

void —

removePhoneNumberFromPhonePoolAsync()

Operation removePhoneNumberFromPhonePoolAsync


    public
                    removePhoneNumberFromPhonePoolAsync(string $pool_id, string $phone_number_id[, string $contentType = self::contentTypes['removePhoneNumberFromPhonePool'][0] ]) : PromiseInterface

Remove phone number from phone pool

Parameters

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

Return values

PromiseInterface —

removePhoneNumberFromPhonePoolAsyncWithHttpInfo()

Operation removePhoneNumberFromPhonePoolAsyncWithHttpInfo


    public
                    removePhoneNumberFromPhonePoolAsyncWithHttpInfo(string $pool_id, string $phone_number_id[, string $contentType = self::contentTypes['removePhoneNumberFromPhonePool'][0] ]) : PromiseInterface

Remove phone number from phone pool

Parameters

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

Return values

PromiseInterface —

removePhoneNumberFromPhonePoolRequest()

Create request for operation 'removePhoneNumberFromPhonePool'


    public
                    removePhoneNumberFromPhonePoolRequest(string $pool_id, string $phone_number_id[, string $contentType = self::contentTypes['removePhoneNumberFromPhonePool'][0] ]) : Request

Parameters

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

Return values

Request —

removePhoneNumberFromPhonePoolWithHttpInfo()

Operation removePhoneNumberFromPhonePoolWithHttpInfo


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

Remove phone number from phone pool

Parameters

$pool_id : string: (required)
$phone_number_id : string: (required)
$contentType : string = self::contentTypes['removePhoneNumberFromPhonePool'][0]: The value for the Content-Type header. Check self::contentTypes['removePhoneNumberFromPhonePool'] 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)

removePhoneNumberTags()

Operation removePhoneNumberTags


    public
                    removePhoneNumberTags(string $phone_number_id, PhoneNumberTagsOptions $phone_number_tags_options[, string $contentType = self::contentTypes['removePhoneNumberTags'][0] ]) : PhoneNumberDto

Remove phone number tags

Parameters

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

Return values

PhoneNumberDto —

removePhoneNumberTagsAsync()

Operation removePhoneNumberTagsAsync


    public
                    removePhoneNumberTagsAsync(string $phone_number_id, PhoneNumberTagsOptions $phone_number_tags_options[, string $contentType = self::contentTypes['removePhoneNumberTags'][0] ]) : PromiseInterface

Remove phone number tags

Parameters

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

Return values

PromiseInterface —

removePhoneNumberTagsAsyncWithHttpInfo()

Operation removePhoneNumberTagsAsyncWithHttpInfo


    public
                    removePhoneNumberTagsAsyncWithHttpInfo(string $phone_number_id, PhoneNumberTagsOptions $phone_number_tags_options[, string $contentType = self::contentTypes['removePhoneNumberTags'][0] ]) : PromiseInterface

Remove phone number tags

Parameters

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

Return values

PromiseInterface —

removePhoneNumberTagsRequest()

Create request for operation 'removePhoneNumberTags'


    public
                    removePhoneNumberTagsRequest(string $phone_number_id, PhoneNumberTagsOptions $phone_number_tags_options[, string $contentType = self::contentTypes['removePhoneNumberTags'][0] ]) : Request

Parameters

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

Return values

Request —

removePhoneNumberTagsWithHttpInfo()

Operation removePhoneNumberTagsWithHttpInfo


    public
                    removePhoneNumberTagsWithHttpInfo(string $phone_number_id, PhoneNumberTagsOptions $phone_number_tags_options[, string $contentType = self::contentTypes['removePhoneNumberTags'][0] ]) : array<string|int, mixed>

Remove phone number tags

Parameters

$phone_number_id : string: (required)
$phone_number_tags_options : PhoneNumberTagsOptions: (required)
$contentType : string = self::contentTypes['removePhoneNumberTags'][0]: The value for the Content-Type header. Check self::contentTypes['removePhoneNumberTags'] 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)

searchAvailablePhoneNumbers()

Operation searchAvailablePhoneNumbers


    public
                    searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersOptions $search_available_phone_numbers_options[, string $contentType = self::contentTypes['searchAvailablePhoneNumbers'][0] ]) : AvailablePhoneNumbersResult

Search available phone numbers

Parameters

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

Return values

AvailablePhoneNumbersResult —

searchAvailablePhoneNumbersAsync()

Operation searchAvailablePhoneNumbersAsync


    public
                    searchAvailablePhoneNumbersAsync(SearchAvailablePhoneNumbersOptions $search_available_phone_numbers_options[, string $contentType = self::contentTypes['searchAvailablePhoneNumbers'][0] ]) : PromiseInterface

Search available phone numbers

Parameters

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

Return values

PromiseInterface —

searchAvailablePhoneNumbersAsyncWithHttpInfo()

Operation searchAvailablePhoneNumbersAsyncWithHttpInfo


    public
                    searchAvailablePhoneNumbersAsyncWithHttpInfo(SearchAvailablePhoneNumbersOptions $search_available_phone_numbers_options[, string $contentType = self::contentTypes['searchAvailablePhoneNumbers'][0] ]) : PromiseInterface

Search available phone numbers

Parameters

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

Return values

PromiseInterface —

searchAvailablePhoneNumbersRequest()

Create request for operation 'searchAvailablePhoneNumbers'


    public
                    searchAvailablePhoneNumbersRequest(SearchAvailablePhoneNumbersOptions $search_available_phone_numbers_options[, string $contentType = self::contentTypes['searchAvailablePhoneNumbers'][0] ]) : Request

Parameters

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

Return values

Request —

searchAvailablePhoneNumbersWithHttpInfo()

Operation searchAvailablePhoneNumbersWithHttpInfo


    public
                    searchAvailablePhoneNumbersWithHttpInfo(SearchAvailablePhoneNumbersOptions $search_available_phone_numbers_options[, string $contentType = self::contentTypes['searchAvailablePhoneNumbers'][0] ]) : array<string|int, mixed>

Search available phone numbers

Parameters

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

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AvailablePhoneNumbersResult, 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)

setPhoneNumberTags()

Operation setPhoneNumberTags


    public
                    setPhoneNumberTags(string $phone_number_id, PhoneNumberTagsOptions $phone_number_tags_options[, string $contentType = self::contentTypes['setPhoneNumberTags'][0] ]) : PhoneNumberDto

Set phone number tags

Parameters

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

Return values

PhoneNumberDto —

setPhoneNumberTagsAsync()

Operation setPhoneNumberTagsAsync


    public
                    setPhoneNumberTagsAsync(string $phone_number_id, PhoneNumberTagsOptions $phone_number_tags_options[, string $contentType = self::contentTypes['setPhoneNumberTags'][0] ]) : PromiseInterface

Set phone number tags

Parameters

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

Return values

PromiseInterface —

setPhoneNumberTagsAsyncWithHttpInfo()

Operation setPhoneNumberTagsAsyncWithHttpInfo


    public
                    setPhoneNumberTagsAsyncWithHttpInfo(string $phone_number_id, PhoneNumberTagsOptions $phone_number_tags_options[, string $contentType = self::contentTypes['setPhoneNumberTags'][0] ]) : PromiseInterface

Set phone number tags

Parameters

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

Return values

PromiseInterface —

setPhoneNumberTagsRequest()

Create request for operation 'setPhoneNumberTags'


    public
                    setPhoneNumberTagsRequest(string $phone_number_id, PhoneNumberTagsOptions $phone_number_tags_options[, string $contentType = self::contentTypes['setPhoneNumberTags'][0] ]) : Request

Parameters

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

Return values

Request —

setPhoneNumberTagsWithHttpInfo()

Operation setPhoneNumberTagsWithHttpInfo


    public
                    setPhoneNumberTagsWithHttpInfo(string $phone_number_id, PhoneNumberTagsOptions $phone_number_tags_options[, string $contentType = self::contentTypes['setPhoneNumberTags'][0] ]) : array<string|int, mixed>

Set phone number tags

Parameters

$phone_number_id : string: (required)
$phone_number_tags_options : PhoneNumberTagsOptions: (required)
$contentType : string = self::contentTypes['setPhoneNumberTags'][0]: The value for the Content-Type header. Check self::contentTypes['setPhoneNumberTags'] 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)

updatePhonePool()

Operation updatePhonePool


    public
                    updatePhonePool(string $pool_id, UpdatePhonePoolOptions $update_phone_pool_options[, string $contentType = self::contentTypes['updatePhonePool'][0] ]) : PhonePoolDetailDto

Update phone pool

Parameters

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

Return values

PhonePoolDetailDto —

updatePhonePoolAsync()

Operation updatePhonePoolAsync


    public
                    updatePhonePoolAsync(string $pool_id, UpdatePhonePoolOptions $update_phone_pool_options[, string $contentType = self::contentTypes['updatePhonePool'][0] ]) : PromiseInterface

Update phone pool

Parameters

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

Return values

PromiseInterface —

updatePhonePoolAsyncWithHttpInfo()

Operation updatePhonePoolAsyncWithHttpInfo


    public
                    updatePhonePoolAsyncWithHttpInfo(string $pool_id, UpdatePhonePoolOptions $update_phone_pool_options[, string $contentType = self::contentTypes['updatePhonePool'][0] ]) : PromiseInterface

Update phone pool

Parameters

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

Return values

PromiseInterface —

updatePhonePoolRequest()

Create request for operation 'updatePhonePool'


    public
                    updatePhonePoolRequest(string $pool_id, UpdatePhonePoolOptions $update_phone_pool_options[, string $contentType = self::contentTypes['updatePhonePool'][0] ]) : Request

Parameters

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

Return values

Request —

updatePhonePoolWithHttpInfo()

Operation updatePhonePoolWithHttpInfo


    public
                    updatePhonePoolWithHttpInfo(string $pool_id, UpdatePhonePoolOptions $update_phone_pool_options[, string $contentType = self::contentTypes['updatePhonePool'][0] ]) : array<string|int, mixed>

Update phone pool

Parameters

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

Return values

array<string|int, mixed> —

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

acquirePhonePoolLease()

Parameters

Tags

Return values

acquirePhonePoolLeaseAsync()

Parameters

Tags

Return values

acquirePhonePoolLeaseAsyncWithHttpInfo()

Parameters

Tags

Return values

acquirePhonePoolLeaseRequest()

Parameters

Tags

Return values

acquirePhonePoolLeaseWithHttpInfo()

Parameters

Tags

Return values

addAllPhoneNumbersToPhonePool()

Parameters

Tags

Return values

addAllPhoneNumbersToPhonePoolAsync()

Parameters

Tags

Return values

addAllPhoneNumbersToPhonePoolAsyncWithHttpInfo()

Parameters

Tags

Return values

addAllPhoneNumbersToPhonePoolRequest()

Parameters

Tags

Return values

addAllPhoneNumbersToPhonePoolWithHttpInfo()

Parameters

Tags

Return values

addPhoneNumbersToPhonePool()

Parameters

Tags

Return values

addPhoneNumbersToPhonePoolAsync()

Parameters

Tags

Return values

addPhoneNumbersToPhonePoolAsyncWithHttpInfo()

Parameters

Tags

Return values

addPhoneNumbersToPhonePoolRequest()

Parameters

Tags

Return values

addPhoneNumbersToPhonePoolWithHttpInfo()

Parameters

Tags

Return values

addPhoneNumberTags()

Parameters

Tags

Return values

addPhoneNumberTagsAsync()

Parameters

PhoneControllerApi
in package

MailSlurp