DevicePreviewIngestAddressDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
DevicePreviewIngestAddressDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- STATUS_EXPIRED = 'EXPIRED'
- STATUS_FAILED = 'FAILED'
- STATUS_RUN_CREATED = 'RUN_CREATED'
- STATUS_WAITING_FOR_EMAIL = 'WAITING_FOR_EMAIL'
- $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
- getCreatedAt() : DateTime
- Gets created_at
- getEmailAddress() : string
- Gets email_address
- getExpiresAt() : DateTime
- Gets expires_at
- getLatestError() : string|null
- Gets latest_error
- getModelName() : string
- The original name of the model.
- getRunId() : string|null
- Gets run_id
- getSessionId() : string
- Gets session_id
- getSourceFrom() : string|null
- Gets source_from
- getSourceMessageId() : string|null
- Gets source_message_id
- getSourceSizeBytes() : int|null
- Gets source_size_bytes
- getSourceSubject() : string|null
- Gets source_subject
- getSourceTo() : array<string|int, string>|null
- Gets source_to
- 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)
- getUpdatedAt() : DateTime
- Gets updated_at
- 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
- setCreatedAt() : self
- Sets created_at
- setEmailAddress() : self
- Sets email_address
- setExpiresAt() : self
- Sets expires_at
- setLatestError() : self
- Sets latest_error
- setRunId() : self
- Sets run_id
- setSessionId() : self
- Sets session_id
- setSourceFrom() : self
- Sets source_from
- setSourceMessageId() : self
- Sets source_message_id
- setSourceSizeBytes() : self
- Sets source_size_bytes
- setSourceSubject() : self
- Sets source_subject
- setSourceTo() : self
- Sets source_to
- setStatus() : self
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUpdatedAt() : self
- Sets updated_at
- 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_EXPIRED
public
mixed
STATUS_EXPIRED
= 'EXPIRED'
STATUS_FAILED
public
mixed
STATUS_FAILED
= 'FAILED'
STATUS_RUN_CREATED
public
mixed
STATUS_RUN_CREATED
= 'RUN_CREATED'
STATUS_WAITING_FOR_EMAIL
public
mixed
STATUS_WAITING_FOR_EMAIL
= 'WAITING_FOR_EMAIL'
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
= ['session_id' => 'sessionId', 'email_address' => 'emailAddress', 'status' => 'status', 'run_id' => 'runId', 'source_from' => 'sourceFrom', 'source_to' => 'sourceTo', 'source_subject' => 'sourceSubject', 'source_message_id' => 'sourceMessageId', 'source_size_bytes' => 'sourceSizeBytes', 'latest_error' => 'latestError', 'expires_at' => 'expiresAt', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt']
$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
= ['session_id' => 'getSessionId', 'email_address' => 'getEmailAddress', 'status' => 'getStatus', 'run_id' => 'getRunId', 'source_from' => 'getSourceFrom', 'source_to' => 'getSourceTo', 'source_subject' => 'getSourceSubject', 'source_message_id' => 'getSourceMessageId', 'source_size_bytes' => 'getSourceSizeBytes', 'latest_error' => 'getLatestError', 'expires_at' => 'getExpiresAt', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['session_id' => 'uuid', 'email_address' => null, 'status' => null, 'run_id' => 'uuid', 'source_from' => null, 'source_to' => null, 'source_subject' => null, 'source_message_id' => null, 'source_size_bytes' => 'int64', 'latest_error' => null, 'expires_at' => 'date-time', 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'DevicePreviewIngestAddressDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['session_id' => false, 'email_address' => false, 'status' => false, 'run_id' => true, 'source_from' => true, 'source_to' => true, 'source_subject' => true, 'source_message_id' => true, 'source_size_bytes' => true, 'latest_error' => true, 'expires_at' => false, 'created_at' => false, 'updated_at' => 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
= ['session_id' => 'string', 'email_address' => 'string', 'status' => 'string', 'run_id' => 'string', 'source_from' => 'string', 'source_to' => 'string[]', 'source_subject' => 'string', 'source_message_id' => 'string', 'source_size_bytes' => 'int', 'latest_error' => 'string', 'expires_at' => '\\DateTime', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['session_id' => 'setSessionId', 'email_address' => 'setEmailAddress', 'status' => 'setStatus', 'run_id' => 'setRunId', 'source_from' => 'setSourceFrom', 'source_to' => 'setSourceTo', 'source_subject' => 'setSourceSubject', 'source_message_id' => 'setSourceMessageId', 'source_size_bytes' => 'setSourceSizeBytes', 'latest_error' => 'setLatestError', 'expires_at' => 'setExpiresAt', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt']
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> —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getEmailAddress()
Gets email_address
public
getEmailAddress() : string
Return values
string —getExpiresAt()
Gets expires_at
public
getExpiresAt() : DateTime
Return values
DateTime —getLatestError()
Gets latest_error
public
getLatestError() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRunId()
Gets run_id
public
getRunId() : string|null
Return values
string|null —getSessionId()
Gets session_id
public
getSessionId() : string
Return values
string —getSourceFrom()
Gets source_from
public
getSourceFrom() : string|null
Return values
string|null —getSourceMessageId()
Gets source_message_id
public
getSourceMessageId() : string|null
Return values
string|null —getSourceSizeBytes()
Gets source_size_bytes
public
getSourceSizeBytes() : int|null
Return values
int|null —getSourceSubject()
Gets source_subject
public
getSourceSubject() : string|null
Return values
string|null —getSourceTo()
Gets source_to
public
getSourceTo() : array<string|int, string>|null
Return values
array<string|int, 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> —getUpdatedAt()
Gets updated_at
public
getUpdatedAt() : DateTime
Return values
DateTime —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> —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setEmailAddress()
Sets email_address
public
setEmailAddress(string $email_address) : self
Parameters
- $email_address : string
-
email_address
Return values
self —setExpiresAt()
Sets expires_at
public
setExpiresAt(DateTime $expires_at) : self
Parameters
- $expires_at : DateTime
-
expires_at
Return values
self —setLatestError()
Sets latest_error
public
setLatestError(string|null $latest_error) : self
Parameters
- $latest_error : string|null
-
latest_error
Return values
self —setRunId()
Sets run_id
public
setRunId(string|null $run_id) : self
Parameters
- $run_id : string|null
-
run_id
Return values
self —setSessionId()
Sets session_id
public
setSessionId(string $session_id) : self
Parameters
- $session_id : string
-
session_id
Return values
self —setSourceFrom()
Sets source_from
public
setSourceFrom(string|null $source_from) : self
Parameters
- $source_from : string|null
-
source_from
Return values
self —setSourceMessageId()
Sets source_message_id
public
setSourceMessageId(string|null $source_message_id) : self
Parameters
- $source_message_id : string|null
-
source_message_id
Return values
self —setSourceSizeBytes()
Sets source_size_bytes
public
setSourceSizeBytes(int|null $source_size_bytes) : self
Parameters
- $source_size_bytes : int|null
-
source_size_bytes
Return values
self —setSourceSubject()
Sets source_subject
public
setSourceSubject(string|null $source_subject) : self
Parameters
- $source_subject : string|null
-
source_subject
Return values
self —setSourceTo()
Sets source_to
public
setSourceTo(array<string|int, string>|null $source_to) : self
Parameters
- $source_to : array<string|int, string>|null
-
source_to
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> —setUpdatedAt()
Sets updated_at
public
setUpdatedAt(DateTime $updated_at) : self
Parameters
- $updated_at : DateTime
-
updated_at
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>