DeliverabilityAnalyticsRunDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
DeliverabilityAnalyticsRunDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- SCOPE_INBOX = 'INBOX'
- SCOPE_PHONE = 'PHONE'
- STATUS_COMPLETE = 'COMPLETE'
- STATUS_CREATED = 'CREATED'
- STATUS_FAILED = 'FAILED'
- STATUS_PAUSED = 'PAUSED'
- STATUS_RUNNING = 'RUNNING'
- STATUS_SCHEDULED = 'SCHEDULED'
- STATUS_STOPPED = 'STOPPED'
- THRESHOLD_STATUS_FAILING = 'FAILING'
- THRESHOLD_STATUS_NOT_CONFIGURED = 'NOT_CONFIGURED'
- THRESHOLD_STATUS_PASSING = 'PASSING'
- $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
- getCompletedAt() : DateTime|null
- Gets completed_at
- getCompletionPercentage() : float
- Gets completion_percentage
- getCreatedAt() : DateTime
- Gets created_at
- getId() : string
- Gets id
- getMatchedEntities() : int
- Gets matched_entities
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getScope() : string
- Gets scope
- getScopeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getStartAt() : DateTime
- Gets start_at
- getStatus() : string
- Gets status
- getStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getSuccessThresholdPercent() : float|null
- Gets success_threshold_percent
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getThresholdStatus() : string
- Gets threshold_status
- getThresholdStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getTotalEntities() : int
- Gets total_entities
- getUnmatchedEntities() : int
- Gets unmatched_entities
- 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
- setCompletedAt() : self
- Sets completed_at
- setCompletionPercentage() : self
- Sets completion_percentage
- setCreatedAt() : self
- Sets created_at
- setId() : self
- Sets id
- setMatchedEntities() : self
- Sets matched_entities
- setName() : self
- Sets name
- setScope() : self
- Sets scope
- setStartAt() : self
- Sets start_at
- setStatus() : self
- Sets status
- setSuccessThresholdPercent() : self
- Sets success_threshold_percent
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setThresholdStatus() : self
- Sets threshold_status
- setTotalEntities() : self
- Sets total_entities
- setUnmatchedEntities() : self
- Sets unmatched_entities
- 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
SCOPE_INBOX
public
mixed
SCOPE_INBOX
= 'INBOX'
SCOPE_PHONE
public
mixed
SCOPE_PHONE
= 'PHONE'
STATUS_COMPLETE
public
mixed
STATUS_COMPLETE
= 'COMPLETE'
STATUS_CREATED
public
mixed
STATUS_CREATED
= 'CREATED'
STATUS_FAILED
public
mixed
STATUS_FAILED
= 'FAILED'
STATUS_PAUSED
public
mixed
STATUS_PAUSED
= 'PAUSED'
STATUS_RUNNING
public
mixed
STATUS_RUNNING
= 'RUNNING'
STATUS_SCHEDULED
public
mixed
STATUS_SCHEDULED
= 'SCHEDULED'
STATUS_STOPPED
public
mixed
STATUS_STOPPED
= 'STOPPED'
THRESHOLD_STATUS_FAILING
public
mixed
THRESHOLD_STATUS_FAILING
= 'FAILING'
THRESHOLD_STATUS_NOT_CONFIGURED
public
mixed
THRESHOLD_STATUS_NOT_CONFIGURED
= 'NOT_CONFIGURED'
THRESHOLD_STATUS_PASSING
public
mixed
THRESHOLD_STATUS_PASSING
= 'PASSING'
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', 'name' => 'name', 'scope' => 'scope', 'status' => 'status', 'created_at' => 'createdAt', 'start_at' => 'startAt', 'completed_at' => 'completedAt', 'total_entities' => 'totalEntities', 'matched_entities' => 'matchedEntities', 'unmatched_entities' => 'unmatchedEntities', 'completion_percentage' => 'completionPercentage', 'success_threshold_percent' => 'successThresholdPercent', 'threshold_status' => 'thresholdStatus']
$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', 'name' => 'getName', 'scope' => 'getScope', 'status' => 'getStatus', 'created_at' => 'getCreatedAt', 'start_at' => 'getStartAt', 'completed_at' => 'getCompletedAt', 'total_entities' => 'getTotalEntities', 'matched_entities' => 'getMatchedEntities', 'unmatched_entities' => 'getUnmatchedEntities', 'completion_percentage' => 'getCompletionPercentage', 'success_threshold_percent' => 'getSuccessThresholdPercent', 'threshold_status' => 'getThresholdStatus']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'name' => null, 'scope' => null, 'status' => null, 'created_at' => 'date-time', 'start_at' => 'date-time', 'completed_at' => 'date-time', 'total_entities' => 'int64', 'matched_entities' => 'int64', 'unmatched_entities' => 'int64', 'completion_percentage' => 'double', 'success_threshold_percent' => 'double', 'threshold_status' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'DeliverabilityAnalyticsRunDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'name' => true, 'scope' => false, 'status' => false, 'created_at' => false, 'start_at' => false, 'completed_at' => true, 'total_entities' => false, 'matched_entities' => false, 'unmatched_entities' => false, 'completion_percentage' => false, 'success_threshold_percent' => true, 'threshold_status' => 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', 'name' => 'string', 'scope' => 'string', 'status' => 'string', 'created_at' => '\\DateTime', 'start_at' => '\\DateTime', 'completed_at' => '\\DateTime', 'total_entities' => 'int', 'matched_entities' => 'int', 'unmatched_entities' => 'int', 'completion_percentage' => 'float', 'success_threshold_percent' => 'float', 'threshold_status' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'name' => 'setName', 'scope' => 'setScope', 'status' => 'setStatus', 'created_at' => 'setCreatedAt', 'start_at' => 'setStartAt', 'completed_at' => 'setCompletedAt', 'total_entities' => 'setTotalEntities', 'matched_entities' => 'setMatchedEntities', 'unmatched_entities' => 'setUnmatchedEntities', 'completion_percentage' => 'setCompletionPercentage', 'success_threshold_percent' => 'setSuccessThresholdPercent', 'threshold_status' => 'setThresholdStatus']
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> —getCompletedAt()
Gets completed_at
public
getCompletedAt() : DateTime|null
Return values
DateTime|null —getCompletionPercentage()
Gets completion_percentage
public
getCompletionPercentage() : float
Return values
float —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getId()
Gets id
public
getId() : string
Return values
string —getMatchedEntities()
Gets matched_entities
public
getMatchedEntities() : int
Return values
int —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getScope()
Gets scope
public
getScope() : string
Return values
string —getScopeAllowableValues()
Gets allowable values of the enum
public
getScopeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getStartAt()
Gets start_at
public
getStartAt() : DateTime
Return values
DateTime —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> —getSuccessThresholdPercent()
Gets success_threshold_percent
public
getSuccessThresholdPercent() : float|null
Return values
float|null —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getThresholdStatus()
Gets threshold_status
public
getThresholdStatus() : string
Return values
string —getThresholdStatusAllowableValues()
Gets allowable values of the enum
public
getThresholdStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getTotalEntities()
Gets total_entities
public
getTotalEntities() : int
Return values
int —getUnmatchedEntities()
Gets unmatched_entities
public
getUnmatchedEntities() : int
Return values
int —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> —setCompletedAt()
Sets completed_at
public
setCompletedAt(DateTime|null $completed_at) : self
Parameters
- $completed_at : DateTime|null
-
completed_at
Return values
self —setCompletionPercentage()
Sets completion_percentage
public
setCompletionPercentage(float $completion_percentage) : self
Parameters
- $completion_percentage : float
-
completion_percentage
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setMatchedEntities()
Sets matched_entities
public
setMatchedEntities(int $matched_entities) : self
Parameters
- $matched_entities : int
-
matched_entities
Return values
self —setName()
Sets name
public
setName(string|null $name) : self
Parameters
- $name : string|null
-
name
Return values
self —setScope()
Sets scope
public
setScope(string $scope) : self
Parameters
- $scope : string
-
scope
Return values
self —setStartAt()
Sets start_at
public
setStartAt(DateTime $start_at) : self
Parameters
- $start_at : DateTime
-
start_at
Return values
self —setStatus()
Sets status
public
setStatus(string $status) : self
Parameters
- $status : string
-
status
Return values
self —setSuccessThresholdPercent()
Sets success_threshold_percent
public
setSuccessThresholdPercent(float|null $success_threshold_percent) : self
Parameters
- $success_threshold_percent : float|null
-
success_threshold_percent
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> —setThresholdStatus()
Sets threshold_status
public
setThresholdStatus(string $threshold_status) : self
Parameters
- $threshold_status : string
-
threshold_status
Return values
self —setTotalEntities()
Sets total_entities
public
setTotalEntities(int $total_entities) : self
Parameters
- $total_entities : int
-
total_entities
Return values
self —setUnmatchedEntities()
Sets unmatched_entities
public
setUnmatchedEntities(int $unmatched_entities) : self
Parameters
- $unmatched_entities : int
-
unmatched_entities
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>