Documentation

InboxPlacementAnalyticsRunDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

InboxPlacementAnalyticsRunDto Class Doc Comment

Tags
category

Class

description

Recent inbox placement run row for analytics tables

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

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
getCompletedAt()  : DateTime|null
Gets completed_at
getCreatedAt()  : DateTime
Gets created_at
getDeliveredRatePercentage()  : float
Gets delivered_rate_percentage
getDeliveredTargets()  : int
Gets delivered_targets
getForumTargets()  : int
Gets forum_targets
getFromEmail()  : string|null
Gets from_email
getId()  : string
Gets id
getInboxRatePercentage()  : float
Gets inbox_rate_percentage
getInboxTargets()  : int
Gets inbox_targets
getMatchedTargets()  : int
Gets matched_targets
getModelName()  : string
The original name of the model.
getNotReceivedRatePercentage()  : float
Gets not_received_rate_percentage
getNotReceivedTargets()  : int
Gets not_received_targets
getOtherFolderTargets()  : int
Gets other_folder_targets
getPromotionRatePercentage()  : float
Gets promotion_rate_percentage
getPromotionTargets()  : int
Gets promotion_targets
getRemoteTestId()  : string
Gets remote_test_id
getReportStatus()  : string|null
Gets report_status
getSenderDomain()  : string|null
Gets sender_domain
getSocialTargets()  : int
Gets social_targets
getSpamRatePercentage()  : float
Gets spam_rate_percentage
getSpamTargets()  : int
Gets spam_targets
getStartedAt()  : DateTime|null
Gets started_at
getStatus()  : string|null
Gets status
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
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
setCompletedAt()  : self
Sets completed_at
setCreatedAt()  : self
Sets created_at
setDeliveredRatePercentage()  : self
Sets delivered_rate_percentage
setDeliveredTargets()  : self
Sets delivered_targets
setForumTargets()  : self
Sets forum_targets
setFromEmail()  : self
Sets from_email
setId()  : self
Sets id
setInboxRatePercentage()  : self
Sets inbox_rate_percentage
setInboxTargets()  : self
Sets inbox_targets
setMatchedTargets()  : self
Sets matched_targets
setNotReceivedRatePercentage()  : self
Sets not_received_rate_percentage
setNotReceivedTargets()  : self
Sets not_received_targets
setOtherFolderTargets()  : self
Sets other_folder_targets
setPromotionRatePercentage()  : self
Sets promotion_rate_percentage
setPromotionTargets()  : self
Sets promotion_targets
setRemoteTestId()  : self
Sets remote_test_id
setReportStatus()  : self
Sets report_status
setSenderDomain()  : self
Sets sender_domain
setSocialTargets()  : self
Sets social_targets
setSpamRatePercentage()  : self
Sets spam_rate_percentage
setSpamTargets()  : self
Sets spam_targets
setStartedAt()  : self
Sets started_at
setStatus()  : self
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
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

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 = ['id' => 'id', 'remote_test_id' => 'remoteTestId', 'sender_domain' => 'senderDomain', 'from_email' => 'fromEmail', 'status' => 'status', 'report_status' => 'reportStatus', 'created_at' => 'createdAt', 'started_at' => 'startedAt', 'completed_at' => 'completedAt', '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', 'delivered_rate_percentage' => 'deliveredRatePercentage', 'inbox_rate_percentage' => 'inboxRatePercentage', 'spam_rate_percentage' => 'spamRatePercentage', 'promotion_rate_percentage' => 'promotionRatePercentage', 'not_received_rate_percentage' => 'notReceivedRatePercentage']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['id' => 'getId', 'remote_test_id' => 'getRemoteTestId', 'sender_domain' => 'getSenderDomain', 'from_email' => 'getFromEmail', 'status' => 'getStatus', 'report_status' => 'getReportStatus', 'created_at' => 'getCreatedAt', 'started_at' => 'getStartedAt', 'completed_at' => 'getCompletedAt', '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', 'delivered_rate_percentage' => 'getDeliveredRatePercentage', 'inbox_rate_percentage' => 'getInboxRatePercentage', 'spam_rate_percentage' => 'getSpamRatePercentage', 'promotion_rate_percentage' => 'getPromotionRatePercentage', 'not_received_rate_percentage' => 'getNotReceivedRatePercentage']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $openAPIFormats = ['id' => 'uuid', 'remote_test_id' => 'uuid', 'sender_domain' => null, 'from_email' => null, 'status' => null, 'report_status' => null, 'created_at' => 'date-time', 'started_at' => 'date-time', 'completed_at' => 'date-time', 'total_targets' => 'int32', 'matched_targets' => 'int32', 'delivered_targets' => 'int32', 'inbox_targets' => 'int32', 'spam_targets' => 'int32', 'promotion_targets' => 'int32', 'social_targets' => 'int32', 'update_targets' => 'int32', 'forum_targets' => 'int32', 'other_folder_targets' => 'int32', 'not_received_targets' => 'int32', 'delivered_rate_percentage' => 'double', 'inbox_rate_percentage' => 'double', 'spam_rate_percentage' => 'double', 'promotion_rate_percentage' => 'double', 'not_received_rate_percentage' => 'double']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'InboxPlacementAnalyticsRunDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['id' => false, 'remote_test_id' => false, 'sender_domain' => true, 'from_email' => true, 'status' => true, 'report_status' => true, 'created_at' => false, 'started_at' => true, 'completed_at' => true, '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, 'delivered_rate_percentage' => false, 'inbox_rate_percentage' => false, 'spam_rate_percentage' => false, 'promotion_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 = ['id' => 'string', 'remote_test_id' => 'string', 'sender_domain' => 'string', 'from_email' => 'string', 'status' => 'string', 'report_status' => 'string', 'created_at' => '\\DateTime', 'started_at' => '\\DateTime', 'completed_at' => '\\DateTime', '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', 'delivered_rate_percentage' => 'float', 'inbox_rate_percentage' => 'float', 'spam_rate_percentage' => 'float', 'promotion_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 = ['id' => 'setId', 'remote_test_id' => 'setRemoteTestId', 'sender_domain' => 'setSenderDomain', 'from_email' => 'setFromEmail', 'status' => 'setStatus', 'report_status' => 'setReportStatus', 'created_at' => 'setCreatedAt', 'started_at' => 'setStartedAt', 'completed_at' => 'setCompletedAt', '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', 'delivered_rate_percentage' => 'setDeliveredRatePercentage', 'inbox_rate_percentage' => 'setInboxRatePercentage', 'spam_rate_percentage' => 'setSpamRatePercentage', 'promotion_rate_percentage' => 'setPromotionRatePercentage', '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 —

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 —

getNotReceivedRatePercentage()

Gets not_received_rate_percentage

public getNotReceivedRatePercentage() : float
Return values
float —

getPromotionRatePercentage()

Gets promotion_rate_percentage

public getPromotionRatePercentage() : float
Return values
float —

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

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 —

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> —

setCompletedAt()

Sets completed_at

public setCompletedAt(DateTime|null $completed_at) : self
Parameters
$completed_at : DateTime|null

completed_at

Return values
self —

setCreatedAt()

Sets created_at

public setCreatedAt(DateTime $created_at) : self
Parameters
$created_at : DateTime

created_at

Return values
self —

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 —

setForumTargets()

Sets forum_targets

public setForumTargets(int $forum_targets) : self
Parameters
$forum_targets : int

forum_targets

Return values
self —

setFromEmail()

Sets from_email

public setFromEmail(string|null $from_email) : self
Parameters
$from_email : string|null

from_email

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 —

setMatchedTargets()

Sets matched_targets

public setMatchedTargets(int $matched_targets) : self
Parameters
$matched_targets : int

matched_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 —

setOtherFolderTargets()

Sets other_folder_targets

public setOtherFolderTargets(int $other_folder_targets) : self
Parameters
$other_folder_targets : int

other_folder_targets

Return values
self —

setPromotionRatePercentage()

Sets promotion_rate_percentage

public setPromotionRatePercentage(float $promotion_rate_percentage) : self
Parameters
$promotion_rate_percentage : float

promotion_rate_percentage

Return values
self —

setPromotionTargets()

Sets promotion_targets

public setPromotionTargets(int $promotion_targets) : self
Parameters
$promotion_targets : int

promotion_targets

Return values
self —

setRemoteTestId()

Sets remote_test_id

public setRemoteTestId(string $remote_test_id) : self
Parameters
$remote_test_id : string

remote_test_id

Return values
self —

setReportStatus()

Sets report_status

public setReportStatus(string|null $report_status) : self
Parameters
$report_status : string|null

report_status

Return values
self —

setSenderDomain()

Sets sender_domain

public setSenderDomain(string|null $sender_domain) : self
Parameters
$sender_domain : string|null

sender_domain

Return values
self —

setSocialTargets()

Sets social_targets

public setSocialTargets(int $social_targets) : self
Parameters
$social_targets : int

social_targets

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 —

setStartedAt()

Sets started_at

public setStartedAt(DateTime|null $started_at) : self
Parameters
$started_at : DateTime|null

started_at

Return values
self —

setStatus()

Sets status

public setStatus(string|null $status) : self
Parameters
$status : string|null

status

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 —

setUpdateTargets()

Sets update_targets

public setUpdateTargets(int $update_targets) : self
Parameters
$update_targets : int

update_targets

Return values
self —

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>
Return values
void —

Search results