PublicDeviceRenderTestDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
PublicDeviceRenderTestDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- PREVIEW_MODE_DEVICE_RENDER = 'DEVICE_RENDER'
- PREVIEW_MODE_LIGHT_DARK = 'LIGHT_DARK'
- STATUS_EXPIRED = 'EXPIRED'
- STATUS_FAILED = 'FAILED'
- STATUS_PROCESSING = 'PROCESSING'
- STATUS_RATE_LIMITED = 'RATE_LIMITED'
- STATUS_RECEIVED = 'RECEIVED'
- STATUS_REJECTED = 'REJECTED'
- 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
- getEmailAddress() : string
- Gets email_address
- getExpiresAt() : DateTime
- Gets expires_at
- getFailureCode() : string|null
- Gets failure_code
- getFailureMessage() : string|null
- Gets failure_message
- getFreeLimitReached() : bool
- Gets free_limit_reached
- getId() : string
- Gets id
- getModelName() : string
- The original name of the model.
- getPreviewMode() : string
- Gets preview_mode
- getPreviewModeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getRedirectUrl() : string|null
- Gets redirect_url
- getRunId() : string|null
- Gets run_id
- getSenderDomain() : string|null
- Gets sender_domain
- getShareUrl() : string|null
- Gets share_url
- getSourceFrom() : string|null
- Gets source_from
- getSourceSubject() : string|null
- Gets source_subject
- getStatus() : string
- Gets status
- getStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getTarget() : string
- Gets target
- 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
- setEmailAddress() : self
- Sets email_address
- setExpiresAt() : self
- Sets expires_at
- setFailureCode() : self
- Sets failure_code
- setFailureMessage() : self
- Sets failure_message
- setFreeLimitReached() : self
- Sets free_limit_reached
- setId() : self
- Sets id
- setPreviewMode() : self
- Sets preview_mode
- setRedirectUrl() : self
- Sets redirect_url
- setRunId() : self
- Sets run_id
- setSenderDomain() : self
- Sets sender_domain
- setShareUrl() : self
- Sets share_url
- setSourceFrom() : self
- Sets source_from
- setSourceSubject() : self
- Sets source_subject
- setStatus() : self
- Sets status
- setTarget() : self
- Sets target
- 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
PREVIEW_MODE_DEVICE_RENDER
public
mixed
PREVIEW_MODE_DEVICE_RENDER
= 'DEVICE_RENDER'
PREVIEW_MODE_LIGHT_DARK
public
mixed
PREVIEW_MODE_LIGHT_DARK
= 'LIGHT_DARK'
STATUS_EXPIRED
public
mixed
STATUS_EXPIRED
= 'EXPIRED'
STATUS_FAILED
public
mixed
STATUS_FAILED
= 'FAILED'
STATUS_PROCESSING
public
mixed
STATUS_PROCESSING
= 'PROCESSING'
STATUS_RATE_LIMITED
public
mixed
STATUS_RATE_LIMITED
= 'RATE_LIMITED'
STATUS_RECEIVED
public
mixed
STATUS_RECEIVED
= 'RECEIVED'
STATUS_REJECTED
public
mixed
STATUS_REJECTED
= 'REJECTED'
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
= ['id' => 'id', 'email_address' => 'emailAddress', 'status' => 'status', 'expires_at' => 'expiresAt', 'target' => 'target', 'preview_mode' => 'previewMode', 'source_from' => 'sourceFrom', 'source_subject' => 'sourceSubject', 'sender_domain' => 'senderDomain', 'run_id' => 'runId', 'share_url' => 'shareUrl', 'redirect_url' => 'redirectUrl', 'free_limit_reached' => 'freeLimitReached', 'failure_code' => 'failureCode', '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', 'email_address' => 'getEmailAddress', 'status' => 'getStatus', 'expires_at' => 'getExpiresAt', 'target' => 'getTarget', 'preview_mode' => 'getPreviewMode', 'source_from' => 'getSourceFrom', 'source_subject' => 'getSourceSubject', 'sender_domain' => 'getSenderDomain', 'run_id' => 'getRunId', 'share_url' => 'getShareUrl', 'redirect_url' => 'getRedirectUrl', 'free_limit_reached' => 'getFreeLimitReached', 'failure_code' => 'getFailureCode', 'failure_message' => 'getFailureMessage']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'email_address' => null, 'status' => null, 'expires_at' => 'date-time', 'target' => null, 'preview_mode' => null, 'source_from' => null, 'source_subject' => null, 'sender_domain' => null, 'run_id' => 'uuid', 'share_url' => null, 'redirect_url' => null, 'free_limit_reached' => null, 'failure_code' => null, 'failure_message' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'PublicDeviceRenderTestDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'email_address' => false, 'status' => false, 'expires_at' => false, 'target' => false, 'preview_mode' => false, 'source_from' => true, 'source_subject' => true, 'sender_domain' => true, 'run_id' => true, 'share_url' => true, 'redirect_url' => true, 'free_limit_reached' => false, 'failure_code' => 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', 'email_address' => 'string', 'status' => 'string', 'expires_at' => '\\DateTime', 'target' => 'string', 'preview_mode' => 'string', 'source_from' => 'string', 'source_subject' => 'string', 'sender_domain' => 'string', 'run_id' => 'string', 'share_url' => 'string', 'redirect_url' => 'string', 'free_limit_reached' => 'bool', 'failure_code' => 'string', 'failure_message' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'email_address' => 'setEmailAddress', 'status' => 'setStatus', 'expires_at' => 'setExpiresAt', 'target' => 'setTarget', 'preview_mode' => 'setPreviewMode', 'source_from' => 'setSourceFrom', 'source_subject' => 'setSourceSubject', 'sender_domain' => 'setSenderDomain', 'run_id' => 'setRunId', 'share_url' => 'setShareUrl', 'redirect_url' => 'setRedirectUrl', 'free_limit_reached' => 'setFreeLimitReached', 'failure_code' => 'setFailureCode', '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> —getEmailAddress()
Gets email_address
public
getEmailAddress() : string
Return values
string —getExpiresAt()
Gets expires_at
public
getExpiresAt() : DateTime
Return values
DateTime —getFailureCode()
Gets failure_code
public
getFailureCode() : string|null
Return values
string|null —getFailureMessage()
Gets failure_message
public
getFailureMessage() : string|null
Return values
string|null —getFreeLimitReached()
Gets free_limit_reached
public
getFreeLimitReached() : bool
Return values
bool —getId()
Gets id
public
getId() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPreviewMode()
Gets preview_mode
public
getPreviewMode() : string
Return values
string —getPreviewModeAllowableValues()
Gets allowable values of the enum
public
getPreviewModeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getRedirectUrl()
Gets redirect_url
public
getRedirectUrl() : string|null
Return values
string|null —getRunId()
Gets run_id
public
getRunId() : string|null
Return values
string|null —getSenderDomain()
Gets sender_domain
public
getSenderDomain() : string|null
Return values
string|null —getShareUrl()
Gets share_url
public
getShareUrl() : string|null
Return values
string|null —getSourceFrom()
Gets source_from
public
getSourceFrom() : string|null
Return values
string|null —getSourceSubject()
Gets source_subject
public
getSourceSubject() : 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> —getTarget()
Gets target
public
getTarget() : 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> —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 —setFailureCode()
Sets failure_code
public
setFailureCode(string|null $failure_code) : self
Parameters
- $failure_code : string|null
-
failure_code
Return values
self —setFailureMessage()
Sets failure_message
public
setFailureMessage(string|null $failure_message) : self
Parameters
- $failure_message : string|null
-
failure_message
Return values
self —setFreeLimitReached()
Sets free_limit_reached
public
setFreeLimitReached(bool $free_limit_reached) : self
Parameters
- $free_limit_reached : bool
-
free_limit_reached
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setPreviewMode()
Sets preview_mode
public
setPreviewMode(string $preview_mode) : self
Parameters
- $preview_mode : string
-
preview_mode
Return values
self —setRedirectUrl()
Sets redirect_url
public
setRedirectUrl(string|null $redirect_url) : self
Parameters
- $redirect_url : string|null
-
redirect_url
Return values
self —setRunId()
Sets run_id
public
setRunId(string|null $run_id) : self
Parameters
- $run_id : string|null
-
run_id
Return values
self —setSenderDomain()
Sets sender_domain
public
setSenderDomain(string|null $sender_domain) : self
Parameters
- $sender_domain : string|null
-
sender_domain
Return values
self —setShareUrl()
Sets share_url
public
setShareUrl(string|null $share_url) : self
Parameters
- $share_url : string|null
-
share_url
Return values
self —setSourceFrom()
Sets source_from
public
setSourceFrom(string|null $source_from) : self
Parameters
- $source_from : string|null
-
source_from
Return values
self —setSourceSubject()
Sets source_subject
public
setSourceSubject(string|null $source_subject) : self
Parameters
- $source_subject : string|null
-
source_subject
Return values
self —setStatus()
Sets status
public
setStatus(string $status) : self
Parameters
- $status : string
-
status
Return values
self —setTarget()
Sets target
public
setTarget(string $target) : self
Parameters
- $target : string
-
target
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>