Documentation

InboxPlacementDeliverabilitySummaryDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

InboxPlacementDeliverabilitySummaryDto Class Doc Comment

Tags
category

Class

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
getInboxTargets()  : int
Gets inbox_targets
getMatchedTargets()  : int
Gets matched_targets
getModelName()  : string
The original name of the model.
getNotReceivedTargets()  : int
Gets not_received_targets
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
setInboxTargets()  : self
Sets inbox_targets
setMatchedTargets()  : self
Sets matched_targets
setNotReceivedTargets()  : self
Sets not_received_targets
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

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_targets' => 'totalTargets', 'matched_targets' => 'matchedTargets', 'inbox_targets' => 'inboxTargets', 'spam_targets' => 'spamTargets', 'not_received_targets' => 'notReceivedTargets']

$getters

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

protected static array<string|int, string> $getters = ['total_targets' => 'getTotalTargets', 'matched_targets' => 'getMatchedTargets', 'inbox_targets' => 'getInboxTargets', 'spam_targets' => 'getSpamTargets', 'not_received_targets' => 'getNotReceivedTargets']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['total_targets' => 'int32', 'matched_targets' => 'int32', 'inbox_targets' => 'int32', 'spam_targets' => 'int32', 'not_received_targets' => 'int32']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['total_targets' => false, 'matched_targets' => false, 'inbox_targets' => false, 'spam_targets' => false, 'not_received_targets' => false]

$openAPITypes

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

protected static array<string|int, string> $openAPITypes = ['total_targets' => 'int', 'matched_targets' => 'int', 'inbox_targets' => 'int', 'spam_targets' => 'int', 'not_received_targets' => 'int']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['total_targets' => 'setTotalTargets', 'matched_targets' => 'setMatchedTargets', 'inbox_targets' => 'setInboxTargets', 'spam_targets' => 'setSpamTargets', 'not_received_targets' => 'setNotReceivedTargets']

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

getters()

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

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

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

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 —

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

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 —

setters()

Array of attributes to setter functions (for deserialization of responses)

public static setters() : 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