EmailWarmupProviderPlacementDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
EmailWarmupProviderPlacementDto 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
- getInboxCount() : int
- Gets inbox_count
- getInboxPercent() : int
- Gets inbox_percent
- getModelName() : string
- The original name of the model.
- getNotReceivedCount() : int
- Gets not_received_count
- getProvider() : string
- Gets provider
- getSpamCount() : int
- Gets spam_count
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTotalCount() : int
- Gets total_count
- 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
- setInboxCount() : self
- Sets inbox_count
- setInboxPercent() : self
- Sets inbox_percent
- setNotReceivedCount() : self
- Sets not_received_count
- setProvider() : self
- Sets provider
- setSpamCount() : self
- Sets spam_count
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTotalCount() : self
- Sets total_count
- 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_count' => 'totalCount', 'inbox_count' => 'inboxCount', 'spam_count' => 'spamCount', 'not_received_count' => 'notReceivedCount', 'inbox_percent' => 'inboxPercent']
$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_count' => 'getTotalCount', 'inbox_count' => 'getInboxCount', 'spam_count' => 'getSpamCount', 'not_received_count' => 'getNotReceivedCount', 'inbox_percent' => 'getInboxPercent']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['provider' => null, 'total_count' => 'int32', 'inbox_count' => 'int32', 'spam_count' => 'int32', 'not_received_count' => 'int32', 'inbox_percent' => 'int32']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'EmailWarmupProviderPlacementDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['provider' => false, 'total_count' => false, 'inbox_count' => false, 'spam_count' => false, 'not_received_count' => false, 'inbox_percent' => 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_count' => 'int', 'inbox_count' => 'int', 'spam_count' => 'int', 'not_received_count' => 'int', 'inbox_percent' => 'int']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['provider' => 'setProvider', 'total_count' => 'setTotalCount', 'inbox_count' => 'setInboxCount', 'spam_count' => 'setSpamCount', 'not_received_count' => 'setNotReceivedCount', 'inbox_percent' => 'setInboxPercent']
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> —getInboxCount()
Gets inbox_count
public
getInboxCount() : int
Return values
int —getInboxPercent()
Gets inbox_percent
public
getInboxPercent() : int
Return values
int —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getNotReceivedCount()
Gets not_received_count
public
getNotReceivedCount() : int
Return values
int —getProvider()
Gets provider
public
getProvider() : string
Return values
string —getSpamCount()
Gets spam_count
public
getSpamCount() : 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> —getTotalCount()
Gets total_count
public
getTotalCount() : 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> —setInboxCount()
Sets inbox_count
public
setInboxCount(int $inbox_count) : self
Parameters
- $inbox_count : int
-
inbox_count
Return values
self —setInboxPercent()
Sets inbox_percent
public
setInboxPercent(int $inbox_percent) : self
Parameters
- $inbox_percent : int
-
inbox_percent
Return values
self —setNotReceivedCount()
Sets not_received_count
public
setNotReceivedCount(int $not_received_count) : self
Parameters
- $not_received_count : int
-
not_received_count
Return values
self —setProvider()
Sets provider
public
setProvider(string $provider) : self
Parameters
- $provider : string
-
provider
Return values
self —setSpamCount()
Sets spam_count
public
setSpamCount(int $spam_count) : self
Parameters
- $spam_count : int
-
spam_count
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> —setTotalCount()
Sets total_count
public
setTotalCount(int $total_count) : self
Parameters
- $total_count : int
-
total_count
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>