Documentation

BouncedEmailDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

BouncedEmailDto Class Doc Comment

Tags
category

Class

description

Bounced email

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
getBounceMta()  : string|null
Gets bounce_mta
getBounceRecipients()  : array<string|int, string>|null
Gets bounce_recipients
getBounceSubType()  : string|null
Gets bounce_sub_type
getBounceType()  : string|null
Gets bounce_type
getCreatedAt()  : DateTime
Gets created_at
getId()  : string
Gets id
getModelName()  : string
The original name of the model.
getNotificationType()  : string
Gets notification_type
getSender()  : string
Gets sender
getSentEmailId()  : string|null
Gets sent_email_id
getSentToRecipients()  : array<string|int, string>|null
Gets sent_to_recipients
getSubject()  : string|null
Gets subject
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
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
setBounceMta()  : self
Sets bounce_mta
setBounceRecipients()  : self
Sets bounce_recipients
setBounceSubType()  : self
Sets bounce_sub_type
setBounceType()  : self
Sets bounce_type
setCreatedAt()  : self
Sets created_at
setId()  : self
Sets id
setNotificationType()  : self
Sets notification_type
setSender()  : self
Sets sender
setSentEmailId()  : self
Sets sent_email_id
setSentToRecipients()  : self
Sets sent_to_recipients
setSubject()  : self
Sets subject
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
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', 'notification_type' => 'notificationType', 'sent_to_recipients' => 'sentToRecipients', 'sender' => 'sender', 'bounce_mta' => 'bounceMta', 'bounce_type' => 'bounceType', 'bounce_recipients' => 'bounceRecipients', 'bounce_sub_type' => 'bounceSubType', 'sent_email_id' => 'sentEmailId', 'subject' => 'subject', 'created_at' => 'createdAt']

$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', 'notification_type' => 'getNotificationType', 'sent_to_recipients' => 'getSentToRecipients', 'sender' => 'getSender', 'bounce_mta' => 'getBounceMta', 'bounce_type' => 'getBounceType', 'bounce_recipients' => 'getBounceRecipients', 'bounce_sub_type' => 'getBounceSubType', 'sent_email_id' => 'getSentEmailId', 'subject' => 'getSubject', 'created_at' => 'getCreatedAt']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['id' => 'uuid', 'user_id' => 'uuid', 'notification_type' => null, 'sent_to_recipients' => null, 'sender' => null, 'bounce_mta' => null, 'bounce_type' => null, 'bounce_recipients' => null, 'bounce_sub_type' => null, 'sent_email_id' => 'uuid', 'subject' => null, 'created_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 = 'BouncedEmailDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['id' => false, 'user_id' => false, 'notification_type' => false, 'sent_to_recipients' => true, 'sender' => false, 'bounce_mta' => true, 'bounce_type' => true, 'bounce_recipients' => true, 'bounce_sub_type' => true, 'sent_email_id' => true, 'subject' => true, 'created_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', 'notification_type' => 'string', 'sent_to_recipients' => 'string[]', 'sender' => 'string', 'bounce_mta' => 'string', 'bounce_type' => 'string', 'bounce_recipients' => 'string[]', 'bounce_sub_type' => 'string', 'sent_email_id' => 'string', 'subject' => 'string', 'created_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', 'notification_type' => 'setNotificationType', 'sent_to_recipients' => 'setSentToRecipients', 'sender' => 'setSender', 'bounce_mta' => 'setBounceMta', 'bounce_type' => 'setBounceType', 'bounce_recipients' => 'setBounceRecipients', 'bounce_sub_type' => 'setBounceSubType', 'sent_email_id' => 'setSentEmailId', 'subject' => 'setSubject', 'created_at' => 'setCreatedAt']

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

getBounceMta()

Gets bounce_mta

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

getBounceRecipients()

Gets bounce_recipients

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

getBounceSubType()

Gets bounce_sub_type

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

getBounceType()

Gets bounce_type

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

getCreatedAt()

Gets created_at

public getCreatedAt() : DateTime
Return values
DateTime —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getNotificationType()

Gets notification_type

public getNotificationType() : string
Return values
string —

getSender()

Gets sender

public getSender() : string
Return values
string —

getSentEmailId()

Gets sent_email_id

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

getSentToRecipients()

Gets sent_to_recipients

public getSentToRecipients() : array<string|int, string>|null
Return values
array<string|int, string>|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> —

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

setBounceMta()

Sets bounce_mta

public setBounceMta(string|null $bounce_mta) : self
Parameters
$bounce_mta : string|null

bounce_mta

Return values
self —

setBounceRecipients()

Sets bounce_recipients

public setBounceRecipients(array<string|int, string>|null $bounce_recipients) : self
Parameters
$bounce_recipients : array<string|int, string>|null

bounce_recipients

Return values
self —

setBounceSubType()

Sets bounce_sub_type

public setBounceSubType(string|null $bounce_sub_type) : self
Parameters
$bounce_sub_type : string|null

bounce_sub_type

Return values
self —

setBounceType()

Sets bounce_type

public setBounceType(string|null $bounce_type) : self
Parameters
$bounce_type : string|null

bounce_type

Return values
self —

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 —

setNotificationType()

Sets notification_type

public setNotificationType(string $notification_type) : self
Parameters
$notification_type : string

notification_type

Return values
self —

setSender()

Sets sender

public setSender(string $sender) : self
Parameters
$sender : string

sender

Return values
self —

setSentEmailId()

Sets sent_email_id

public setSentEmailId(string|null $sent_email_id) : self
Parameters
$sent_email_id : string|null

sent_email_id

Return values
self —

setSentToRecipients()

Sets sent_to_recipients

public setSentToRecipients(array<string|int, string>|null $sent_to_recipients) : self
Parameters
$sent_to_recipients : array<string|int, string>|null

sent_to_recipients

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

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