Documentation

AutomatedInboxPlacementConnectionDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

AutomatedInboxPlacementConnectionDto 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
PROVIDER_AMAZON_SES  = 'AMAZON_SES'
PROVIDER_MAILGUN  = 'MAILGUN'
PROVIDER_POSTMARK  = 'POSTMARK'
PROVIDER_RESEND  = 'RESEND'
PROVIDER_SENDGRID  = 'SENDGRID'
PROVIDER_SMTP  = 'SMTP'
SMTP_SECURITY_START_TLS  = 'START_TLS'
SMTP_SECURITY_TLS  = 'TLS'
STATUS_CONNECTED  = 'CONNECTED'
STATUS_DISCONNECTED  = 'DISCONNECTED'
STATUS_ERROR  = 'ERROR'
STATUS_UNVERIFIED  = 'UNVERIFIED'
$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
getFromEmail()  : string
Gets from_email
getId()  : string
Gets id
getLastErrorCode()  : string|null
Gets last_error_code
getLastVerifiedAt()  : DateTime|null
Gets last_verified_at
getModelName()  : string
The original name of the model.
getName()  : string
Gets name
getProvider()  : string
Gets provider
getProviderAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getSmtpHost()  : string|null
Gets smtp_host
getSmtpPort()  : int|null
Gets smtp_port
getSmtpSecurity()  : string|null
Gets smtp_security
getSmtpSecurityAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getStatus()  : string
Gets status
getStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUpdatedAt()  : DateTime
Gets updated_at
getUsernameHint()  : string|null
Gets username_hint
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
setFromEmail()  : self
Sets from_email
setId()  : self
Sets id
setLastErrorCode()  : self
Sets last_error_code
setLastVerifiedAt()  : self
Sets last_verified_at
setName()  : self
Sets name
setProvider()  : self
Sets provider
setSmtpHost()  : self
Sets smtp_host
setSmtpPort()  : self
Sets smtp_port
setSmtpSecurity()  : self
Sets smtp_security
setStatus()  : self
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUpdatedAt()  : self
Sets updated_at
setUsernameHint()  : self
Sets username_hint
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', 'name' => 'name', 'provider' => 'provider', 'from_email' => 'fromEmail', 'smtp_host' => 'smtpHost', 'smtp_port' => 'smtpPort', 'smtp_security' => 'smtpSecurity', 'username_hint' => 'usernameHint', 'status' => 'status', 'last_verified_at' => 'lastVerifiedAt', 'last_error_code' => 'lastErrorCode', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt']

$getters

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

protected static array<string|int, string> $getters = ['id' => 'getId', 'name' => 'getName', 'provider' => 'getProvider', 'from_email' => 'getFromEmail', 'smtp_host' => 'getSmtpHost', 'smtp_port' => 'getSmtpPort', 'smtp_security' => 'getSmtpSecurity', 'username_hint' => 'getUsernameHint', 'status' => 'getStatus', 'last_verified_at' => 'getLastVerifiedAt', 'last_error_code' => 'getLastErrorCode', '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', 'name' => null, 'provider' => null, 'from_email' => null, 'smtp_host' => null, 'smtp_port' => 'int32', 'smtp_security' => null, 'username_hint' => null, 'status' => null, 'last_verified_at' => 'date-time', 'last_error_code' => null, 'created_at' => 'date-time', 'updated_at' => 'date-time']
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 = ['id' => false, 'name' => false, 'provider' => false, 'from_email' => false, 'smtp_host' => true, 'smtp_port' => true, 'smtp_security' => true, 'username_hint' => true, 'status' => false, 'last_verified_at' => true, 'last_error_code' => true, 'created_at' => false, 'updated_at' => false]

$openAPITypes

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

protected static array<string|int, string> $openAPITypes = ['id' => 'string', 'name' => 'string', 'provider' => 'string', 'from_email' => 'string', 'smtp_host' => 'string', 'smtp_port' => 'int', 'smtp_security' => 'string', 'username_hint' => 'string', 'status' => 'string', 'last_verified_at' => '\\DateTime', 'last_error_code' => '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', 'name' => 'setName', 'provider' => 'setProvider', 'from_email' => 'setFromEmail', 'smtp_host' => 'setSmtpHost', 'smtp_port' => 'setSmtpPort', 'smtp_security' => 'setSmtpSecurity', 'username_hint' => 'setUsernameHint', 'status' => 'setStatus', 'last_verified_at' => 'setLastVerifiedAt', 'last_error_code' => 'setLastErrorCode', '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 —

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

getProviderAllowableValues()

Gets allowable values of the enum

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

getSmtpSecurityAllowableValues()

Gets allowable values of the enum

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

getStatusAllowableValues()

Gets allowable values of the enum

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

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

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int $offset) : bool
Parameters
$offset : int

Offset

Return values
bool —

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

setLastErrorCode()

Sets last_error_code

public setLastErrorCode(string|null $last_error_code) : self
Parameters
$last_error_code : string|null

last_error_code

Return values
self —

setLastVerifiedAt()

Sets last_verified_at

public setLastVerifiedAt(DateTime|null $last_verified_at) : self
Parameters
$last_verified_at : DateTime|null

last_verified_at

Return values
self —

setSmtpSecurity()

Sets smtp_security

public setSmtpSecurity(string|null $smtp_security) : self
Parameters
$smtp_security : string|null

smtp_security

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

setUsernameHint()

Sets username_hint

public setUsernameHint(string|null $username_hint) : self
Parameters
$username_hint : string|null

username_hint

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