PhoneProvisioningJobItemDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
PhoneProvisioningJobItemDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- STATUS_FAILED = 'FAILED'
- STATUS_PENDING = 'PENDING'
- STATUS_PROVISIONED = 'PROVISIONED'
- STATUS_PROVISIONING = 'PROVISIONING'
- STATUS_UNAVAILABLE = 'UNAVAILABLE'
- $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
- getFailureMessage() : string|null
- Gets failure_message
- getId() : string
- Gets id
- 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.
- getPhoneNumber() : string
- Gets phone_number
- getPhoneNumberId() : string|null
- Gets phone_number_id
- getProviderLabel() : string|null
- Gets provider_label
- getStatus() : string
- Gets status
- getStatusAllowableValues() : 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
- setFailureMessage() : self
- Sets failure_message
- setId() : self
- Sets id
- setLineType() : self
- Sets line_type
- setMobileCountryCode() : self
- Sets mobile_country_code
- setMobileNetworkCode() : self
- Sets mobile_network_code
- setPhoneNumber() : self
- Sets phone_number
- setPhoneNumberId() : self
- Sets phone_number_id
- setProviderLabel() : self
- Sets provider_label
- setStatus() : self
- Sets status
- 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
STATUS_FAILED
public
mixed
STATUS_FAILED
= 'FAILED'
STATUS_PENDING
public
mixed
STATUS_PENDING
= 'PENDING'
STATUS_PROVISIONED
public
mixed
STATUS_PROVISIONED
= 'PROVISIONED'
STATUS_PROVISIONING
public
mixed
STATUS_PROVISIONING
= 'PROVISIONING'
STATUS_UNAVAILABLE
public
mixed
STATUS_UNAVAILABLE
= 'UNAVAILABLE'
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
= ['id' => 'id', 'phone_number' => 'phoneNumber', 'provider_label' => 'providerLabel', 'status' => 'status', 'line_type' => 'lineType', 'carrier_name' => 'carrierName', 'mobile_country_code' => 'mobileCountryCode', 'mobile_network_code' => 'mobileNetworkCode', 'phone_number_id' => 'phoneNumberId', 'failure_message' => 'failureMessage']
$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
= ['id' => 'getId', 'phone_number' => 'getPhoneNumber', 'provider_label' => 'getProviderLabel', 'status' => 'getStatus', 'line_type' => 'getLineType', 'carrier_name' => 'getCarrierName', 'mobile_country_code' => 'getMobileCountryCode', 'mobile_network_code' => 'getMobileNetworkCode', 'phone_number_id' => 'getPhoneNumberId', 'failure_message' => 'getFailureMessage']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'phone_number' => null, 'provider_label' => null, 'status' => null, 'line_type' => null, 'carrier_name' => null, 'mobile_country_code' => null, 'mobile_network_code' => null, 'phone_number_id' => 'uuid', 'failure_message' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'PhoneProvisioningJobItemDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'phone_number' => false, 'provider_label' => true, 'status' => false, 'line_type' => true, 'carrier_name' => true, 'mobile_country_code' => true, 'mobile_network_code' => true, 'phone_number_id' => true, 'failure_message' => 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
= ['id' => 'string', 'phone_number' => 'string', 'provider_label' => 'string', 'status' => 'string', 'line_type' => 'string', 'carrier_name' => 'string', 'mobile_country_code' => 'string', 'mobile_network_code' => 'string', 'phone_number_id' => 'string', 'failure_message' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'phone_number' => 'setPhoneNumber', 'provider_label' => 'setProviderLabel', 'status' => 'setStatus', 'line_type' => 'setLineType', 'carrier_name' => 'setCarrierName', 'mobile_country_code' => 'setMobileCountryCode', 'mobile_network_code' => 'setMobileNetworkCode', 'phone_number_id' => 'setPhoneNumberId', 'failure_message' => 'setFailureMessage']
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> —getCarrierName()
Gets carrier_name
public
getCarrierName() : string|null
Return values
string|null —getFailureMessage()
Gets failure_message
public
getFailureMessage() : string|null
Return values
string|null —getId()
Gets id
public
getId() : string
Return values
string —getLineType()
Gets line_type
public
getLineType() : string|null
Return values
string|null —getMobileCountryCode()
Gets mobile_country_code
public
getMobileCountryCode() : string|null
Return values
string|null —getMobileNetworkCode()
Gets mobile_network_code
public
getMobileNetworkCode() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPhoneNumber()
Gets phone_number
public
getPhoneNumber() : string
Return values
string —getPhoneNumberId()
Gets phone_number_id
public
getPhoneNumberId() : string|null
Return values
string|null —getProviderLabel()
Gets provider_label
public
getProviderLabel() : string|null
Return values
string|null —getStatus()
Gets status
public
getStatus() : string
Return values
string —getStatusAllowableValues()
Gets allowable values of the enum
public
getStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, 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> —setCarrierName()
Sets carrier_name
public
setCarrierName(string|null $carrier_name) : self
Parameters
- $carrier_name : string|null
-
carrier_name
Return values
self —setFailureMessage()
Sets failure_message
public
setFailureMessage(string|null $failure_message) : self
Parameters
- $failure_message : string|null
-
failure_message
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setLineType()
Sets line_type
public
setLineType(string|null $line_type) : self
Parameters
- $line_type : string|null
-
line_type
Return values
self —setMobileCountryCode()
Sets mobile_country_code
public
setMobileCountryCode(string|null $mobile_country_code) : self
Parameters
- $mobile_country_code : string|null
-
mobile_country_code
Return values
self —setMobileNetworkCode()
Sets mobile_network_code
public
setMobileNetworkCode(string|null $mobile_network_code) : self
Parameters
- $mobile_network_code : string|null
-
mobile_network_code
Return values
self —setPhoneNumber()
Sets phone_number
public
setPhoneNumber(string $phone_number) : self
Parameters
- $phone_number : string
-
phone_number
Return values
self —setPhoneNumberId()
Sets phone_number_id
public
setPhoneNumberId(string|null $phone_number_id) : self
Parameters
- $phone_number_id : string|null
-
phone_number_id
Return values
self —setProviderLabel()
Sets provider_label
public
setProviderLabel(string|null $provider_label) : self
Parameters
- $provider_label : string|null
-
provider_label
Return values
self —setStatus()
Sets status
public
setStatus(string $status) : self
Parameters
- $status : string
-
status
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>