Documentation

EmailWarmupReadinessDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

EmailWarmupReadinessDto 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
STATUS_IMPROVING  = 'IMPROVING'
STATUS_NEEDS_ATTENTION  = 'NEEDS_ATTENTION'
STATUS_PREPARING  = 'PREPARING'
STATUS_READY  = 'READY'
$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
getDomainHealth()  : EmailWarmupDomainHealthDto
Gets domain_health
getEstimatedReadyAt()  : DateTime|null
Gets estimated_ready_at
getGoalDailyVolume()  : int
Gets goal_daily_volume
getModelName()  : string
The original name of the model.
getPacing()  : EmailWarmupPacingDto
Gets pacing
getPlacementDeltas()  : array<string|int, EmailWarmupPlacementDeltaDto>
Gets placement_deltas
getPostmasterSignals()  : EmailWarmupReadinessDtoPostmasterSignals|null
Gets postmaster_signals
getReadyForDailyVolume()  : int
Gets ready_for_daily_volume
getRecommendations()  : array<string|int, string>
Gets recommendations
getStatus()  : string
Gets status
getStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getSummary()  : string
Gets summary
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getToday()  : EmailWarmupTodayDto
Gets today
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
setDomainHealth()  : self
Sets domain_health
setEstimatedReadyAt()  : self
Sets estimated_ready_at
setGoalDailyVolume()  : self
Sets goal_daily_volume
setPacing()  : self
Sets pacing
setPlacementDeltas()  : self
Sets placement_deltas
setPostmasterSignals()  : self
Sets postmaster_signals
setReadyForDailyVolume()  : self
Sets ready_for_daily_volume
setRecommendations()  : self
Sets recommendations
setStatus()  : self
Sets status
setSummary()  : self
Sets summary
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setToday()  : self
Sets today
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 = ['status' => 'status', 'summary' => 'summary', 'ready_for_daily_volume' => 'readyForDailyVolume', 'goal_daily_volume' => 'goalDailyVolume', 'estimated_ready_at' => 'estimatedReadyAt', 'today' => 'today', 'pacing' => 'pacing', 'placement_deltas' => 'placementDeltas', 'domain_health' => 'domainHealth', 'postmaster_signals' => 'postmasterSignals', 'recommendations' => 'recommendations']

$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 = ['status' => 'getStatus', 'summary' => 'getSummary', 'ready_for_daily_volume' => 'getReadyForDailyVolume', 'goal_daily_volume' => 'getGoalDailyVolume', 'estimated_ready_at' => 'getEstimatedReadyAt', 'today' => 'getToday', 'pacing' => 'getPacing', 'placement_deltas' => 'getPlacementDeltas', 'domain_health' => 'getDomainHealth', 'postmaster_signals' => 'getPostmasterSignals', 'recommendations' => 'getRecommendations']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['status' => null, 'summary' => null, 'ready_for_daily_volume' => 'int32', 'goal_daily_volume' => 'int32', 'estimated_ready_at' => 'date', 'today' => null, 'pacing' => null, 'placement_deltas' => null, 'domain_health' => null, 'postmaster_signals' => null, 'recommendations' => 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 = 'EmailWarmupReadinessDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['status' => false, 'summary' => false, 'ready_for_daily_volume' => false, 'goal_daily_volume' => false, 'estimated_ready_at' => true, 'today' => false, 'pacing' => false, 'placement_deltas' => false, 'domain_health' => false, 'postmaster_signals' => true, 'recommendations' => 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 = ['status' => 'string', 'summary' => 'string', 'ready_for_daily_volume' => 'int', 'goal_daily_volume' => 'int', 'estimated_ready_at' => '\\DateTime', 'today' => '\\MailSlurp\\Models\\EmailWarmupTodayDto', 'pacing' => '\\MailSlurp\\Models\\EmailWarmupPacingDto', 'placement_deltas' => '\\MailSlurp\\Models\\EmailWarmupPlacementDeltaDto[]', 'domain_health' => '\\MailSlurp\\Models\\EmailWarmupDomainHealthDto', 'postmaster_signals' => '\\MailSlurp\\Models\\EmailWarmupReadinessDtoPostmasterSignals', 'recommendations' => 'string[]']

$setters

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

protected static array<string|int, string> $setters = ['status' => 'setStatus', 'summary' => 'setSummary', 'ready_for_daily_volume' => 'setReadyForDailyVolume', 'goal_daily_volume' => 'setGoalDailyVolume', 'estimated_ready_at' => 'setEstimatedReadyAt', 'today' => 'setToday', 'pacing' => 'setPacing', 'placement_deltas' => 'setPlacementDeltas', 'domain_health' => 'setDomainHealth', 'postmaster_signals' => 'setPostmasterSignals', 'recommendations' => 'setRecommendations']

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

getEstimatedReadyAt()

Gets estimated_ready_at

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

getGoalDailyVolume()

Gets goal_daily_volume

public getGoalDailyVolume() : int
Return values
int —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getReadyForDailyVolume()

Gets ready_for_daily_volume

public getReadyForDailyVolume() : int
Return values
int —

getRecommendations()

Gets recommendations

public getRecommendations() : 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> —

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

setEstimatedReadyAt()

Sets estimated_ready_at

public setEstimatedReadyAt(DateTime|null $estimated_ready_at) : self
Parameters
$estimated_ready_at : DateTime|null

estimated_ready_at

Return values
self —

setGoalDailyVolume()

Sets goal_daily_volume

public setGoalDailyVolume(int $goal_daily_volume) : self
Parameters
$goal_daily_volume : int

goal_daily_volume

Return values
self —

setReadyForDailyVolume()

Sets ready_for_daily_volume

public setReadyForDailyVolume(int $ready_for_daily_volume) : self
Parameters
$ready_for_daily_volume : int

ready_for_daily_volume

Return values
self —

setRecommendations()

Sets recommendations

public setRecommendations(array<string|int, string> $recommendations) : self
Parameters
$recommendations : array<string|int, string>

recommendations

Return values
self —

setStatus()

Sets status

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

status

Return values
self —

setSummary()

Sets summary

public setSummary(string $summary) : self
Parameters
$summary : string

summary

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