InboxPlacementAnalyticsSummaryDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
InboxPlacementAnalyticsSummaryDto 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
- getActiveRuns() : int
- Gets active_runs
- getAverageDeliveredRatePercentage() : float
- Gets average_delivered_rate_percentage
- getAverageInboxRatePercentage() : float
- Gets average_inbox_rate_percentage
- getAverageNotReceivedRatePercentage() : float
- Gets average_not_received_rate_percentage
- getAveragePromotionRatePercentage() : float
- Gets average_promotion_rate_percentage
- getAverageSpamRatePercentage() : float
- Gets average_spam_rate_percentage
- getCompletedRuns() : int
- Gets completed_runs
- getDeliveredTargets() : int
- Gets delivered_targets
- getFailedRuns() : int
- Gets failed_runs
- getForumTargets() : int
- Gets forum_targets
- getInboxTargets() : int
- Gets inbox_targets
- getMatchedTargets() : int
- Gets matched_targets
- getModelName() : string
- The original name of the model.
- getNotReceivedTargets() : int
- Gets not_received_targets
- getOtherFolderTargets() : int
- Gets other_folder_targets
- getPromotionTargets() : int
- Gets promotion_targets
- getSocialTargets() : int
- Gets social_targets
- getSpamTargets() : int
- Gets spam_targets
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTotalRuns() : int
- Gets total_runs
- getTotalTargets() : int
- Gets total_targets
- getUpdateTargets() : int
- Gets update_targets
- 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
- setActiveRuns() : self
- Sets active_runs
- setAverageDeliveredRatePercentage() : self
- Sets average_delivered_rate_percentage
- setAverageInboxRatePercentage() : self
- Sets average_inbox_rate_percentage
- setAverageNotReceivedRatePercentage() : self
- Sets average_not_received_rate_percentage
- setAveragePromotionRatePercentage() : self
- Sets average_promotion_rate_percentage
- setAverageSpamRatePercentage() : self
- Sets average_spam_rate_percentage
- setCompletedRuns() : self
- Sets completed_runs
- setDeliveredTargets() : self
- Sets delivered_targets
- setFailedRuns() : self
- Sets failed_runs
- setForumTargets() : self
- Sets forum_targets
- setInboxTargets() : self
- Sets inbox_targets
- setMatchedTargets() : self
- Sets matched_targets
- setNotReceivedTargets() : self
- Sets not_received_targets
- setOtherFolderTargets() : self
- Sets other_folder_targets
- setPromotionTargets() : self
- Sets promotion_targets
- setSocialTargets() : self
- Sets social_targets
- setSpamTargets() : self
- Sets spam_targets
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTotalRuns() : self
- Sets total_runs
- setTotalTargets() : self
- Sets total_targets
- setUpdateTargets() : self
- Sets update_targets
- 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', 'completed_runs' => 'completedRuns', 'active_runs' => 'activeRuns', 'failed_runs' => 'failedRuns', 'total_targets' => 'totalTargets', 'matched_targets' => 'matchedTargets', 'delivered_targets' => 'deliveredTargets', 'inbox_targets' => 'inboxTargets', 'spam_targets' => 'spamTargets', 'promotion_targets' => 'promotionTargets', 'social_targets' => 'socialTargets', 'update_targets' => 'updateTargets', 'forum_targets' => 'forumTargets', 'other_folder_targets' => 'otherFolderTargets', 'not_received_targets' => 'notReceivedTargets', 'average_delivered_rate_percentage' => 'averageDeliveredRatePercentage', 'average_inbox_rate_percentage' => 'averageInboxRatePercentage', 'average_spam_rate_percentage' => 'averageSpamRatePercentage', 'average_promotion_rate_percentage' => 'averagePromotionRatePercentage', 'average_not_received_rate_percentage' => 'averageNotReceivedRatePercentage']
$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', 'completed_runs' => 'getCompletedRuns', 'active_runs' => 'getActiveRuns', 'failed_runs' => 'getFailedRuns', 'total_targets' => 'getTotalTargets', 'matched_targets' => 'getMatchedTargets', 'delivered_targets' => 'getDeliveredTargets', 'inbox_targets' => 'getInboxTargets', 'spam_targets' => 'getSpamTargets', 'promotion_targets' => 'getPromotionTargets', 'social_targets' => 'getSocialTargets', 'update_targets' => 'getUpdateTargets', 'forum_targets' => 'getForumTargets', 'other_folder_targets' => 'getOtherFolderTargets', 'not_received_targets' => 'getNotReceivedTargets', 'average_delivered_rate_percentage' => 'getAverageDeliveredRatePercentage', 'average_inbox_rate_percentage' => 'getAverageInboxRatePercentage', 'average_spam_rate_percentage' => 'getAverageSpamRatePercentage', 'average_promotion_rate_percentage' => 'getAveragePromotionRatePercentage', 'average_not_received_rate_percentage' => 'getAverageNotReceivedRatePercentage']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['total_runs' => 'int64', 'completed_runs' => 'int64', 'active_runs' => 'int64', 'failed_runs' => 'int64', 'total_targets' => 'int64', 'matched_targets' => 'int64', 'delivered_targets' => 'int64', 'inbox_targets' => 'int64', 'spam_targets' => 'int64', 'promotion_targets' => 'int64', 'social_targets' => 'int64', 'update_targets' => 'int64', 'forum_targets' => 'int64', 'other_folder_targets' => 'int64', 'not_received_targets' => 'int64', 'average_delivered_rate_percentage' => 'double', 'average_inbox_rate_percentage' => 'double', 'average_spam_rate_percentage' => 'double', 'average_promotion_rate_percentage' => 'double', 'average_not_received_rate_percentage' => 'double']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'InboxPlacementAnalyticsSummaryDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['total_runs' => false, 'completed_runs' => false, 'active_runs' => false, 'failed_runs' => false, 'total_targets' => false, 'matched_targets' => false, 'delivered_targets' => false, 'inbox_targets' => false, 'spam_targets' => false, 'promotion_targets' => false, 'social_targets' => false, 'update_targets' => false, 'forum_targets' => false, 'other_folder_targets' => false, 'not_received_targets' => false, 'average_delivered_rate_percentage' => false, 'average_inbox_rate_percentage' => false, 'average_spam_rate_percentage' => false, 'average_promotion_rate_percentage' => false, 'average_not_received_rate_percentage' => 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', 'completed_runs' => 'int', 'active_runs' => 'int', 'failed_runs' => 'int', 'total_targets' => 'int', 'matched_targets' => 'int', 'delivered_targets' => 'int', 'inbox_targets' => 'int', 'spam_targets' => 'int', 'promotion_targets' => 'int', 'social_targets' => 'int', 'update_targets' => 'int', 'forum_targets' => 'int', 'other_folder_targets' => 'int', 'not_received_targets' => 'int', 'average_delivered_rate_percentage' => 'float', 'average_inbox_rate_percentage' => 'float', 'average_spam_rate_percentage' => 'float', 'average_promotion_rate_percentage' => 'float', 'average_not_received_rate_percentage' => 'float']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['total_runs' => 'setTotalRuns', 'completed_runs' => 'setCompletedRuns', 'active_runs' => 'setActiveRuns', 'failed_runs' => 'setFailedRuns', 'total_targets' => 'setTotalTargets', 'matched_targets' => 'setMatchedTargets', 'delivered_targets' => 'setDeliveredTargets', 'inbox_targets' => 'setInboxTargets', 'spam_targets' => 'setSpamTargets', 'promotion_targets' => 'setPromotionTargets', 'social_targets' => 'setSocialTargets', 'update_targets' => 'setUpdateTargets', 'forum_targets' => 'setForumTargets', 'other_folder_targets' => 'setOtherFolderTargets', 'not_received_targets' => 'setNotReceivedTargets', 'average_delivered_rate_percentage' => 'setAverageDeliveredRatePercentage', 'average_inbox_rate_percentage' => 'setAverageInboxRatePercentage', 'average_spam_rate_percentage' => 'setAverageSpamRatePercentage', 'average_promotion_rate_percentage' => 'setAveragePromotionRatePercentage', 'average_not_received_rate_percentage' => 'setAverageNotReceivedRatePercentage']
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> —getActiveRuns()
Gets active_runs
public
getActiveRuns() : int
Return values
int —getAverageDeliveredRatePercentage()
Gets average_delivered_rate_percentage
public
getAverageDeliveredRatePercentage() : float
Return values
float —getAverageInboxRatePercentage()
Gets average_inbox_rate_percentage
public
getAverageInboxRatePercentage() : float
Return values
float —getAverageNotReceivedRatePercentage()
Gets average_not_received_rate_percentage
public
getAverageNotReceivedRatePercentage() : float
Return values
float —getAveragePromotionRatePercentage()
Gets average_promotion_rate_percentage
public
getAveragePromotionRatePercentage() : float
Return values
float —getAverageSpamRatePercentage()
Gets average_spam_rate_percentage
public
getAverageSpamRatePercentage() : float
Return values
float —getCompletedRuns()
Gets completed_runs
public
getCompletedRuns() : int
Return values
int —getDeliveredTargets()
Gets delivered_targets
public
getDeliveredTargets() : int
Return values
int —getFailedRuns()
Gets failed_runs
public
getFailedRuns() : int
Return values
int —getForumTargets()
Gets forum_targets
public
getForumTargets() : int
Return values
int —getInboxTargets()
Gets inbox_targets
public
getInboxTargets() : int
Return values
int —getMatchedTargets()
Gets matched_targets
public
getMatchedTargets() : int
Return values
int —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getNotReceivedTargets()
Gets not_received_targets
public
getNotReceivedTargets() : int
Return values
int —getOtherFolderTargets()
Gets other_folder_targets
public
getOtherFolderTargets() : int
Return values
int —getPromotionTargets()
Gets promotion_targets
public
getPromotionTargets() : int
Return values
int —getSocialTargets()
Gets social_targets
public
getSocialTargets() : int
Return values
int —getSpamTargets()
Gets spam_targets
public
getSpamTargets() : 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> —getTotalRuns()
Gets total_runs
public
getTotalRuns() : int
Return values
int —getTotalTargets()
Gets total_targets
public
getTotalTargets() : int
Return values
int —getUpdateTargets()
Gets update_targets
public
getUpdateTargets() : 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> —setActiveRuns()
Sets active_runs
public
setActiveRuns(int $active_runs) : self
Parameters
- $active_runs : int
-
active_runs
Return values
self —setAverageDeliveredRatePercentage()
Sets average_delivered_rate_percentage
public
setAverageDeliveredRatePercentage(float $average_delivered_rate_percentage) : self
Parameters
- $average_delivered_rate_percentage : float
-
average_delivered_rate_percentage
Return values
self —setAverageInboxRatePercentage()
Sets average_inbox_rate_percentage
public
setAverageInboxRatePercentage(float $average_inbox_rate_percentage) : self
Parameters
- $average_inbox_rate_percentage : float
-
average_inbox_rate_percentage
Return values
self —setAverageNotReceivedRatePercentage()
Sets average_not_received_rate_percentage
public
setAverageNotReceivedRatePercentage(float $average_not_received_rate_percentage) : self
Parameters
- $average_not_received_rate_percentage : float
-
average_not_received_rate_percentage
Return values
self —setAveragePromotionRatePercentage()
Sets average_promotion_rate_percentage
public
setAveragePromotionRatePercentage(float $average_promotion_rate_percentage) : self
Parameters
- $average_promotion_rate_percentage : float
-
average_promotion_rate_percentage
Return values
self —setAverageSpamRatePercentage()
Sets average_spam_rate_percentage
public
setAverageSpamRatePercentage(float $average_spam_rate_percentage) : self
Parameters
- $average_spam_rate_percentage : float
-
average_spam_rate_percentage
Return values
self —setCompletedRuns()
Sets completed_runs
public
setCompletedRuns(int $completed_runs) : self
Parameters
- $completed_runs : int
-
completed_runs
Return values
self —setDeliveredTargets()
Sets delivered_targets
public
setDeliveredTargets(int $delivered_targets) : self
Parameters
- $delivered_targets : int
-
delivered_targets
Return values
self —setFailedRuns()
Sets failed_runs
public
setFailedRuns(int $failed_runs) : self
Parameters
- $failed_runs : int
-
failed_runs
Return values
self —setForumTargets()
Sets forum_targets
public
setForumTargets(int $forum_targets) : self
Parameters
- $forum_targets : int
-
forum_targets
Return values
self —setInboxTargets()
Sets inbox_targets
public
setInboxTargets(int $inbox_targets) : self
Parameters
- $inbox_targets : int
-
inbox_targets
Return values
self —setMatchedTargets()
Sets matched_targets
public
setMatchedTargets(int $matched_targets) : self
Parameters
- $matched_targets : int
-
matched_targets
Return values
self —setNotReceivedTargets()
Sets not_received_targets
public
setNotReceivedTargets(int $not_received_targets) : self
Parameters
- $not_received_targets : int
-
not_received_targets
Return values
self —setOtherFolderTargets()
Sets other_folder_targets
public
setOtherFolderTargets(int $other_folder_targets) : self
Parameters
- $other_folder_targets : int
-
other_folder_targets
Return values
self —setPromotionTargets()
Sets promotion_targets
public
setPromotionTargets(int $promotion_targets) : self
Parameters
- $promotion_targets : int
-
promotion_targets
Return values
self —setSocialTargets()
Sets social_targets
public
setSocialTargets(int $social_targets) : self
Parameters
- $social_targets : int
-
social_targets
Return values
self —setSpamTargets()
Sets spam_targets
public
setSpamTargets(int $spam_targets) : self
Parameters
- $spam_targets : int
-
spam_targets
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> —setTotalRuns()
Sets total_runs
public
setTotalRuns(int $total_runs) : self
Parameters
- $total_runs : int
-
total_runs
Return values
self —setTotalTargets()
Sets total_targets
public
setTotalTargets(int $total_targets) : self
Parameters
- $total_targets : int
-
total_targets
Return values
self —setUpdateTargets()
Sets update_targets
public
setUpdateTargets(int $update_targets) : self
Parameters
- $update_targets : int
-
update_targets
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>