Documentation

DeliveryStatusDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

DeliveryStatusDto 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
getCreatedAt()  : DateTime
Gets created_at
getId()  : string
Gets id
getInboxId()  : string|null
Gets inbox_id
getModelName()  : string
The original name of the model.
getProcessingTimeMillis()  : int|null
Gets processing_time_millis
getReceived()  : DateTime|null
Gets received
getRecipients()  : array<string|int, string>|null
Gets recipients
getRemoteMtaIp()  : string|null
Gets remote_mta_ip
getReportingMta()  : string|null
Gets reporting_mta
getSentId()  : string|null
Gets sent_id
getSmtpResponse()  : string|null
Gets smtp_response
getSmtpStatusCode()  : int|null
Gets smtp_status_code
getSubject()  : string|null
Gets subject
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUpdatedAt()  : DateTime
Gets updated_at
getUserId()  : string
Gets user_id
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
setCreatedAt()  : self
Sets created_at
setId()  : self
Sets id
setInboxId()  : self
Sets inbox_id
setProcessingTimeMillis()  : self
Sets processing_time_millis
setReceived()  : self
Sets received
setRecipients()  : self
Sets recipients
setRemoteMtaIp()  : self
Sets remote_mta_ip
setReportingMta()  : self
Sets reporting_mta
setSentId()  : self
Sets sent_id
setSmtpResponse()  : self
Sets smtp_response
setSmtpStatusCode()  : self
Sets smtp_status_code
setSubject()  : self
Sets subject
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUpdatedAt()  : self
Sets updated_at
setUserId()  : self
Sets user_id
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', 'user_id' => 'userId', 'sent_id' => 'sentId', 'remote_mta_ip' => 'remoteMtaIp', 'inbox_id' => 'inboxId', 'reporting_mta' => 'reportingMta', 'recipients' => 'recipients', 'smtp_response' => 'smtpResponse', 'smtp_status_code' => 'smtpStatusCode', 'processing_time_millis' => 'processingTimeMillis', 'received' => 'received', 'subject' => 'subject', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt']

$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 = ['id' => 'getId', 'user_id' => 'getUserId', 'sent_id' => 'getSentId', 'remote_mta_ip' => 'getRemoteMtaIp', 'inbox_id' => 'getInboxId', 'reporting_mta' => 'getReportingMta', 'recipients' => 'getRecipients', 'smtp_response' => 'getSmtpResponse', 'smtp_status_code' => 'getSmtpStatusCode', 'processing_time_millis' => 'getProcessingTimeMillis', 'received' => 'getReceived', 'subject' => 'getSubject', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['id' => 'uuid', 'user_id' => 'uuid', 'sent_id' => 'uuid', 'remote_mta_ip' => null, 'inbox_id' => 'uuid', 'reporting_mta' => null, 'recipients' => null, 'smtp_response' => null, 'smtp_status_code' => 'int32', 'processing_time_millis' => 'int64', 'received' => 'date-time', 'subject' => null, 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'DeliveryStatusDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['id' => false, 'user_id' => false, 'sent_id' => false, 'remote_mta_ip' => false, 'inbox_id' => false, 'reporting_mta' => false, 'recipients' => false, 'smtp_response' => false, 'smtp_status_code' => false, 'processing_time_millis' => false, 'received' => false, 'subject' => false, 'created_at' => false, 'updated_at' => 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', 'user_id' => 'string', 'sent_id' => 'string', 'remote_mta_ip' => 'string', 'inbox_id' => 'string', 'reporting_mta' => 'string', 'recipients' => 'string[]', 'smtp_response' => 'string', 'smtp_status_code' => 'int', 'processing_time_millis' => 'int', 'received' => '\\DateTime', 'subject' => 'string', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime']

$setters

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

protected static array<string|int, string> $setters = ['id' => 'setId', 'user_id' => 'setUserId', 'sent_id' => 'setSentId', 'remote_mta_ip' => 'setRemoteMtaIp', 'inbox_id' => 'setInboxId', 'reporting_mta' => 'setReportingMta', 'recipients' => 'setRecipients', 'smtp_response' => 'setSmtpResponse', 'smtp_status_code' => 'setSmtpStatusCode', 'processing_time_millis' => 'setProcessingTimeMillis', 'received' => 'setReceived', 'subject' => 'setSubject', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt']

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

getCreatedAt()

Gets created_at

public getCreatedAt() : DateTime
Return values
DateTime —

getInboxId()

Gets inbox_id

public getInboxId() : string|null
Return values
string|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getProcessingTimeMillis()

Gets processing_time_millis

public getProcessingTimeMillis() : int|null
Return values
int|null —

getReceived()

Gets received

public getReceived() : DateTime|null
Return values
DateTime|null —

getRecipients()

Gets recipients

public getRecipients() : array<string|int, string>|null
Return values
array<string|int, string>|null —

getRemoteMtaIp()

Gets remote_mta_ip

public getRemoteMtaIp() : string|null
Return values
string|null —

getReportingMta()

Gets reporting_mta

public getReportingMta() : string|null
Return values
string|null —

getSentId()

Gets sent_id

public getSentId() : string|null
Return values
string|null —

getSmtpResponse()

Gets smtp_response

public getSmtpResponse() : string|null
Return values
string|null —

getSmtpStatusCode()

Gets smtp_status_code

public getSmtpStatusCode() : int|null
Return values
int|null —

getSubject()

Gets subject

public getSubject() : string|null
Return values
string|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> —

getUpdatedAt()

Gets updated_at

public getUpdatedAt() : DateTime
Return values
DateTime —

getUserId()

Gets user_id

public getUserId() : string
Return values
string —

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

setCreatedAt()

Sets created_at

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

created_at

Return values
self —

setId()

Sets id

public setId(string $id) : self
Parameters
$id : string

id

Return values
self —

setInboxId()

Sets inbox_id

public setInboxId(string|null $inbox_id) : self
Parameters
$inbox_id : string|null

inbox_id

Return values
self —

setProcessingTimeMillis()

Sets processing_time_millis

public setProcessingTimeMillis(int|null $processing_time_millis) : self
Parameters
$processing_time_millis : int|null

processing_time_millis

Return values
self —

setReceived()

Sets received

public setReceived(DateTime|null $received) : self
Parameters
$received : DateTime|null

received

Return values
self —

setRecipients()

Sets recipients

public setRecipients(array<string|int, string>|null $recipients) : self
Parameters
$recipients : array<string|int, string>|null

recipients

Return values
self —

setRemoteMtaIp()

Sets remote_mta_ip

public setRemoteMtaIp(string|null $remote_mta_ip) : self
Parameters
$remote_mta_ip : string|null

remote_mta_ip

Return values
self —

setReportingMta()

Sets reporting_mta

public setReportingMta(string|null $reporting_mta) : self
Parameters
$reporting_mta : string|null

reporting_mta

Return values
self —

setSentId()

Sets sent_id

public setSentId(string|null $sent_id) : self
Parameters
$sent_id : string|null

sent_id

Return values
self —

setSmtpResponse()

Sets smtp_response

public setSmtpResponse(string|null $smtp_response) : self
Parameters
$smtp_response : string|null

smtp_response

Return values
self —

setSmtpStatusCode()

Sets smtp_status_code

public setSmtpStatusCode(int|null $smtp_status_code) : self
Parameters
$smtp_status_code : int|null

smtp_status_code

Return values
self —

setSubject()

Sets subject

public setSubject(string|null $subject) : self
Parameters
$subject : string|null

subject

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

setUpdatedAt()

Sets updated_at

public setUpdatedAt(DateTime $updated_at) : self
Parameters
$updated_at : DateTime

updated_at

Return values
self —

setUserId()

Sets user_id

public setUserId(string $user_id) : self
Parameters
$user_id : string

user_id

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

Search results