PostmasterTrafficStatsDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
PostmasterTrafficStatsDto 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
- getDkimSuccessRatio() : float|null
- Gets dkim_success_ratio
- getDmarcSuccessRatio() : float|null
- Gets dmarc_success_ratio
- getDomain() : string
- Gets domain
- getDomainReputation() : string|null
- Gets domain_reputation
- getInboundEncryptionRatio() : float|null
- Gets inbound_encryption_ratio
- getIpReputations() : array<string|int, PostmasterIpReputationDto>
- Gets ip_reputations
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getOutboundEncryptionRatio() : float|null
- Gets outbound_encryption_ratio
- getPayload() : object
- Gets payload
- getReportDate() : DateTime|null
- Gets report_date
- getSpfSuccessRatio() : float|null
- Gets spf_success_ratio
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUserReportedSpamRatio() : float|null
- Gets user_reported_spam_ratio
- 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
- setDkimSuccessRatio() : self
- Sets dkim_success_ratio
- setDmarcSuccessRatio() : self
- Sets dmarc_success_ratio
- setDomain() : self
- Sets domain
- setDomainReputation() : self
- Sets domain_reputation
- setInboundEncryptionRatio() : self
- Sets inbound_encryption_ratio
- setIpReputations() : self
- Sets ip_reputations
- setName() : self
- Sets name
- setOutboundEncryptionRatio() : self
- Sets outbound_encryption_ratio
- setPayload() : self
- Sets payload
- setReportDate() : self
- Sets report_date
- setSpfSuccessRatio() : self
- Sets spf_success_ratio
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUserReportedSpamRatio() : self
- Sets user_reported_spam_ratio
- 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
= ['name' => 'name', 'domain' => 'domain', 'report_date' => 'reportDate', 'user_reported_spam_ratio' => 'userReportedSpamRatio', 'domain_reputation' => 'domainReputation', 'ip_reputations' => 'ipReputations', 'spf_success_ratio' => 'spfSuccessRatio', 'dkim_success_ratio' => 'dkimSuccessRatio', 'dmarc_success_ratio' => 'dmarcSuccessRatio', 'outbound_encryption_ratio' => 'outboundEncryptionRatio', 'inbound_encryption_ratio' => 'inboundEncryptionRatio', 'payload' => 'payload']
$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
= ['name' => 'getName', 'domain' => 'getDomain', 'report_date' => 'getReportDate', 'user_reported_spam_ratio' => 'getUserReportedSpamRatio', 'domain_reputation' => 'getDomainReputation', 'ip_reputations' => 'getIpReputations', 'spf_success_ratio' => 'getSpfSuccessRatio', 'dkim_success_ratio' => 'getDkimSuccessRatio', 'dmarc_success_ratio' => 'getDmarcSuccessRatio', 'outbound_encryption_ratio' => 'getOutboundEncryptionRatio', 'inbound_encryption_ratio' => 'getInboundEncryptionRatio', 'payload' => 'getPayload']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['name' => null, 'domain' => null, 'report_date' => 'date', 'user_reported_spam_ratio' => 'double', 'domain_reputation' => null, 'ip_reputations' => null, 'spf_success_ratio' => 'double', 'dkim_success_ratio' => 'double', 'dmarc_success_ratio' => 'double', 'outbound_encryption_ratio' => 'double', 'inbound_encryption_ratio' => 'double', 'payload' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'PostmasterTrafficStatsDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['name' => true, 'domain' => false, 'report_date' => true, 'user_reported_spam_ratio' => true, 'domain_reputation' => true, 'ip_reputations' => false, 'spf_success_ratio' => true, 'dkim_success_ratio' => true, 'dmarc_success_ratio' => true, 'outbound_encryption_ratio' => true, 'inbound_encryption_ratio' => true, 'payload' => 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
= ['name' => 'string', 'domain' => 'string', 'report_date' => '\\DateTime', 'user_reported_spam_ratio' => 'float', 'domain_reputation' => 'string', 'ip_reputations' => '\\MailSlurp\\Models\\PostmasterIpReputationDto[]', 'spf_success_ratio' => 'float', 'dkim_success_ratio' => 'float', 'dmarc_success_ratio' => 'float', 'outbound_encryption_ratio' => 'float', 'inbound_encryption_ratio' => 'float', 'payload' => 'object']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['name' => 'setName', 'domain' => 'setDomain', 'report_date' => 'setReportDate', 'user_reported_spam_ratio' => 'setUserReportedSpamRatio', 'domain_reputation' => 'setDomainReputation', 'ip_reputations' => 'setIpReputations', 'spf_success_ratio' => 'setSpfSuccessRatio', 'dkim_success_ratio' => 'setDkimSuccessRatio', 'dmarc_success_ratio' => 'setDmarcSuccessRatio', 'outbound_encryption_ratio' => 'setOutboundEncryptionRatio', 'inbound_encryption_ratio' => 'setInboundEncryptionRatio', 'payload' => 'setPayload']
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> —getDkimSuccessRatio()
Gets dkim_success_ratio
public
getDkimSuccessRatio() : float|null
Return values
float|null —getDmarcSuccessRatio()
Gets dmarc_success_ratio
public
getDmarcSuccessRatio() : float|null
Return values
float|null —getDomain()
Gets domain
public
getDomain() : string
Return values
string —getDomainReputation()
Gets domain_reputation
public
getDomainReputation() : string|null
Return values
string|null —getInboundEncryptionRatio()
Gets inbound_encryption_ratio
public
getInboundEncryptionRatio() : float|null
Return values
float|null —getIpReputations()
Gets ip_reputations
public
getIpReputations() : array<string|int, PostmasterIpReputationDto>
Return values
array<string|int, PostmasterIpReputationDto> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getOutboundEncryptionRatio()
Gets outbound_encryption_ratio
public
getOutboundEncryptionRatio() : float|null
Return values
float|null —getPayload()
Gets payload
public
getPayload() : object
Return values
object —getReportDate()
Gets report_date
public
getReportDate() : DateTime|null
Return values
DateTime|null —getSpfSuccessRatio()
Gets spf_success_ratio
public
getSpfSuccessRatio() : 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> —getUserReportedSpamRatio()
Gets user_reported_spam_ratio
public
getUserReportedSpamRatio() : float|null
Return values
float|null —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> —setDkimSuccessRatio()
Sets dkim_success_ratio
public
setDkimSuccessRatio(float|null $dkim_success_ratio) : self
Parameters
- $dkim_success_ratio : float|null
-
dkim_success_ratio
Return values
self —setDmarcSuccessRatio()
Sets dmarc_success_ratio
public
setDmarcSuccessRatio(float|null $dmarc_success_ratio) : self
Parameters
- $dmarc_success_ratio : float|null
-
dmarc_success_ratio
Return values
self —setDomain()
Sets domain
public
setDomain(string $domain) : self
Parameters
- $domain : string
-
domain
Return values
self —setDomainReputation()
Sets domain_reputation
public
setDomainReputation(string|null $domain_reputation) : self
Parameters
- $domain_reputation : string|null
-
domain_reputation
Return values
self —setInboundEncryptionRatio()
Sets inbound_encryption_ratio
public
setInboundEncryptionRatio(float|null $inbound_encryption_ratio) : self
Parameters
- $inbound_encryption_ratio : float|null
-
inbound_encryption_ratio
Return values
self —setIpReputations()
Sets ip_reputations
public
setIpReputations(array<string|int, PostmasterIpReputationDto> $ip_reputations) : self
Parameters
- $ip_reputations : array<string|int, PostmasterIpReputationDto>
-
ip_reputations
Return values
self —setName()
Sets name
public
setName(string|null $name) : self
Parameters
- $name : string|null
-
name
Return values
self —setOutboundEncryptionRatio()
Sets outbound_encryption_ratio
public
setOutboundEncryptionRatio(float|null $outbound_encryption_ratio) : self
Parameters
- $outbound_encryption_ratio : float|null
-
outbound_encryption_ratio
Return values
self —setPayload()
Sets payload
public
setPayload(object $payload) : self
Parameters
- $payload : object
-
payload
Return values
self —setReportDate()
Sets report_date
public
setReportDate(DateTime|null $report_date) : self
Parameters
- $report_date : DateTime|null
-
report_date
Return values
self —setSpfSuccessRatio()
Sets spf_success_ratio
public
setSpfSuccessRatio(float|null $spf_success_ratio) : self
Parameters
- $spf_success_ratio : float|null
-
spf_success_ratio
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> —setUserReportedSpamRatio()
Sets user_reported_spam_ratio
public
setUserReportedSpamRatio(float|null $user_reported_spam_ratio) : self
Parameters
- $user_reported_spam_ratio : float|null
-
user_reported_spam_ratio
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>