InboxPlacementProviderBreakdownDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
InboxPlacementProviderBreakdownDto 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
- getDeliveredRatePercentage() : float
- Gets delivered_rate_percentage
- getDeliveredTargets() : int
- Gets delivered_targets
- getInboxRatePercentage() : float
- Gets inbox_rate_percentage
- getInboxTargets() : int
- Gets inbox_targets
- getModelName() : string
- The original name of the model.
- getNotReceivedRatePercentage() : float
- Gets not_received_rate_percentage
- getNotReceivedTargets() : int
- Gets not_received_targets
- getProvider() : string
- Gets provider
- getSpamRatePercentage() : float
- Gets spam_rate_percentage
- getSpamTargets() : int
- Gets spam_targets
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTotalTargets() : int
- Gets total_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
- setDeliveredRatePercentage() : self
- Sets delivered_rate_percentage
- setDeliveredTargets() : self
- Sets delivered_targets
- setInboxRatePercentage() : self
- Sets inbox_rate_percentage
- setInboxTargets() : self
- Sets inbox_targets
- setNotReceivedRatePercentage() : self
- Sets not_received_rate_percentage
- setNotReceivedTargets() : self
- Sets not_received_targets
- setProvider() : self
- Sets provider
- setSpamRatePercentage() : self
- Sets spam_rate_percentage
- setSpamTargets() : self
- Sets spam_targets
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTotalTargets() : self
- Sets total_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
= ['provider' => 'provider', 'total_targets' => 'totalTargets', 'delivered_targets' => 'deliveredTargets', 'inbox_targets' => 'inboxTargets', 'spam_targets' => 'spamTargets', 'not_received_targets' => 'notReceivedTargets', 'delivered_rate_percentage' => 'deliveredRatePercentage', 'inbox_rate_percentage' => 'inboxRatePercentage', 'spam_rate_percentage' => 'spamRatePercentage', 'not_received_rate_percentage' => 'notReceivedRatePercentage']
$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
= ['provider' => 'getProvider', 'total_targets' => 'getTotalTargets', 'delivered_targets' => 'getDeliveredTargets', 'inbox_targets' => 'getInboxTargets', 'spam_targets' => 'getSpamTargets', 'not_received_targets' => 'getNotReceivedTargets', 'delivered_rate_percentage' => 'getDeliveredRatePercentage', 'inbox_rate_percentage' => 'getInboxRatePercentage', 'spam_rate_percentage' => 'getSpamRatePercentage', 'not_received_rate_percentage' => 'getNotReceivedRatePercentage']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['provider' => null, 'total_targets' => 'int64', 'delivered_targets' => 'int64', 'inbox_targets' => 'int64', 'spam_targets' => 'int64', 'not_received_targets' => 'int64', 'delivered_rate_percentage' => 'double', 'inbox_rate_percentage' => 'double', 'spam_rate_percentage' => 'double', 'not_received_rate_percentage' => 'double']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'InboxPlacementProviderBreakdownDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['provider' => false, 'total_targets' => false, 'delivered_targets' => false, 'inbox_targets' => false, 'spam_targets' => false, 'not_received_targets' => false, 'delivered_rate_percentage' => false, 'inbox_rate_percentage' => false, 'spam_rate_percentage' => false, '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
= ['provider' => 'string', 'total_targets' => 'int', 'delivered_targets' => 'int', 'inbox_targets' => 'int', 'spam_targets' => 'int', 'not_received_targets' => 'int', 'delivered_rate_percentage' => 'float', 'inbox_rate_percentage' => 'float', 'spam_rate_percentage' => 'float', 'not_received_rate_percentage' => 'float']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['provider' => 'setProvider', 'total_targets' => 'setTotalTargets', 'delivered_targets' => 'setDeliveredTargets', 'inbox_targets' => 'setInboxTargets', 'spam_targets' => 'setSpamTargets', 'not_received_targets' => 'setNotReceivedTargets', 'delivered_rate_percentage' => 'setDeliveredRatePercentage', 'inbox_rate_percentage' => 'setInboxRatePercentage', 'spam_rate_percentage' => 'setSpamRatePercentage', 'not_received_rate_percentage' => 'setNotReceivedRatePercentage']
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> —getDeliveredRatePercentage()
Gets delivered_rate_percentage
public
getDeliveredRatePercentage() : float
Return values
float —getDeliveredTargets()
Gets delivered_targets
public
getDeliveredTargets() : int
Return values
int —getInboxRatePercentage()
Gets inbox_rate_percentage
public
getInboxRatePercentage() : float
Return values
float —getInboxTargets()
Gets inbox_targets
public
getInboxTargets() : int
Return values
int —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getNotReceivedRatePercentage()
Gets not_received_rate_percentage
public
getNotReceivedRatePercentage() : float
Return values
float —getNotReceivedTargets()
Gets not_received_targets
public
getNotReceivedTargets() : int
Return values
int —getProvider()
Gets provider
public
getProvider() : string
Return values
string —getSpamRatePercentage()
Gets spam_rate_percentage
public
getSpamRatePercentage() : float
Return values
float —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> —getTotalTargets()
Gets total_targets
public
getTotalTargets() : 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> —setDeliveredRatePercentage()
Sets delivered_rate_percentage
public
setDeliveredRatePercentage(float $delivered_rate_percentage) : self
Parameters
- $delivered_rate_percentage : float
-
delivered_rate_percentage
Return values
self —setDeliveredTargets()
Sets delivered_targets
public
setDeliveredTargets(int $delivered_targets) : self
Parameters
- $delivered_targets : int
-
delivered_targets
Return values
self —setInboxRatePercentage()
Sets inbox_rate_percentage
public
setInboxRatePercentage(float $inbox_rate_percentage) : self
Parameters
- $inbox_rate_percentage : float
-
inbox_rate_percentage
Return values
self —setInboxTargets()
Sets inbox_targets
public
setInboxTargets(int $inbox_targets) : self
Parameters
- $inbox_targets : int
-
inbox_targets
Return values
self —setNotReceivedRatePercentage()
Sets not_received_rate_percentage
public
setNotReceivedRatePercentage(float $not_received_rate_percentage) : self
Parameters
- $not_received_rate_percentage : float
-
not_received_rate_percentage
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 —setProvider()
Sets provider
public
setProvider(string $provider) : self
Parameters
- $provider : string
-
provider
Return values
self —setSpamRatePercentage()
Sets spam_rate_percentage
public
setSpamRatePercentage(float $spam_rate_percentage) : self
Parameters
- $spam_rate_percentage : float
-
spam_rate_percentage
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> —setTotalTargets()
Sets total_targets
public
setTotalTargets(int $total_targets) : self
Parameters
- $total_targets : int
-
total_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>