Documentation

InboxPlacementTargetResultDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

InboxPlacementTargetResultDto 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
getEvidence()  : array<string, string>
Gets evidence
getLatencyMs()  : int|null
Gets latency_ms
getModelName()  : string
The original name of the model.
getPlacementFolder()  : string|null
Gets placement_folder
getPlacementVerdict()  : string|null
Gets placement_verdict
getProvider()  : string
Gets provider
getReceivedAt()  : DateTime|null
Gets received_at
getSeedAccountId()  : int
Gets seed_account_id
getSeedAddress()  : string
Gets seed_address
getSegment()  : string
Gets segment
getStatus()  : string
Gets status
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
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
setEvidence()  : self
Sets evidence
setLatencyMs()  : self
Sets latency_ms
setPlacementFolder()  : self
Sets placement_folder
setPlacementVerdict()  : self
Sets placement_verdict
setProvider()  : self
Sets provider
setReceivedAt()  : self
Sets received_at
setSeedAccountId()  : self
Sets seed_account_id
setSeedAddress()  : self
Sets seed_address
setSegment()  : self
Sets segment
setStatus()  : self
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
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 = ['seed_account_id' => 'seedAccountId', 'seed_address' => 'seedAddress', 'provider' => 'provider', 'segment' => 'segment', 'status' => 'status', 'placement_verdict' => 'placementVerdict', 'placement_folder' => 'placementFolder', 'received_at' => 'receivedAt', 'latency_ms' => 'latencyMs', 'evidence' => 'evidence']

$getters

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

protected static array<string|int, string> $getters = ['seed_account_id' => 'getSeedAccountId', 'seed_address' => 'getSeedAddress', 'provider' => 'getProvider', 'segment' => 'getSegment', 'status' => 'getStatus', 'placement_verdict' => 'getPlacementVerdict', 'placement_folder' => 'getPlacementFolder', 'received_at' => 'getReceivedAt', 'latency_ms' => 'getLatencyMs', 'evidence' => 'getEvidence']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['seed_account_id' => 'int64', 'seed_address' => null, 'provider' => null, 'segment' => null, 'status' => null, 'placement_verdict' => null, 'placement_folder' => null, 'received_at' => 'date-time', 'latency_ms' => 'int64', 'evidence' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'InboxPlacementTargetResultDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['seed_account_id' => false, 'seed_address' => false, 'provider' => false, 'segment' => false, 'status' => false, 'placement_verdict' => true, 'placement_folder' => true, 'received_at' => true, 'latency_ms' => true, 'evidence' => 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 = ['seed_account_id' => 'int', 'seed_address' => 'string', 'provider' => 'string', 'segment' => 'string', 'status' => 'string', 'placement_verdict' => 'string', 'placement_folder' => 'string', 'received_at' => '\\DateTime', 'latency_ms' => 'int', 'evidence' => 'array<string,string>']

$setters

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

protected static array<string|int, string> $setters = ['seed_account_id' => 'setSeedAccountId', 'seed_address' => 'setSeedAddress', 'provider' => 'setProvider', 'segment' => 'setSegment', 'status' => 'setStatus', 'placement_verdict' => 'setPlacementVerdict', 'placement_folder' => 'setPlacementFolder', 'received_at' => 'setReceivedAt', 'latency_ms' => 'setLatencyMs', 'evidence' => 'setEvidence']

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

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

setEvidence()

Sets evidence

public setEvidence(array<string, string> $evidence) : self
Parameters
$evidence : array<string, string>

evidence

Return values
self —

setLatencyMs()

Sets latency_ms

public setLatencyMs(int|null $latency_ms) : self
Parameters
$latency_ms : int|null

latency_ms

Return values
self —

setPlacementFolder()

Sets placement_folder

public setPlacementFolder(string|null $placement_folder) : self
Parameters
$placement_folder : string|null

placement_folder

Return values
self —

setPlacementVerdict()

Sets placement_verdict

public setPlacementVerdict(string|null $placement_verdict) : self
Parameters
$placement_verdict : string|null

placement_verdict

Return values
self —

setProvider()

Sets provider

public setProvider(string $provider) : self
Parameters
$provider : string

provider

Return values
self —

setReceivedAt()

Sets received_at

public setReceivedAt(DateTime|null $received_at) : self
Parameters
$received_at : DateTime|null

received_at

Return values
self —

setSeedAccountId()

Sets seed_account_id

public setSeedAccountId(int $seed_account_id) : self
Parameters
$seed_account_id : int

seed_account_id

Return values
self —

setSeedAddress()

Sets seed_address

public setSeedAddress(string $seed_address) : self
Parameters
$seed_address : string

seed_address

Return values
self —

setSegment()

Sets segment

public setSegment(string $segment) : self
Parameters
$segment : string

segment

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

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