PhoneProvisioningJobDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
PhoneProvisioningJobDto 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'
- PHONE_VARIANT_LOCAL = 'LOCAL'
- PHONE_VARIANT_MOBILE = 'MOBILE'
- PHONE_VARIANT_TOLL_FREE = 'TOLL_FREE'
- STATUS_COMPLETED = 'COMPLETED'
- STATUS_CREATED = 'CREATED'
- STATUS_FAILED = 'FAILED'
- STATUS_PARTIAL = 'PARTIAL'
- STATUS_RUNNING = 'RUNNING'
- $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
- getAttemptedCount() : int
- Gets attempted_count
- getCreatedAt() : DateTime
- Gets created_at
- getFailedCount() : int
- Gets failed_count
- getId() : string
- Gets id
- getItems() : array<string|int, PhoneProvisioningJobItemDto>
- Gets items
- 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
- getRequestedCount() : int
- Gets requested_count
- getStatus() : string
- Gets status
- getStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getSucceededCount() : int
- Gets succeeded_count
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUnavailableCount() : int
- Gets unavailable_count
- getUpdatedAt() : DateTime
- Gets updated_at
- getUserId() : string
- Gets user_id
- 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
- setAttemptedCount() : self
- Sets attempted_count
- setCreatedAt() : self
- Sets created_at
- setFailedCount() : self
- Sets failed_count
- setId() : self
- Sets id
- setItems() : self
- Sets items
- setPhoneCountry() : self
- Sets phone_country
- setPhoneVariant() : self
- Sets phone_variant
- setRequestedCount() : self
- Sets requested_count
- setStatus() : self
- Sets status
- setSucceededCount() : self
- Sets succeeded_count
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUnavailableCount() : self
- Sets unavailable_count
- setUpdatedAt() : self
- Sets updated_at
- setUserId() : self
- Sets user_id
- 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'
PHONE_VARIANT_LOCAL
public
mixed
PHONE_VARIANT_LOCAL
= 'LOCAL'
PHONE_VARIANT_MOBILE
public
mixed
PHONE_VARIANT_MOBILE
= 'MOBILE'
PHONE_VARIANT_TOLL_FREE
public
mixed
PHONE_VARIANT_TOLL_FREE
= 'TOLL_FREE'
STATUS_COMPLETED
public
mixed
STATUS_COMPLETED
= 'COMPLETED'
STATUS_CREATED
public
mixed
STATUS_CREATED
= 'CREATED'
STATUS_FAILED
public
mixed
STATUS_FAILED
= 'FAILED'
STATUS_PARTIAL
public
mixed
STATUS_PARTIAL
= 'PARTIAL'
STATUS_RUNNING
public
mixed
STATUS_RUNNING
= 'RUNNING'
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', 'user_id' => 'userId', 'phone_country' => 'phoneCountry', 'phone_variant' => 'phoneVariant', 'status' => 'status', 'requested_count' => 'requestedCount', 'attempted_count' => 'attemptedCount', 'succeeded_count' => 'succeededCount', 'failed_count' => 'failedCount', 'unavailable_count' => 'unavailableCount', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt', 'items' => 'items']
$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', 'user_id' => 'getUserId', 'phone_country' => 'getPhoneCountry', 'phone_variant' => 'getPhoneVariant', 'status' => 'getStatus', 'requested_count' => 'getRequestedCount', 'attempted_count' => 'getAttemptedCount', 'succeeded_count' => 'getSucceededCount', 'failed_count' => 'getFailedCount', 'unavailable_count' => 'getUnavailableCount', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt', 'items' => 'getItems']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'user_id' => 'uuid', 'phone_country' => null, 'phone_variant' => null, 'status' => null, 'requested_count' => 'int32', 'attempted_count' => 'int32', 'succeeded_count' => 'int32', 'failed_count' => 'int32', 'unavailable_count' => 'int32', 'created_at' => 'date-time', 'updated_at' => 'date-time', 'items' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'PhoneProvisioningJobDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'user_id' => false, 'phone_country' => false, 'phone_variant' => true, 'status' => false, 'requested_count' => false, 'attempted_count' => false, 'succeeded_count' => false, 'failed_count' => false, 'unavailable_count' => false, 'created_at' => false, 'updated_at' => false, 'items' => 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
= ['id' => 'string', 'user_id' => 'string', 'phone_country' => 'string', 'phone_variant' => 'string', 'status' => 'string', 'requested_count' => 'int', 'attempted_count' => 'int', 'succeeded_count' => 'int', 'failed_count' => 'int', 'unavailable_count' => 'int', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime', 'items' => '\\MailSlurp\\Models\\PhoneProvisioningJobItemDto[]']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'user_id' => 'setUserId', 'phone_country' => 'setPhoneCountry', 'phone_variant' => 'setPhoneVariant', 'status' => 'setStatus', 'requested_count' => 'setRequestedCount', 'attempted_count' => 'setAttemptedCount', 'succeeded_count' => 'setSucceededCount', 'failed_count' => 'setFailedCount', 'unavailable_count' => 'setUnavailableCount', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt', 'items' => 'setItems']
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> —getAttemptedCount()
Gets attempted_count
public
getAttemptedCount() : int
Return values
int —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getFailedCount()
Gets failed_count
public
getFailedCount() : int
Return values
int —getId()
Gets id
public
getId() : string
Return values
string —getItems()
Gets items
public
getItems() : array<string|int, PhoneProvisioningJobItemDto>
Return values
array<string|int, PhoneProvisioningJobItemDto> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPhoneCountry()
Gets phone_country
public
getPhoneCountry() : string
Return values
string —getPhoneCountryAllowableValues()
Gets allowable values of the enum
public
getPhoneCountryAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getPhoneVariant()
Gets phone_variant
public
getPhoneVariant() : string|null
Return values
string|null —getPhoneVariantAllowableValues()
Gets allowable values of the enum
public
getPhoneVariantAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getRequestedCount()
Gets requested_count
public
getRequestedCount() : int
Return values
int —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> —getSucceededCount()
Gets succeeded_count
public
getSucceededCount() : int
Return values
int —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUnavailableCount()
Gets unavailable_count
public
getUnavailableCount() : int
Return values
int —getUpdatedAt()
Gets updated_at
public
getUpdatedAt() : DateTime
Return values
DateTime —getUserId()
Gets user_id
public
getUserId() : string
Return values
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> —setAttemptedCount()
Sets attempted_count
public
setAttemptedCount(int $attempted_count) : self
Parameters
- $attempted_count : int
-
attempted_count
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setFailedCount()
Sets failed_count
public
setFailedCount(int $failed_count) : self
Parameters
- $failed_count : int
-
failed_count
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setItems()
Sets items
public
setItems(array<string|int, PhoneProvisioningJobItemDto> $items) : self
Parameters
- $items : array<string|int, PhoneProvisioningJobItemDto>
-
items
Return values
self —setPhoneCountry()
Sets phone_country
public
setPhoneCountry(string $phone_country) : self
Parameters
- $phone_country : string
-
phone_country
Return values
self —setPhoneVariant()
Sets phone_variant
public
setPhoneVariant(string|null $phone_variant) : self
Parameters
- $phone_variant : string|null
-
phone_variant
Return values
self —setRequestedCount()
Sets requested_count
public
setRequestedCount(int $requested_count) : self
Parameters
- $requested_count : int
-
requested_count
Return values
self —setStatus()
Sets status
public
setStatus(string $status) : self
Parameters
- $status : string
-
status
Return values
self —setSucceededCount()
Sets succeeded_count
public
setSucceededCount(int $succeeded_count) : self
Parameters
- $succeeded_count : int
-
succeeded_count
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> —setUnavailableCount()
Sets unavailable_count
public
setUnavailableCount(int $unavailable_count) : self
Parameters
- $unavailable_count : int
-
unavailable_count
Return values
self —setUpdatedAt()
Sets updated_at
public
setUpdatedAt(DateTime $updated_at) : self
Parameters
- $updated_at : DateTime
-
updated_at
Return values
self —setUserId()
Sets user_id
public
setUserId(string $user_id) : self
Parameters
- $user_id : string
-
user_id
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>