EmailWarmupPlacementCheckDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
EmailWarmupPlacementCheckDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- STATUS_COMPLETED = 'COMPLETED'
- STATUS_FAILED = 'FAILED'
- STATUS_PARTIAL = 'PARTIAL'
- STATUS_PLANNED = 'PLANNED'
- STATUS_SENDING = 'SENDING'
- STATUS_WAITING_RESULTS = 'WAITING_RESULTS'
- TYPE__FINAL = 'FINAL'
- TYPE_BASELINE = 'BASELINE'
- TYPE_WEEKLY = 'WEEKLY'
- $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
- getAcceptedCount() : int
- Gets accepted_count
- getCheckpointDay() : int
- Gets checkpoint_day
- getCompletedAt() : DateTime|null
- Gets completed_at
- getCreatedAt() : DateTime
- Gets created_at
- getFailureCode() : string|null
- Gets failure_code
- getId() : string
- Gets id
- getInboxCount() : int
- Gets inbox_count
- getInboxPercent() : int
- Gets inbox_percent
- getInboxPlacementRunId() : string|null
- Gets inbox_placement_run_id
- getModelName() : string
- The original name of the model.
- getNotReceivedCount() : int
- Gets not_received_count
- getProgramId() : string
- Gets program_id
- getProviderResults() : array<string|int, EmailWarmupProviderPlacementDto>
- Gets provider_results
- getScheduledFor() : DateTime
- Gets scheduled_for
- getSpamCount() : int
- Gets spam_count
- getStatus() : string
- Gets status
- getStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getTargetCount() : int
- Gets target_count
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getType() : string
- Gets type
- getTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getUpdatedAt() : DateTime
- Gets updated_at
- 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
- setAcceptedCount() : self
- Sets accepted_count
- setCheckpointDay() : self
- Sets checkpoint_day
- setCompletedAt() : self
- Sets completed_at
- setCreatedAt() : self
- Sets created_at
- setFailureCode() : self
- Sets failure_code
- setId() : self
- Sets id
- setInboxCount() : self
- Sets inbox_count
- setInboxPercent() : self
- Sets inbox_percent
- setInboxPlacementRunId() : self
- Sets inbox_placement_run_id
- setNotReceivedCount() : self
- Sets not_received_count
- setProgramId() : self
- Sets program_id
- setProviderResults() : self
- Sets provider_results
- setScheduledFor() : self
- Sets scheduled_for
- setSpamCount() : self
- Sets spam_count
- setStatus() : self
- Sets status
- setTargetCount() : self
- Sets target_count
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setType() : self
- Sets type
- setUpdatedAt() : self
- Sets updated_at
- 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
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
STATUS_COMPLETED
public
mixed
STATUS_COMPLETED
= 'COMPLETED'
STATUS_FAILED
public
mixed
STATUS_FAILED
= 'FAILED'
STATUS_PARTIAL
public
mixed
STATUS_PARTIAL
= 'PARTIAL'
STATUS_PLANNED
public
mixed
STATUS_PLANNED
= 'PLANNED'
STATUS_SENDING
public
mixed
STATUS_SENDING
= 'SENDING'
STATUS_WAITING_RESULTS
public
mixed
STATUS_WAITING_RESULTS
= 'WAITING_RESULTS'
TYPE__FINAL
public
mixed
TYPE__FINAL
= 'FINAL'
TYPE_BASELINE
public
mixed
TYPE_BASELINE
= 'BASELINE'
TYPE_WEEKLY
public
mixed
TYPE_WEEKLY
= 'WEEKLY'
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', 'program_id' => 'programId', 'checkpoint_day' => 'checkpointDay', 'type' => 'type', 'status' => 'status', 'scheduled_for' => 'scheduledFor', 'inbox_placement_run_id' => 'inboxPlacementRunId', 'target_count' => 'targetCount', 'accepted_count' => 'acceptedCount', 'inbox_count' => 'inboxCount', 'spam_count' => 'spamCount', 'not_received_count' => 'notReceivedCount', 'inbox_percent' => 'inboxPercent', 'provider_results' => 'providerResults', 'failure_code' => 'failureCode', 'completed_at' => 'completedAt', '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', 'program_id' => 'getProgramId', 'checkpoint_day' => 'getCheckpointDay', 'type' => 'getType', 'status' => 'getStatus', 'scheduled_for' => 'getScheduledFor', 'inbox_placement_run_id' => 'getInboxPlacementRunId', 'target_count' => 'getTargetCount', 'accepted_count' => 'getAcceptedCount', 'inbox_count' => 'getInboxCount', 'spam_count' => 'getSpamCount', 'not_received_count' => 'getNotReceivedCount', 'inbox_percent' => 'getInboxPercent', 'provider_results' => 'getProviderResults', 'failure_code' => 'getFailureCode', 'completed_at' => 'getCompletedAt', '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', 'program_id' => 'uuid', 'checkpoint_day' => 'int32', 'type' => null, 'status' => null, 'scheduled_for' => 'date-time', 'inbox_placement_run_id' => 'uuid', 'target_count' => 'int32', 'accepted_count' => 'int32', 'inbox_count' => 'int32', 'spam_count' => 'int32', 'not_received_count' => 'int32', 'inbox_percent' => 'int32', 'provider_results' => null, 'failure_code' => null, 'completed_at' => 'date-time', 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'EmailWarmupPlacementCheckDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'program_id' => false, 'checkpoint_day' => false, 'type' => false, 'status' => false, 'scheduled_for' => false, 'inbox_placement_run_id' => true, 'target_count' => false, 'accepted_count' => false, 'inbox_count' => false, 'spam_count' => false, 'not_received_count' => false, 'inbox_percent' => false, 'provider_results' => false, 'failure_code' => true, 'completed_at' => true, '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', 'program_id' => 'string', 'checkpoint_day' => 'int', 'type' => 'string', 'status' => 'string', 'scheduled_for' => '\\DateTime', 'inbox_placement_run_id' => 'string', 'target_count' => 'int', 'accepted_count' => 'int', 'inbox_count' => 'int', 'spam_count' => 'int', 'not_received_count' => 'int', 'inbox_percent' => 'int', 'provider_results' => '\\MailSlurp\\Models\\EmailWarmupProviderPlacementDto[]', 'failure_code' => 'string', 'completed_at' => '\\DateTime', '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', 'program_id' => 'setProgramId', 'checkpoint_day' => 'setCheckpointDay', 'type' => 'setType', 'status' => 'setStatus', 'scheduled_for' => 'setScheduledFor', 'inbox_placement_run_id' => 'setInboxPlacementRunId', 'target_count' => 'setTargetCount', 'accepted_count' => 'setAcceptedCount', 'inbox_count' => 'setInboxCount', 'spam_count' => 'setSpamCount', 'not_received_count' => 'setNotReceivedCount', 'inbox_percent' => 'setInboxPercent', 'provider_results' => 'setProviderResults', 'failure_code' => 'setFailureCode', 'completed_at' => 'setCompletedAt', '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> —getAcceptedCount()
Gets accepted_count
public
getAcceptedCount() : int
Return values
int —getCheckpointDay()
Gets checkpoint_day
public
getCheckpointDay() : int
Return values
int —getCompletedAt()
Gets completed_at
public
getCompletedAt() : DateTime|null
Return values
DateTime|null —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getFailureCode()
Gets failure_code
public
getFailureCode() : string|null
Return values
string|null —getId()
Gets id
public
getId() : string
Return values
string —getInboxCount()
Gets inbox_count
public
getInboxCount() : int
Return values
int —getInboxPercent()
Gets inbox_percent
public
getInboxPercent() : int
Return values
int —getInboxPlacementRunId()
Gets inbox_placement_run_id
public
getInboxPlacementRunId() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getNotReceivedCount()
Gets not_received_count
public
getNotReceivedCount() : int
Return values
int —getProgramId()
Gets program_id
public
getProgramId() : string
Return values
string —getProviderResults()
Gets provider_results
public
getProviderResults() : array<string|int, EmailWarmupProviderPlacementDto>
Return values
array<string|int, EmailWarmupProviderPlacementDto> —getScheduledFor()
Gets scheduled_for
public
getScheduledFor() : DateTime
Return values
DateTime —getSpamCount()
Gets spam_count
public
getSpamCount() : int
Return values
int —getStatus()
Gets status
public
getStatus() : string
Return values
string —getStatusAllowableValues()
Gets allowable values of the enum
public
getStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getTargetCount()
Gets target_count
public
getTargetCount() : int
Return values
int —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getType()
Gets type
public
getType() : string
Return values
string —getTypeAllowableValues()
Gets allowable values of the enum
public
getTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getUpdatedAt()
Gets updated_at
public
getUpdatedAt() : DateTime
Return values
DateTime —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 —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Return values
mixed —Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.
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> —setAcceptedCount()
Sets accepted_count
public
setAcceptedCount(int $accepted_count) : self
Parameters
- $accepted_count : int
-
accepted_count
Return values
self —setCheckpointDay()
Sets checkpoint_day
public
setCheckpointDay(int $checkpoint_day) : self
Parameters
- $checkpoint_day : int
-
checkpoint_day
Return values
self —setCompletedAt()
Sets completed_at
public
setCompletedAt(DateTime|null $completed_at) : self
Parameters
- $completed_at : DateTime|null
-
completed_at
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setFailureCode()
Sets failure_code
public
setFailureCode(string|null $failure_code) : self
Parameters
- $failure_code : string|null
-
failure_code
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setInboxCount()
Sets inbox_count
public
setInboxCount(int $inbox_count) : self
Parameters
- $inbox_count : int
-
inbox_count
Return values
self —setInboxPercent()
Sets inbox_percent
public
setInboxPercent(int $inbox_percent) : self
Parameters
- $inbox_percent : int
-
inbox_percent
Return values
self —setInboxPlacementRunId()
Sets inbox_placement_run_id
public
setInboxPlacementRunId(string|null $inbox_placement_run_id) : self
Parameters
- $inbox_placement_run_id : string|null
-
inbox_placement_run_id
Return values
self —setNotReceivedCount()
Sets not_received_count
public
setNotReceivedCount(int $not_received_count) : self
Parameters
- $not_received_count : int
-
not_received_count
Return values
self —setProgramId()
Sets program_id
public
setProgramId(string $program_id) : self
Parameters
- $program_id : string
-
program_id
Return values
self —setProviderResults()
Sets provider_results
public
setProviderResults(array<string|int, EmailWarmupProviderPlacementDto> $provider_results) : self
Parameters
- $provider_results : array<string|int, EmailWarmupProviderPlacementDto>
-
provider_results
Return values
self —setScheduledFor()
Sets scheduled_for
public
setScheduledFor(DateTime $scheduled_for) : self
Parameters
- $scheduled_for : DateTime
-
scheduled_for
Return values
self —setSpamCount()
Sets spam_count
public
setSpamCount(int $spam_count) : self
Parameters
- $spam_count : int
-
spam_count
Return values
self —setStatus()
Sets status
public
setStatus(string $status) : self
Parameters
- $status : string
-
status
Return values
self —setTargetCount()
Sets target_count
public
setTargetCount(int $target_count) : self
Parameters
- $target_count : int
-
target_count
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> —setType()
Sets type
public
setType(string $type) : self
Parameters
- $type : string
-
type
Return values
self —setUpdatedAt()
Sets updated_at
public
setUpdatedAt(DateTime $updated_at) : self
Parameters
- $updated_at : DateTime
-
updated_at
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>