Documentation

EmailWarmupDomainHealthDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

EmailWarmupDomainHealthDto 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
getBlacklistOk()  : bool|null
Gets blacklist_ok
getCheckedAt()  : DateTime|null
Gets checked_at
getDkimOk()  : bool|null
Gets dkim_ok
getDmarcOk()  : bool|null
Gets dmarc_ok
getDomain()  : string
Gets domain
getHealthScore()  : int|null
Gets health_score
getModelName()  : string
The original name of the model.
getMonitorId()  : string|null
Gets monitor_id
getMxOk()  : bool|null
Gets mx_ok
getSpfOk()  : bool|null
Gets spf_ok
getStatus()  : string|null
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
setBlacklistOk()  : self
Sets blacklist_ok
setCheckedAt()  : self
Sets checked_at
setDkimOk()  : self
Sets dkim_ok
setDmarcOk()  : self
Sets dmarc_ok
setDomain()  : self
Sets domain
setHealthScore()  : self
Sets health_score
setMonitorId()  : self
Sets monitor_id
setMxOk()  : self
Sets mx_ok
setSpfOk()  : self
Sets spf_ok
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 = ['domain' => 'domain', 'monitor_id' => 'monitorId', 'status' => 'status', 'health_score' => 'healthScore', 'spf_ok' => 'spfOk', 'dkim_ok' => 'dkimOk', 'dmarc_ok' => 'dmarcOk', 'mx_ok' => 'mxOk', 'blacklist_ok' => 'blacklistOk', 'checked_at' => 'checkedAt']

$getters

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

protected static array<string|int, string> $getters = ['domain' => 'getDomain', 'monitor_id' => 'getMonitorId', 'status' => 'getStatus', 'health_score' => 'getHealthScore', 'spf_ok' => 'getSpfOk', 'dkim_ok' => 'getDkimOk', 'dmarc_ok' => 'getDmarcOk', 'mx_ok' => 'getMxOk', 'blacklist_ok' => 'getBlacklistOk', 'checked_at' => 'getCheckedAt']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['domain' => null, 'monitor_id' => 'uuid', 'status' => null, 'health_score' => 'int32', 'spf_ok' => null, 'dkim_ok' => null, 'dmarc_ok' => null, 'mx_ok' => null, 'blacklist_ok' => null, 'checked_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 = 'EmailWarmupDomainHealthDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['domain' => false, 'monitor_id' => true, 'status' => true, 'health_score' => true, 'spf_ok' => true, 'dkim_ok' => true, 'dmarc_ok' => true, 'mx_ok' => true, 'blacklist_ok' => true, 'checked_at' => true]

$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 = ['domain' => 'string', 'monitor_id' => 'string', 'status' => 'string', 'health_score' => 'int', 'spf_ok' => 'bool', 'dkim_ok' => 'bool', 'dmarc_ok' => 'bool', 'mx_ok' => 'bool', 'blacklist_ok' => 'bool', 'checked_at' => '\\DateTime']

$setters

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

protected static array<string|int, string> $setters = ['domain' => 'setDomain', 'monitor_id' => 'setMonitorId', 'status' => 'setStatus', 'health_score' => 'setHealthScore', 'spf_ok' => 'setSpfOk', 'dkim_ok' => 'setDkimOk', 'dmarc_ok' => 'setDmarcOk', 'mx_ok' => 'setMxOk', 'blacklist_ok' => 'setBlacklistOk', 'checked_at' => 'setCheckedAt']

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

setBlacklistOk()

Sets blacklist_ok

public setBlacklistOk(bool|null $blacklist_ok) : self
Parameters
$blacklist_ok : bool|null

blacklist_ok

Return values
self —

setCheckedAt()

Sets checked_at

public setCheckedAt(DateTime|null $checked_at) : self
Parameters
$checked_at : DateTime|null

checked_at

Return values
self —

setDkimOk()

Sets dkim_ok

public setDkimOk(bool|null $dkim_ok) : self
Parameters
$dkim_ok : bool|null

dkim_ok

Return values
self —

setDmarcOk()

Sets dmarc_ok

public setDmarcOk(bool|null $dmarc_ok) : self
Parameters
$dmarc_ok : bool|null

dmarc_ok

Return values
self —

setDomain()

Sets domain

public setDomain(string $domain) : self
Parameters
$domain : string

domain

Return values
self —

setHealthScore()

Sets health_score

public setHealthScore(int|null $health_score) : self
Parameters
$health_score : int|null

health_score

Return values
self —

setMonitorId()

Sets monitor_id

public setMonitorId(string|null $monitor_id) : self
Parameters
$monitor_id : string|null

monitor_id

Return values
self —

setMxOk()

Sets mx_ok

public setMxOk(bool|null $mx_ok) : self
Parameters
$mx_ok : bool|null

mx_ok

Return values
self —

setSpfOk()

Sets spf_ok

public setSpfOk(bool|null $spf_ok) : self
Parameters
$spf_ok : bool|null

spf_ok

Return values
self —

setStatus()

Sets status

public setStatus(string|null $status) : self
Parameters
$status : string|null

status

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

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