CreateEmergencyAddressOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
CreateEmergencyAddressOptions Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- ISO_COUNTRY_CODE_AU = 'AU'
- ISO_COUNTRY_CODE_GB = 'GB'
- ISO_COUNTRY_CODE_US = 'US'
- $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
- getAddress1() : string
- Gets address1
- getCity() : string
- Gets city
- getCustomerName() : string
- Gets customer_name
- getDisplayName() : string|null
- Gets display_name
- getIsoCountryCode() : string
- Gets iso_country_code
- getIsoCountryCodeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getModelName() : string
- The original name of the model.
- getPostalCode() : string
- Gets postal_code
- getRegion() : string
- Gets region
- 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
- setAddress1() : self
- Sets address1
- setCity() : self
- Sets city
- setCustomerName() : self
- Sets customer_name
- setDisplayName() : self
- Sets display_name
- setIsoCountryCode() : self
- Sets iso_country_code
- setPostalCode() : self
- Sets postal_code
- setRegion() : self
- Sets region
- 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
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
ISO_COUNTRY_CODE_AU
public
mixed
ISO_COUNTRY_CODE_AU
= 'AU'
ISO_COUNTRY_CODE_GB
public
mixed
ISO_COUNTRY_CODE_GB
= 'GB'
ISO_COUNTRY_CODE_US
public
mixed
ISO_COUNTRY_CODE_US
= 'US'
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
= ['customer_name' => 'customerName', 'address1' => 'address1', 'city' => 'city', 'region' => 'region', 'postal_code' => 'postalCode', 'iso_country_code' => 'isoCountryCode', 'display_name' => 'displayName']
$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
= ['customer_name' => 'getCustomerName', 'address1' => 'getAddress1', 'city' => 'getCity', 'region' => 'getRegion', 'postal_code' => 'getPostalCode', 'iso_country_code' => 'getIsoCountryCode', 'display_name' => 'getDisplayName']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['customer_name' => null, 'address1' => null, 'city' => null, 'region' => null, 'postal_code' => null, 'iso_country_code' => null, 'display_name' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'CreateEmergencyAddressOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['customer_name' => false, 'address1' => false, 'city' => false, 'region' => false, 'postal_code' => false, 'iso_country_code' => false, 'display_name' => false]
$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
= ['customer_name' => 'string', 'address1' => 'string', 'city' => 'string', 'region' => 'string', 'postal_code' => 'string', 'iso_country_code' => 'string', 'display_name' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['customer_name' => 'setCustomerName', 'address1' => 'setAddress1', 'city' => 'setCity', 'region' => 'setRegion', 'postal_code' => 'setPostalCode', 'iso_country_code' => 'setIsoCountryCode', 'display_name' => 'setDisplayName']
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> —getAddress1()
Gets address1
public
getAddress1() : string
Return values
string —getCity()
Gets city
public
getCity() : string
Return values
string —getCustomerName()
Gets customer_name
public
getCustomerName() : string
Return values
string —getDisplayName()
Gets display_name
public
getDisplayName() : string|null
Return values
string|null —getIsoCountryCode()
Gets iso_country_code
public
getIsoCountryCode() : string
Return values
string —getIsoCountryCodeAllowableValues()
Gets allowable values of the enum
public
getIsoCountryCodeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPostalCode()
Gets postal_code
public
getPostalCode() : string
Return values
string —getRegion()
Gets region
public
getRegion() : string
Return values
string —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —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> —setAddress1()
Sets address1
public
setAddress1(string $address1) : self
Parameters
- $address1 : string
-
address1
Return values
self —setCity()
Sets city
public
setCity(string $city) : self
Parameters
- $city : string
-
city
Return values
self —setCustomerName()
Sets customer_name
public
setCustomerName(string $customer_name) : self
Parameters
- $customer_name : string
-
customer_name
Return values
self —setDisplayName()
Sets display_name
public
setDisplayName(string|null $display_name) : self
Parameters
- $display_name : string|null
-
display_name
Return values
self —setIsoCountryCode()
Sets iso_country_code
public
setIsoCountryCode(string $iso_country_code) : self
Parameters
- $iso_country_code : string
-
iso_country_code
Return values
self —setPostalCode()
Sets postal_code
public
setPostalCode(string $postal_code) : self
Parameters
- $postal_code : string
-
postal_code
Return values
self —setRegion()
Sets region
public
setRegion(string $region) : self
Parameters
- $region : string
-
region
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> —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>