DeliverabilitySelectorOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
DeliverabilitySelectorOptions Class Doc Comment
Tags
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'
- TYPE_ALL = 'ALL'
- TYPE_EXPLICIT = 'EXPLICIT'
- TYPE_PATTERN = 'PATTERN'
- $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
- getEntityIds() : array<string|int, string>|null
- Gets entity_ids
- getExcludeEntityIds() : array<string|int, string>|null
- Gets exclude_entity_ids
- getModelName() : string
- The original name of the model.
- getPattern() : string|null
- Gets pattern
- getPhoneCountry() : string|null
- Gets phone_country
- getPhoneCountryAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getTags() : array<string|int, string>|null
- Gets tags
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getType() : string
- Gets type
- getTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- 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
- setEntityIds() : self
- Sets entity_ids
- setExcludeEntityIds() : self
- Sets exclude_entity_ids
- setPattern() : self
- Sets pattern
- setPhoneCountry() : self
- Sets phone_country
- setTags() : self
- Sets tags
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setType() : self
- Sets type
- 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
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
PHONE_COUNTRY_AU
public
mixed
PHONE_COUNTRY_AU
= 'AU'
PHONE_COUNTRY_CA
public
mixed
PHONE_COUNTRY_CA
= 'CA'
PHONE_COUNTRY_CH
public
mixed
PHONE_COUNTRY_CH
= 'CH'
PHONE_COUNTRY_EE
public
mixed
PHONE_COUNTRY_EE
= 'EE'
PHONE_COUNTRY_FI
public
mixed
PHONE_COUNTRY_FI
= 'FI'
PHONE_COUNTRY_GB
public
mixed
PHONE_COUNTRY_GB
= 'GB'
PHONE_COUNTRY_HK
public
mixed
PHONE_COUNTRY_HK
= 'HK'
PHONE_COUNTRY_IL
public
mixed
PHONE_COUNTRY_IL
= 'IL'
PHONE_COUNTRY_NL
public
mixed
PHONE_COUNTRY_NL
= 'NL'
PHONE_COUNTRY_PL
public
mixed
PHONE_COUNTRY_PL
= 'PL'
PHONE_COUNTRY_PT
public
mixed
PHONE_COUNTRY_PT
= 'PT'
PHONE_COUNTRY_SE
public
mixed
PHONE_COUNTRY_SE
= 'SE'
PHONE_COUNTRY_US
public
mixed
PHONE_COUNTRY_US
= 'US'
TYPE_ALL
public
mixed
TYPE_ALL
= 'ALL'
TYPE_EXPLICIT
public
mixed
TYPE_EXPLICIT
= 'EXPLICIT'
TYPE_PATTERN
public
mixed
TYPE_PATTERN
= 'PATTERN'
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
= ['type' => 'type', 'pattern' => 'pattern', 'phone_country' => 'phoneCountry', 'entity_ids' => 'entityIds', 'exclude_entity_ids' => 'excludeEntityIds', 'tags' => 'tags']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['type' => 'getType', 'pattern' => 'getPattern', 'phone_country' => 'getPhoneCountry', 'entity_ids' => 'getEntityIds', 'exclude_entity_ids' => 'getExcludeEntityIds', 'tags' => 'getTags']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['type' => null, 'pattern' => null, 'phone_country' => null, 'entity_ids' => 'uuid', 'exclude_entity_ids' => 'uuid', 'tags' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'DeliverabilitySelectorOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['type' => false, 'pattern' => true, 'phone_country' => true, 'entity_ids' => true, 'exclude_entity_ids' => true, 'tags' => true]
$openAPINullablesSetToNull
If a nullable field gets set to null, insert it here
protected
array<string|int, mixed>
$openAPINullablesSetToNull
= []
$openAPITypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPITypes
= ['type' => 'string', 'pattern' => 'string', 'phone_country' => 'string', 'entity_ids' => 'string[]', 'exclude_entity_ids' => 'string[]', 'tags' => 'string[]']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['type' => 'setType', 'pattern' => 'setPattern', 'phone_country' => 'setPhoneCountry', 'entity_ids' => 'setEntityIds', 'exclude_entity_ids' => 'setExcludeEntityIds', 'tags' => 'setTags']
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 —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —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> —getEntityIds()
Gets entity_ids
public
getEntityIds() : array<string|int, string>|null
Return values
array<string|int, string>|null —getExcludeEntityIds()
Gets exclude_entity_ids
public
getExcludeEntityIds() : array<string|int, string>|null
Return values
array<string|int, string>|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPattern()
Gets pattern
public
getPattern() : string|null
Return values
string|null —getPhoneCountry()
Gets phone_country
public
getPhoneCountry() : string|null
Return values
string|null —getPhoneCountryAllowableValues()
Gets allowable values of the enum
public
getPhoneCountryAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getTags()
Gets tags
public
getTags() : array<string|int, string>|null
Return values
array<string|int, string>|null —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getType()
Gets type
public
getType() : string
Return values
string —getTypeAllowableValues()
Gets allowable values of the enum
public
getTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —isNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
bool —isNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
bool —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Return values
mixed —Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.
listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed|null
Parameters
- $offset : int
-
Offset
Return values
mixed|null —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 —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —openAPIFormats()
Array of property to format mappings. Used for (de)serialization
public
static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —openAPITypes()
Array of property to type mappings. Used for (de)serialization
public
static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —setEntityIds()
Sets entity_ids
public
setEntityIds(array<string|int, string>|null $entity_ids) : self
Parameters
- $entity_ids : array<string|int, string>|null
-
Explicit entity IDs for EXPLICIT selection
Return values
self —setExcludeEntityIds()
Sets exclude_entity_ids
public
setExcludeEntityIds(array<string|int, string>|null $exclude_entity_ids) : self
Parameters
- $exclude_entity_ids : array<string|int, string>|null
-
Optional entity IDs to exclude from the resolved selection (applies after ALL/PATTERN/EXPLICIT selection).
Return values
self —setPattern()
Sets pattern
public
setPattern(string|null $pattern) : self
Parameters
- $pattern : string|null
-
Wildcard pattern for PATTERN selection. Supports '*' and '?' wildcards. If no wildcard is present the value is treated as a case-insensitive contains match.
Return values
self —setPhoneCountry()
Sets phone_country
public
setPhoneCountry(string|null $phone_country) : self
Parameters
- $phone_country : string|null
-
Optional phone-country filter for PHONE scope selection (e.g. ALL phones in US). Must be null for INBOX scope.
Return values
self —setTags()
Sets tags
public
setTags(array<string|int, string>|null $tags) : self
Parameters
- $tags : array<string|int, string>|null
-
Optional tags to filter selected entities by. Matching is case-insensitive and an entity must contain all provided tags.
Return values
self —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setType()
Sets type
public
setType(string $type) : self
Parameters
- $type : string
-
Selection mode
Return values
self —toHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
string —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid
openAPINullables()
Array of nullable properties
protected
static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed> —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>