EmailWarmupSendSlotDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
EmailWarmupSendSlotDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- OUTCOME_CLASS_ACCEPTED = 'ACCEPTED'
- OUTCOME_CLASS_AMBIGUOUS = 'AMBIGUOUS'
- OUTCOME_CLASS_PERMANENT = 'PERMANENT'
- OUTCOME_CLASS_RETRYABLE = 'RETRYABLE'
- OUTCOME_CLASS_SKIPPED = 'SKIPPED'
- STATUS_ACCEPTED = 'ACCEPTED'
- STATUS_AMBIGUOUS = 'AMBIGUOUS'
- STATUS_CLAIMED = 'CLAIMED'
- STATUS_FAILED = 'FAILED'
- STATUS_PLANNED = 'PLANNED'
- STATUS_RETRYABLE = 'RETRYABLE'
- STATUS_SKIPPED = 'SKIPPED'
- TARGET_CLASS_MS2_CONTROLLED_MX = 'MS2_CONTROLLED_MX'
- TARGET_CLASS_PROVIDER_SEED_PASSIVE = 'PROVIDER_SEED_PASSIVE'
- $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
- getAcceptedAt() : DateTime|null
- Gets accepted_at
- getAttemptCount() : int
- Gets attempt_count
- getContentHash() : string
- Gets content_hash
- getCreatedAt() : DateTime
- Gets created_at
- getFailureCode() : string|null
- Gets failure_code
- getId() : string
- Gets id
- getMaxAttempts() : int
- Gets max_attempts
- getModelName() : string
- The original name of the model.
- getObservedAt() : DateTime|null
- Gets observed_at
- getOutcomeClass() : string|null
- Gets outcome_class
- getOutcomeClassAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getProgramId() : string
- Gets program_id
- getRampDay() : int
- Gets ramp_day
- getReconciliationRequired() : bool
- Gets reconciliation_required
- getScheduledFor() : DateTime
- Gets scheduled_for
- getSequence() : int
- Gets sequence
- getSlotDate() : DateTime
- Gets slot_date
- getStatus() : string
- Gets status
- getStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getTargetClass() : string
- Gets target_class
- getTargetClassAllowableValues() : 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
- 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
- setAcceptedAt() : self
- Sets accepted_at
- setAttemptCount() : self
- Sets attempt_count
- setContentHash() : self
- Sets content_hash
- setCreatedAt() : self
- Sets created_at
- setFailureCode() : self
- Sets failure_code
- setId() : self
- Sets id
- setMaxAttempts() : self
- Sets max_attempts
- setObservedAt() : self
- Sets observed_at
- setOutcomeClass() : self
- Sets outcome_class
- setProgramId() : self
- Sets program_id
- setRampDay() : self
- Sets ramp_day
- setReconciliationRequired() : self
- Sets reconciliation_required
- setScheduledFor() : self
- Sets scheduled_for
- setSequence() : self
- Sets sequence
- setSlotDate() : self
- Sets slot_date
- setStatus() : self
- Sets status
- setTargetClass() : self
- Sets target_class
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- 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
OUTCOME_CLASS_ACCEPTED
public
mixed
OUTCOME_CLASS_ACCEPTED
= 'ACCEPTED'
OUTCOME_CLASS_AMBIGUOUS
public
mixed
OUTCOME_CLASS_AMBIGUOUS
= 'AMBIGUOUS'
OUTCOME_CLASS_PERMANENT
public
mixed
OUTCOME_CLASS_PERMANENT
= 'PERMANENT'
OUTCOME_CLASS_RETRYABLE
public
mixed
OUTCOME_CLASS_RETRYABLE
= 'RETRYABLE'
OUTCOME_CLASS_SKIPPED
public
mixed
OUTCOME_CLASS_SKIPPED
= 'SKIPPED'
STATUS_ACCEPTED
public
mixed
STATUS_ACCEPTED
= 'ACCEPTED'
STATUS_AMBIGUOUS
public
mixed
STATUS_AMBIGUOUS
= 'AMBIGUOUS'
STATUS_CLAIMED
public
mixed
STATUS_CLAIMED
= 'CLAIMED'
STATUS_FAILED
public
mixed
STATUS_FAILED
= 'FAILED'
STATUS_PLANNED
public
mixed
STATUS_PLANNED
= 'PLANNED'
STATUS_RETRYABLE
public
mixed
STATUS_RETRYABLE
= 'RETRYABLE'
STATUS_SKIPPED
public
mixed
STATUS_SKIPPED
= 'SKIPPED'
TARGET_CLASS_MS2_CONTROLLED_MX
public
mixed
TARGET_CLASS_MS2_CONTROLLED_MX
= 'MS2_CONTROLLED_MX'
TARGET_CLASS_PROVIDER_SEED_PASSIVE
public
mixed
TARGET_CLASS_PROVIDER_SEED_PASSIVE
= 'PROVIDER_SEED_PASSIVE'
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', 'slot_date' => 'slotDate', 'ramp_day' => 'rampDay', 'sequence' => 'sequence', 'scheduled_for' => 'scheduledFor', 'status' => 'status', 'target_class' => 'targetClass', 'content_hash' => 'contentHash', 'attempt_count' => 'attemptCount', 'max_attempts' => 'maxAttempts', 'accepted_at' => 'acceptedAt', 'observed_at' => 'observedAt', 'outcome_class' => 'outcomeClass', 'failure_code' => 'failureCode', 'reconciliation_required' => 'reconciliationRequired', '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', 'slot_date' => 'getSlotDate', 'ramp_day' => 'getRampDay', 'sequence' => 'getSequence', 'scheduled_for' => 'getScheduledFor', 'status' => 'getStatus', 'target_class' => 'getTargetClass', 'content_hash' => 'getContentHash', 'attempt_count' => 'getAttemptCount', 'max_attempts' => 'getMaxAttempts', 'accepted_at' => 'getAcceptedAt', 'observed_at' => 'getObservedAt', 'outcome_class' => 'getOutcomeClass', 'failure_code' => 'getFailureCode', 'reconciliation_required' => 'getReconciliationRequired', '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', 'slot_date' => 'date', 'ramp_day' => 'int32', 'sequence' => 'int32', 'scheduled_for' => 'date-time', 'status' => null, 'target_class' => null, 'content_hash' => null, 'attempt_count' => 'int32', 'max_attempts' => 'int32', 'accepted_at' => 'date-time', 'observed_at' => 'date-time', 'outcome_class' => null, 'failure_code' => null, 'reconciliation_required' => null, 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'EmailWarmupSendSlotDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'program_id' => false, 'slot_date' => false, 'ramp_day' => false, 'sequence' => false, 'scheduled_for' => false, 'status' => false, 'target_class' => false, 'content_hash' => false, 'attempt_count' => false, 'max_attempts' => false, 'accepted_at' => true, 'observed_at' => true, 'outcome_class' => true, 'failure_code' => true, 'reconciliation_required' => false, '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', 'slot_date' => '\\DateTime', 'ramp_day' => 'int', 'sequence' => 'int', 'scheduled_for' => '\\DateTime', 'status' => 'string', 'target_class' => 'string', 'content_hash' => 'string', 'attempt_count' => 'int', 'max_attempts' => 'int', 'accepted_at' => '\\DateTime', 'observed_at' => '\\DateTime', 'outcome_class' => 'string', 'failure_code' => 'string', 'reconciliation_required' => 'bool', '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', 'slot_date' => 'setSlotDate', 'ramp_day' => 'setRampDay', 'sequence' => 'setSequence', 'scheduled_for' => 'setScheduledFor', 'status' => 'setStatus', 'target_class' => 'setTargetClass', 'content_hash' => 'setContentHash', 'attempt_count' => 'setAttemptCount', 'max_attempts' => 'setMaxAttempts', 'accepted_at' => 'setAcceptedAt', 'observed_at' => 'setObservedAt', 'outcome_class' => 'setOutcomeClass', 'failure_code' => 'setFailureCode', 'reconciliation_required' => 'setReconciliationRequired', '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> —getAcceptedAt()
Gets accepted_at
public
getAcceptedAt() : DateTime|null
Return values
DateTime|null —getAttemptCount()
Gets attempt_count
public
getAttemptCount() : int
Return values
int —getContentHash()
Gets content_hash
public
getContentHash() : string
Return values
string —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 —getMaxAttempts()
Gets max_attempts
public
getMaxAttempts() : int
Return values
int —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getObservedAt()
Gets observed_at
public
getObservedAt() : DateTime|null
Return values
DateTime|null —getOutcomeClass()
Gets outcome_class
public
getOutcomeClass() : string|null
Return values
string|null —getOutcomeClassAllowableValues()
Gets allowable values of the enum
public
getOutcomeClassAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getProgramId()
Gets program_id
public
getProgramId() : string
Return values
string —getRampDay()
Gets ramp_day
public
getRampDay() : int
Return values
int —getReconciliationRequired()
Gets reconciliation_required
public
getReconciliationRequired() : bool
Return values
bool —getScheduledFor()
Gets scheduled_for
public
getScheduledFor() : DateTime
Return values
DateTime —getSequence()
Gets sequence
public
getSequence() : int
Return values
int —getSlotDate()
Gets slot_date
public
getSlotDate() : DateTime
Return values
DateTime —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> —getTargetClass()
Gets target_class
public
getTargetClass() : string
Return values
string —getTargetClassAllowableValues()
Gets allowable values of the enum
public
getTargetClassAllowableValues() : 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> —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> —setAcceptedAt()
Sets accepted_at
public
setAcceptedAt(DateTime|null $accepted_at) : self
Parameters
- $accepted_at : DateTime|null
-
accepted_at
Return values
self —setAttemptCount()
Sets attempt_count
public
setAttemptCount(int $attempt_count) : self
Parameters
- $attempt_count : int
-
attempt_count
Return values
self —setContentHash()
Sets content_hash
public
setContentHash(string $content_hash) : self
Parameters
- $content_hash : string
-
content_hash
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 —setMaxAttempts()
Sets max_attempts
public
setMaxAttempts(int $max_attempts) : self
Parameters
- $max_attempts : int
-
max_attempts
Return values
self —setObservedAt()
Sets observed_at
public
setObservedAt(DateTime|null $observed_at) : self
Parameters
- $observed_at : DateTime|null
-
observed_at
Return values
self —setOutcomeClass()
Sets outcome_class
public
setOutcomeClass(string|null $outcome_class) : self
Parameters
- $outcome_class : string|null
-
outcome_class
Return values
self —setProgramId()
Sets program_id
public
setProgramId(string $program_id) : self
Parameters
- $program_id : string
-
program_id
Return values
self —setRampDay()
Sets ramp_day
public
setRampDay(int $ramp_day) : self
Parameters
- $ramp_day : int
-
ramp_day
Return values
self —setReconciliationRequired()
Sets reconciliation_required
public
setReconciliationRequired(bool $reconciliation_required) : self
Parameters
- $reconciliation_required : bool
-
reconciliation_required
Return values
self —setScheduledFor()
Sets scheduled_for
public
setScheduledFor(DateTime $scheduled_for) : self
Parameters
- $scheduled_for : DateTime
-
scheduled_for
Return values
self —setSequence()
Sets sequence
public
setSequence(int $sequence) : self
Parameters
- $sequence : int
-
sequence
Return values
self —setSlotDate()
Sets slot_date
public
setSlotDate(DateTime $slot_date) : self
Parameters
- $slot_date : DateTime
-
slot_date
Return values
self —setStatus()
Sets status
public
setStatus(string $status) : self
Parameters
- $status : string
-
status
Return values
self —setTargetClass()
Sets target_class
public
setTargetClass(string $target_class) : self
Parameters
- $target_class : string
-
target_class
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> —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>