DeliverabilityAnalyticsSummaryDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
DeliverabilityAnalyticsSummaryDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- $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
- getAverageCompletionPercentage() : float
- Gets average_completion_percentage
- getAverageMatchedEntities() : float
- Gets average_matched_entities
- getAverageUnmatchedEntities() : float
- Gets average_unmatched_entities
- getCompleteRuns() : int
- Gets complete_runs
- getCreatedRuns() : int
- Gets created_runs
- getFailedRuns() : int
- Gets failed_runs
- getModelName() : string
- The original name of the model.
- getPausedRuns() : int
- Gets paused_runs
- getRunningRuns() : int
- Gets running_runs
- getScheduledRuns() : int
- Gets scheduled_runs
- getStoppedRuns() : int
- Gets stopped_runs
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getThresholdConfiguredRuns() : int
- Gets threshold_configured_runs
- getThresholdMetRuns() : int
- Gets threshold_met_runs
- getTotalRuns() : int
- Gets total_runs
- 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
- setAverageCompletionPercentage() : self
- Sets average_completion_percentage
- setAverageMatchedEntities() : self
- Sets average_matched_entities
- setAverageUnmatchedEntities() : self
- Sets average_unmatched_entities
- setCompleteRuns() : self
- Sets complete_runs
- setCreatedRuns() : self
- Sets created_runs
- setFailedRuns() : self
- Sets failed_runs
- setPausedRuns() : self
- Sets paused_runs
- setRunningRuns() : self
- Sets running_runs
- setScheduledRuns() : self
- Sets scheduled_runs
- setStoppedRuns() : self
- Sets stopped_runs
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setThresholdConfiguredRuns() : self
- Sets threshold_configured_runs
- setThresholdMetRuns() : self
- Sets threshold_met_runs
- setTotalRuns() : self
- Sets total_runs
- 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
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
= ['total_runs' => 'totalRuns', 'complete_runs' => 'completeRuns', 'failed_runs' => 'failedRuns', 'stopped_runs' => 'stoppedRuns', 'running_runs' => 'runningRuns', 'scheduled_runs' => 'scheduledRuns', 'paused_runs' => 'pausedRuns', 'created_runs' => 'createdRuns', 'threshold_configured_runs' => 'thresholdConfiguredRuns', 'threshold_met_runs' => 'thresholdMetRuns', 'average_completion_percentage' => 'averageCompletionPercentage', 'average_matched_entities' => 'averageMatchedEntities', 'average_unmatched_entities' => 'averageUnmatchedEntities']
$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
= ['total_runs' => 'getTotalRuns', 'complete_runs' => 'getCompleteRuns', 'failed_runs' => 'getFailedRuns', 'stopped_runs' => 'getStoppedRuns', 'running_runs' => 'getRunningRuns', 'scheduled_runs' => 'getScheduledRuns', 'paused_runs' => 'getPausedRuns', 'created_runs' => 'getCreatedRuns', 'threshold_configured_runs' => 'getThresholdConfiguredRuns', 'threshold_met_runs' => 'getThresholdMetRuns', 'average_completion_percentage' => 'getAverageCompletionPercentage', 'average_matched_entities' => 'getAverageMatchedEntities', 'average_unmatched_entities' => 'getAverageUnmatchedEntities']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['total_runs' => 'int64', 'complete_runs' => 'int64', 'failed_runs' => 'int64', 'stopped_runs' => 'int64', 'running_runs' => 'int64', 'scheduled_runs' => 'int64', 'paused_runs' => 'int64', 'created_runs' => 'int64', 'threshold_configured_runs' => 'int64', 'threshold_met_runs' => 'int64', 'average_completion_percentage' => 'double', 'average_matched_entities' => 'double', 'average_unmatched_entities' => 'double']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'DeliverabilityAnalyticsSummaryDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['total_runs' => false, 'complete_runs' => false, 'failed_runs' => false, 'stopped_runs' => false, 'running_runs' => false, 'scheduled_runs' => false, 'paused_runs' => false, 'created_runs' => false, 'threshold_configured_runs' => false, 'threshold_met_runs' => false, 'average_completion_percentage' => false, 'average_matched_entities' => false, 'average_unmatched_entities' => 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
= ['total_runs' => 'int', 'complete_runs' => 'int', 'failed_runs' => 'int', 'stopped_runs' => 'int', 'running_runs' => 'int', 'scheduled_runs' => 'int', 'paused_runs' => 'int', 'created_runs' => 'int', 'threshold_configured_runs' => 'int', 'threshold_met_runs' => 'int', 'average_completion_percentage' => 'float', 'average_matched_entities' => 'float', 'average_unmatched_entities' => 'float']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['total_runs' => 'setTotalRuns', 'complete_runs' => 'setCompleteRuns', 'failed_runs' => 'setFailedRuns', 'stopped_runs' => 'setStoppedRuns', 'running_runs' => 'setRunningRuns', 'scheduled_runs' => 'setScheduledRuns', 'paused_runs' => 'setPausedRuns', 'created_runs' => 'setCreatedRuns', 'threshold_configured_runs' => 'setThresholdConfiguredRuns', 'threshold_met_runs' => 'setThresholdMetRuns', 'average_completion_percentage' => 'setAverageCompletionPercentage', 'average_matched_entities' => 'setAverageMatchedEntities', 'average_unmatched_entities' => 'setAverageUnmatchedEntities']
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> —getAverageCompletionPercentage()
Gets average_completion_percentage
public
getAverageCompletionPercentage() : float
Return values
float —getAverageMatchedEntities()
Gets average_matched_entities
public
getAverageMatchedEntities() : float
Return values
float —getAverageUnmatchedEntities()
Gets average_unmatched_entities
public
getAverageUnmatchedEntities() : float
Return values
float —getCompleteRuns()
Gets complete_runs
public
getCompleteRuns() : int
Return values
int —getCreatedRuns()
Gets created_runs
public
getCreatedRuns() : int
Return values
int —getFailedRuns()
Gets failed_runs
public
getFailedRuns() : int
Return values
int —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPausedRuns()
Gets paused_runs
public
getPausedRuns() : int
Return values
int —getRunningRuns()
Gets running_runs
public
getRunningRuns() : int
Return values
int —getScheduledRuns()
Gets scheduled_runs
public
getScheduledRuns() : int
Return values
int —getStoppedRuns()
Gets stopped_runs
public
getStoppedRuns() : 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> —getThresholdConfiguredRuns()
Gets threshold_configured_runs
public
getThresholdConfiguredRuns() : int
Return values
int —getThresholdMetRuns()
Gets threshold_met_runs
public
getThresholdMetRuns() : int
Return values
int —getTotalRuns()
Gets total_runs
public
getTotalRuns() : 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> —setAverageCompletionPercentage()
Sets average_completion_percentage
public
setAverageCompletionPercentage(float $average_completion_percentage) : self
Parameters
- $average_completion_percentage : float
-
average_completion_percentage
Return values
self —setAverageMatchedEntities()
Sets average_matched_entities
public
setAverageMatchedEntities(float $average_matched_entities) : self
Parameters
- $average_matched_entities : float
-
average_matched_entities
Return values
self —setAverageUnmatchedEntities()
Sets average_unmatched_entities
public
setAverageUnmatchedEntities(float $average_unmatched_entities) : self
Parameters
- $average_unmatched_entities : float
-
average_unmatched_entities
Return values
self —setCompleteRuns()
Sets complete_runs
public
setCompleteRuns(int $complete_runs) : self
Parameters
- $complete_runs : int
-
complete_runs
Return values
self —setCreatedRuns()
Sets created_runs
public
setCreatedRuns(int $created_runs) : self
Parameters
- $created_runs : int
-
created_runs
Return values
self —setFailedRuns()
Sets failed_runs
public
setFailedRuns(int $failed_runs) : self
Parameters
- $failed_runs : int
-
failed_runs
Return values
self —setPausedRuns()
Sets paused_runs
public
setPausedRuns(int $paused_runs) : self
Parameters
- $paused_runs : int
-
paused_runs
Return values
self —setRunningRuns()
Sets running_runs
public
setRunningRuns(int $running_runs) : self
Parameters
- $running_runs : int
-
running_runs
Return values
self —setScheduledRuns()
Sets scheduled_runs
public
setScheduledRuns(int $scheduled_runs) : self
Parameters
- $scheduled_runs : int
-
scheduled_runs
Return values
self —setStoppedRuns()
Sets stopped_runs
public
setStoppedRuns(int $stopped_runs) : self
Parameters
- $stopped_runs : int
-
stopped_runs
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> —setThresholdConfiguredRuns()
Sets threshold_configured_runs
public
setThresholdConfiguredRuns(int $threshold_configured_runs) : self
Parameters
- $threshold_configured_runs : int
-
threshold_configured_runs
Return values
self —setThresholdMetRuns()
Sets threshold_met_runs
public
setThresholdMetRuns(int $threshold_met_runs) : self
Parameters
- $threshold_met_runs : int
-
threshold_met_runs
Return values
self —setTotalRuns()
Sets total_runs
public
setTotalRuns(int $total_runs) : self
Parameters
- $total_runs : int
-
total_runs
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>