EmailWarmupOverviewDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
EmailWarmupOverviewDto 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
- getAcceptedSends() : int
- Gets accepted_sends
- getActivePrograms() : int
- Gets active_programs
- getAttentionRequiredPrograms() : int
- Gets attention_required_programs
- getDailyActivity() : array<string|int, EmailWarmupDailyActivityDto>
- Gets daily_activity
- getFailedSends() : int
- Gets failed_sends
- getFromDate() : DateTime
- Gets from_date
- getMaintenancePrograms() : int
- Gets maintenance_programs
- getModelName() : string
- The original name of the model.
- getPausedPrograms() : int
- Gets paused_programs
- getProgramProgress() : array<string|int, EmailWarmupProgramProgressDto>
- Gets program_progress
- getRampingPrograms() : int
- Gets ramping_programs
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getThroughDate() : DateTime
- Gets through_date
- getTotalPrograms() : int
- Gets total_programs
- 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
- setAcceptedSends() : self
- Sets accepted_sends
- setActivePrograms() : self
- Sets active_programs
- setAttentionRequiredPrograms() : self
- Sets attention_required_programs
- setDailyActivity() : self
- Sets daily_activity
- setFailedSends() : self
- Sets failed_sends
- setFromDate() : self
- Sets from_date
- setMaintenancePrograms() : self
- Sets maintenance_programs
- setPausedPrograms() : self
- Sets paused_programs
- setProgramProgress() : self
- Sets program_progress
- setRampingPrograms() : self
- Sets ramping_programs
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setThroughDate() : self
- Sets through_date
- setTotalPrograms() : self
- Sets total_programs
- 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
= ['from_date' => 'fromDate', 'through_date' => 'throughDate', 'total_programs' => 'totalPrograms', 'active_programs' => 'activePrograms', 'ramping_programs' => 'rampingPrograms', 'maintenance_programs' => 'maintenancePrograms', 'paused_programs' => 'pausedPrograms', 'attention_required_programs' => 'attentionRequiredPrograms', 'accepted_sends' => 'acceptedSends', 'failed_sends' => 'failedSends', 'daily_activity' => 'dailyActivity', 'program_progress' => 'programProgress']
$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
= ['from_date' => 'getFromDate', 'through_date' => 'getThroughDate', 'total_programs' => 'getTotalPrograms', 'active_programs' => 'getActivePrograms', 'ramping_programs' => 'getRampingPrograms', 'maintenance_programs' => 'getMaintenancePrograms', 'paused_programs' => 'getPausedPrograms', 'attention_required_programs' => 'getAttentionRequiredPrograms', 'accepted_sends' => 'getAcceptedSends', 'failed_sends' => 'getFailedSends', 'daily_activity' => 'getDailyActivity', 'program_progress' => 'getProgramProgress']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['from_date' => 'date', 'through_date' => 'date', 'total_programs' => 'int64', 'active_programs' => 'int64', 'ramping_programs' => 'int64', 'maintenance_programs' => 'int64', 'paused_programs' => 'int64', 'attention_required_programs' => 'int64', 'accepted_sends' => 'int64', 'failed_sends' => 'int64', 'daily_activity' => null, 'program_progress' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'EmailWarmupOverviewDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['from_date' => false, 'through_date' => false, 'total_programs' => false, 'active_programs' => false, 'ramping_programs' => false, 'maintenance_programs' => false, 'paused_programs' => false, 'attention_required_programs' => false, 'accepted_sends' => false, 'failed_sends' => false, 'daily_activity' => false, 'program_progress' => 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
= ['from_date' => '\\DateTime', 'through_date' => '\\DateTime', 'total_programs' => 'int', 'active_programs' => 'int', 'ramping_programs' => 'int', 'maintenance_programs' => 'int', 'paused_programs' => 'int', 'attention_required_programs' => 'int', 'accepted_sends' => 'int', 'failed_sends' => 'int', 'daily_activity' => '\\MailSlurp\\Models\\EmailWarmupDailyActivityDto[]', 'program_progress' => '\\MailSlurp\\Models\\EmailWarmupProgramProgressDto[]']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['from_date' => 'setFromDate', 'through_date' => 'setThroughDate', 'total_programs' => 'setTotalPrograms', 'active_programs' => 'setActivePrograms', 'ramping_programs' => 'setRampingPrograms', 'maintenance_programs' => 'setMaintenancePrograms', 'paused_programs' => 'setPausedPrograms', 'attention_required_programs' => 'setAttentionRequiredPrograms', 'accepted_sends' => 'setAcceptedSends', 'failed_sends' => 'setFailedSends', 'daily_activity' => 'setDailyActivity', 'program_progress' => 'setProgramProgress']
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> —getAcceptedSends()
Gets accepted_sends
public
getAcceptedSends() : int
Return values
int —getActivePrograms()
Gets active_programs
public
getActivePrograms() : int
Return values
int —getAttentionRequiredPrograms()
Gets attention_required_programs
public
getAttentionRequiredPrograms() : int
Return values
int —getDailyActivity()
Gets daily_activity
public
getDailyActivity() : array<string|int, EmailWarmupDailyActivityDto>
Return values
array<string|int, EmailWarmupDailyActivityDto> —getFailedSends()
Gets failed_sends
public
getFailedSends() : int
Return values
int —getFromDate()
Gets from_date
public
getFromDate() : DateTime
Return values
DateTime —getMaintenancePrograms()
Gets maintenance_programs
public
getMaintenancePrograms() : int
Return values
int —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPausedPrograms()
Gets paused_programs
public
getPausedPrograms() : int
Return values
int —getProgramProgress()
Gets program_progress
public
getProgramProgress() : array<string|int, EmailWarmupProgramProgressDto>
Return values
array<string|int, EmailWarmupProgramProgressDto> —getRampingPrograms()
Gets ramping_programs
public
getRampingPrograms() : 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> —getThroughDate()
Gets through_date
public
getThroughDate() : DateTime
Return values
DateTime —getTotalPrograms()
Gets total_programs
public
getTotalPrograms() : 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> —setAcceptedSends()
Sets accepted_sends
public
setAcceptedSends(int $accepted_sends) : self
Parameters
- $accepted_sends : int
-
accepted_sends
Return values
self —setActivePrograms()
Sets active_programs
public
setActivePrograms(int $active_programs) : self
Parameters
- $active_programs : int
-
active_programs
Return values
self —setAttentionRequiredPrograms()
Sets attention_required_programs
public
setAttentionRequiredPrograms(int $attention_required_programs) : self
Parameters
- $attention_required_programs : int
-
attention_required_programs
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 —setFailedSends()
Sets failed_sends
public
setFailedSends(int $failed_sends) : self
Parameters
- $failed_sends : int
-
failed_sends
Return values
self —setFromDate()
Sets from_date
public
setFromDate(DateTime $from_date) : self
Parameters
- $from_date : DateTime
-
from_date
Return values
self —setMaintenancePrograms()
Sets maintenance_programs
public
setMaintenancePrograms(int $maintenance_programs) : self
Parameters
- $maintenance_programs : int
-
maintenance_programs
Return values
self —setPausedPrograms()
Sets paused_programs
public
setPausedPrograms(int $paused_programs) : self
Parameters
- $paused_programs : int
-
paused_programs
Return values
self —setProgramProgress()
Sets program_progress
public
setProgramProgress(array<string|int, EmailWarmupProgramProgressDto> $program_progress) : self
Parameters
- $program_progress : array<string|int, EmailWarmupProgramProgressDto>
-
program_progress
Return values
self —setRampingPrograms()
Sets ramping_programs
public
setRampingPrograms(int $ramping_programs) : self
Parameters
- $ramping_programs : int
-
ramping_programs
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 —setTotalPrograms()
Sets total_programs
public
setTotalPrograms(int $total_programs) : self
Parameters
- $total_programs : int
-
total_programs
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>