EmailWarmupProgramAnalyticsDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
EmailWarmupProgramAnalyticsDto Class Doc Comment
Tags
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
- getAttentionRequiredSends() : int
- Gets attention_required_sends
- getDailyActivity() : array<string|int, EmailWarmupDailyActivityDto>
- Gets daily_activity
- getFromDate() : DateTime
- Gets from_date
- getModelName() : string
- The original name of the model.
- getPlacementChecks() : array<string|int, EmailWarmupPlacementCheckDto>
- Gets placement_checks
- getProgramId() : string
- Gets program_id
- getProgress() : EmailWarmupProgramProgressDto
- Gets progress
- getReadiness() : EmailWarmupProgramAnalyticsDtoReadiness|null
- Gets readiness
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getThroughDate() : DateTime
- Gets through_date
- getTotalAcceptedSends() : int
- Gets total_accepted_sends
- getTotalFailedSends() : int
- Gets total_failed_sends
- getTotalObservedSends() : int
- Gets total_observed_sends
- getTotalScheduledSends() : int
- Gets total_scheduled_sends
- 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
- setAttentionRequiredSends() : self
- Sets attention_required_sends
- setDailyActivity() : self
- Sets daily_activity
- setFromDate() : self
- Sets from_date
- setPlacementChecks() : self
- Sets placement_checks
- setProgramId() : self
- Sets program_id
- setProgress() : self
- Sets progress
- setReadiness() : self
- Sets readiness
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setThroughDate() : self
- Sets through_date
- setTotalAcceptedSends() : self
- Sets total_accepted_sends
- setTotalFailedSends() : self
- Sets total_failed_sends
- setTotalObservedSends() : self
- Sets total_observed_sends
- setTotalScheduledSends() : self
- Sets total_scheduled_sends
- 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
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
= ['program_id' => 'programId', 'from_date' => 'fromDate', 'through_date' => 'throughDate', 'progress' => 'progress', 'total_scheduled_sends' => 'totalScheduledSends', 'total_accepted_sends' => 'totalAcceptedSends', 'total_observed_sends' => 'totalObservedSends', 'total_failed_sends' => 'totalFailedSends', 'attention_required_sends' => 'attentionRequiredSends', 'daily_activity' => 'dailyActivity', 'placement_checks' => 'placementChecks', 'readiness' => 'readiness']
$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
= ['program_id' => 'getProgramId', 'from_date' => 'getFromDate', 'through_date' => 'getThroughDate', 'progress' => 'getProgress', 'total_scheduled_sends' => 'getTotalScheduledSends', 'total_accepted_sends' => 'getTotalAcceptedSends', 'total_observed_sends' => 'getTotalObservedSends', 'total_failed_sends' => 'getTotalFailedSends', 'attention_required_sends' => 'getAttentionRequiredSends', 'daily_activity' => 'getDailyActivity', 'placement_checks' => 'getPlacementChecks', 'readiness' => 'getReadiness']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['program_id' => 'uuid', 'from_date' => 'date', 'through_date' => 'date', 'progress' => null, 'total_scheduled_sends' => 'int64', 'total_accepted_sends' => 'int64', 'total_observed_sends' => 'int64', 'total_failed_sends' => 'int64', 'attention_required_sends' => 'int64', 'daily_activity' => null, 'placement_checks' => null, 'readiness' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'EmailWarmupProgramAnalyticsDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['program_id' => false, 'from_date' => false, 'through_date' => false, 'progress' => false, 'total_scheduled_sends' => false, 'total_accepted_sends' => false, 'total_observed_sends' => false, 'total_failed_sends' => false, 'attention_required_sends' => false, 'daily_activity' => false, 'placement_checks' => false, 'readiness' => 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
= ['program_id' => 'string', 'from_date' => '\\DateTime', 'through_date' => '\\DateTime', 'progress' => '\\MailSlurp\\Models\\EmailWarmupProgramProgressDto', 'total_scheduled_sends' => 'int', 'total_accepted_sends' => 'int', 'total_observed_sends' => 'int', 'total_failed_sends' => 'int', 'attention_required_sends' => 'int', 'daily_activity' => '\\MailSlurp\\Models\\EmailWarmupDailyActivityDto[]', 'placement_checks' => '\\MailSlurp\\Models\\EmailWarmupPlacementCheckDto[]', 'readiness' => '\\MailSlurp\\Models\\EmailWarmupProgramAnalyticsDtoReadiness']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['program_id' => 'setProgramId', 'from_date' => 'setFromDate', 'through_date' => 'setThroughDate', 'progress' => 'setProgress', 'total_scheduled_sends' => 'setTotalScheduledSends', 'total_accepted_sends' => 'setTotalAcceptedSends', 'total_observed_sends' => 'setTotalObservedSends', 'total_failed_sends' => 'setTotalFailedSends', 'attention_required_sends' => 'setAttentionRequiredSends', 'daily_activity' => 'setDailyActivity', 'placement_checks' => 'setPlacementChecks', 'readiness' => 'setReadiness']
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> —getAttentionRequiredSends()
Gets attention_required_sends
public
getAttentionRequiredSends() : int
Return values
int —getDailyActivity()
Gets daily_activity
public
getDailyActivity() : array<string|int, EmailWarmupDailyActivityDto>
Return values
array<string|int, EmailWarmupDailyActivityDto> —getFromDate()
Gets from_date
public
getFromDate() : DateTime
Return values
DateTime —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPlacementChecks()
Gets placement_checks
public
getPlacementChecks() : array<string|int, EmailWarmupPlacementCheckDto>
Return values
array<string|int, EmailWarmupPlacementCheckDto> —getProgramId()
Gets program_id
public
getProgramId() : string
Return values
string —getProgress()
Gets progress
public
getProgress() : EmailWarmupProgramProgressDto
Return values
EmailWarmupProgramProgressDto —getReadiness()
Gets readiness
public
getReadiness() : EmailWarmupProgramAnalyticsDtoReadiness|null
Return values
EmailWarmupProgramAnalyticsDtoReadiness|null —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getThroughDate()
Gets through_date
public
getThroughDate() : DateTime
Return values
DateTime —getTotalAcceptedSends()
Gets total_accepted_sends
public
getTotalAcceptedSends() : int
Return values
int —getTotalFailedSends()
Gets total_failed_sends
public
getTotalFailedSends() : int
Return values
int —getTotalObservedSends()
Gets total_observed_sends
public
getTotalObservedSends() : int
Return values
int —getTotalScheduledSends()
Gets total_scheduled_sends
public
getTotalScheduledSends() : int
Return values
int —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> —setAttentionRequiredSends()
Sets attention_required_sends
public
setAttentionRequiredSends(int $attention_required_sends) : self
Parameters
- $attention_required_sends : int
-
attention_required_sends
Return values
self —setDailyActivity()
Sets daily_activity
public
setDailyActivity(array<string|int, EmailWarmupDailyActivityDto> $daily_activity) : self
Parameters
- $daily_activity : array<string|int, EmailWarmupDailyActivityDto>
-
daily_activity
Return values
self —setFromDate()
Sets from_date
public
setFromDate(DateTime $from_date) : self
Parameters
- $from_date : DateTime
-
from_date
Return values
self —setPlacementChecks()
Sets placement_checks
public
setPlacementChecks(array<string|int, EmailWarmupPlacementCheckDto> $placement_checks) : self
Parameters
- $placement_checks : array<string|int, EmailWarmupPlacementCheckDto>
-
placement_checks
Return values
self —setProgramId()
Sets program_id
public
setProgramId(string $program_id) : self
Parameters
- $program_id : string
-
program_id
Return values
self —setProgress()
Sets progress
public
setProgress(EmailWarmupProgramProgressDto $progress) : self
Parameters
- $progress : EmailWarmupProgramProgressDto
-
progress
Return values
self —setReadiness()
Sets readiness
public
setReadiness(EmailWarmupProgramAnalyticsDtoReadiness|null $readiness) : self
Parameters
- $readiness : EmailWarmupProgramAnalyticsDtoReadiness|null
-
readiness
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> —setThroughDate()
Sets through_date
public
setThroughDate(DateTime $through_date) : self
Parameters
- $through_date : DateTime
-
through_date
Return values
self —setTotalAcceptedSends()
Sets total_accepted_sends
public
setTotalAcceptedSends(int $total_accepted_sends) : self
Parameters
- $total_accepted_sends : int
-
total_accepted_sends
Return values
self —setTotalFailedSends()
Sets total_failed_sends
public
setTotalFailedSends(int $total_failed_sends) : self
Parameters
- $total_failed_sends : int
-
total_failed_sends
Return values
self —setTotalObservedSends()
Sets total_observed_sends
public
setTotalObservedSends(int $total_observed_sends) : self
Parameters
- $total_observed_sends : int
-
total_observed_sends
Return values
self —setTotalScheduledSends()
Sets total_scheduled_sends
public
setTotalScheduledSends(int $total_scheduled_sends) : self
Parameters
- $total_scheduled_sends : int
-
total_scheduled_sends
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>