Documentation

SearchAvailablePhoneNumbersOptions

in package

• MailSlurp

implements ModelInterface, ArrayAccess, JsonSerializable

SearchAvailablePhoneNumbersOptions Class Doc Comment

Tags

category

Class

description

Search criteria for advanced phone provisioning

author

OpenAPI Generator team

link

https://openapi-generator.tech

implements

\ArrayAccess<string, mixed>

Interfaces, Classes, Traits and Enums

ModelInterface

Interface abstracting model access.

ArrayAccess

JsonSerializable

Table of Contents

DISCRIMINATOR  = null

PHONE_COUNTRY_AU  = 'AU'

PHONE_COUNTRY_CA  = 'CA'

PHONE_COUNTRY_CH  = 'CH'

PHONE_COUNTRY_EE  = 'EE'

PHONE_COUNTRY_FI  = 'FI'

PHONE_COUNTRY_GB  = 'GB'

PHONE_COUNTRY_HK  = 'HK'

PHONE_COUNTRY_IL  = 'IL'

PHONE_COUNTRY_NL  = 'NL'

PHONE_COUNTRY_PL  = 'PL'

PHONE_COUNTRY_PT  = 'PT'

PHONE_COUNTRY_SE  = 'SE'

PHONE_COUNTRY_US  = 'US'

PHONE_VARIANT_LOCAL  = 'LOCAL'

PHONE_VARIANT_MOBILE  = 'MOBILE'

PHONE_VARIANT_TOLL_FREE  = 'TOLL_FREE'

QUALITY_FILTER_ANY  = 'ANY'

QUALITY_FILTER_MOBILE_ONLY  = 'MOBILE_ONLY'

QUALITY_FILTER_NON_VOIP  = 'NON_VOIP'

QUALITY_FILTER_OTP  = 'OTP'

$attributeMap  : array<string|int, string>

Array of attributes where the key is the local name, and the value is the original name

$container  : array<string|int, mixed>

Associative array for storing property values

$getters  : array<string|int, string>

Array of attributes to getter functions (for serialization of requests)

$openAPIFormats  : array<string|int, string>

Array of property to format mappings. Used for (de)serialization

$openAPIModelName  : string

The original name of the model.

$openAPINullables  : array<string|int, mixed>

Array of nullable properties. Used for (de)serialization

$openAPINullablesSetToNull  : array<string|int, mixed>

If a nullable field gets set to null, insert it here

$openAPITypes  : array<string|int, string>

Array of property to type mappings. Used for (de)serialization

$setters  : array<string|int, string>

Array of attributes to setter functions (for deserialization of responses)

__construct()  : mixed

Constructor

__toString()  : string

Gets the string presentation of the object

attributeMap()  : array<string|int, mixed>

Array of attributes where the key is the local name, and the value is the original name

getCarrierName()  : string|null

Gets carrier_name

getLimit()  : int|null

Gets limit

getLineType()  : string|null

Gets line_type

getMobileCountryCode()  : string|null

Gets mobile_country_code

getMobileNetworkCode()  : string|null

Gets mobile_network_code

getModelName()  : string

The original name of the model.

getPhoneCountry()  : string

Gets phone_country

getPhoneCountryAllowableValues()  : array<string|int, string>

Gets allowable values of the enum

getPhoneVariant()  : string|null

Gets phone_variant

getPhoneVariantAllowableValues()  : array<string|int, string>

Gets allowable values of the enum

getProviderLabels()  : array<string|int, string>|null

Gets provider_labels

getQualityFilter()  : string|null

Gets quality_filter

getQualityFilterAllowableValues()  : array<string|int, string>

Gets allowable values of the enum

getters()  : array<string|int, mixed>

Array of attributes to getter functions (for serialization of requests)

isNullable()  : bool

Checks if a property is nullable

isNullableSetToNull()  : bool

Checks if a nullable property is set to null.

jsonSerialize()  : mixed

Serializes the object to a value that can be serialized natively by json_encode().

listInvalidProperties()  : array<string|int, mixed>

Show all the invalid properties with reasons.

offsetExists()  : bool

Returns true if offset exists. False otherwise.

offsetGet()  : mixed|null

Gets offset.

offsetSet()  : void

Sets value based on offset.

offsetUnset()  : void

Unsets offset.

openAPIFormats()  : array<string|int, mixed>

Array of property to format mappings. Used for (de)serialization

openAPITypes()  : array<string|int, mixed>

Array of property to type mappings. Used for (de)serialization

setCarrierName()  : self

Sets carrier_name

setLimit()  : self

Sets limit

setLineType()  : self

Sets line_type

setMobileCountryCode()  : self

Sets mobile_country_code

setMobileNetworkCode()  : self

Sets mobile_network_code

setPhoneCountry()  : self

Sets phone_country

setPhoneVariant()  : self

Sets phone_variant

setProviderLabels()  : self

Sets provider_labels

setQualityFilter()  : self

Sets quality_filter

setters()  : array<string|int, mixed>

Array of attributes to setter functions (for deserialization of responses)

toHeaderValue()  : string

Gets a header-safe presentation of the object

valid()  : bool

Validate all the properties in the model return true if all passed

openAPINullables()  : array<string|int, mixed>

Array of nullable properties

getOpenAPINullablesSetToNull()  : array<string|int, bool>

Array of nullable field names deliberately set to null

setIfExists()  : void

Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array

setOpenAPINullablesSetToNull()  : void

Setter - Array of nullable field names deliberately set to null