Documentation

DeliverabilityFailurePhoneDimensionHotspotDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

DeliverabilityFailurePhoneDimensionHotspotDto Class Doc Comment

Tags
category

Class

description

Most common failing phone country/variant dimensions

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'
$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
getFailedRunCount()  : int
Gets failed_run_count
getFailureRatePercentage()  : float
Gets failure_rate_percentage
getModelName()  : string
The original name of the model.
getPhoneCountry()  : string|null
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
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTotalRunCount()  : int
Gets total_run_count
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
setFailedRunCount()  : self
Sets failed_run_count
setFailureRatePercentage()  : self
Sets failure_rate_percentage
setPhoneCountry()  : self
Sets phone_country
setPhoneVariant()  : self
Sets phone_variant
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTotalRunCount()  : self
Sets total_run_count
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

Constants

Properties

$attributeMap

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

protected static array<string|int, string> $attributeMap = ['phone_country' => 'phoneCountry', 'phone_variant' => 'phoneVariant', 'failed_run_count' => 'failedRunCount', 'total_run_count' => 'totalRunCount', 'failure_rate_percentage' => 'failureRatePercentage']

$getters

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

protected static array<string|int, string> $getters = ['phone_country' => 'getPhoneCountry', 'phone_variant' => 'getPhoneVariant', 'failed_run_count' => 'getFailedRunCount', 'total_run_count' => 'getTotalRunCount', 'failure_rate_percentage' => 'getFailureRatePercentage']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['phone_country' => null, 'phone_variant' => null, 'failed_run_count' => 'int64', 'total_run_count' => 'int64', 'failure_rate_percentage' => 'double']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['phone_country' => true, 'phone_variant' => true, 'failed_run_count' => false, 'total_run_count' => false, 'failure_rate_percentage' => false]

$openAPITypes

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

protected static array<string|int, string> $openAPITypes = ['phone_country' => 'string', 'phone_variant' => 'string', 'failed_run_count' => 'int', 'total_run_count' => 'int', 'failure_rate_percentage' => 'float']

$setters

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

protected static array<string|int, string> $setters = ['phone_country' => 'setPhoneCountry', 'phone_variant' => 'setPhoneVariant', 'failed_run_count' => 'setFailedRunCount', 'total_run_count' => 'setTotalRunCount', 'failure_rate_percentage' => 'setFailureRatePercentage']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

Associated array of property values initializing the model

Return values
mixed —

attributeMap()

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

public static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —

invalid properties with reasons

offsetSet()

Sets value based on offset.

public offsetSet(int|null $offset, mixed $value) : void
Parameters
$offset : int|null

Offset

$value : mixed

Value to be set

Return values
void —

setFailureRatePercentage()

Sets failure_rate_percentage

public setFailureRatePercentage(float $failure_rate_percentage) : self
Parameters
$failure_rate_percentage : float

failure_rate_percentage

Return values
self —

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null

private getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool> —

setIfExists()

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

private setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
$variableName : string
$fields : array<string|int, mixed>
$defaultValue : mixed
Return values
void —

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null

private setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
$openAPINullablesSetToNull : array<string|int, bool>
Return values
void —

Search results