EmailWarmupPacingDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
EmailWarmupPacingDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- ACTION_HOLD = 'HOLD'
- ACTION_INCREASE = 'INCREASE'
- ACTION_REDUCE = 'REDUCE'
- 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
- getAction() : string
- Gets action
- getActionAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getConfiguredDailyTarget() : int
- Gets configured_daily_target
- getEffectiveDailyTarget() : int
- Gets effective_daily_target
- getExplanation() : string
- Gets explanation
- getModelName() : string
- The original name of the model.
- getReasonCode() : string
- Gets reason_code
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- 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
- setAction() : self
- Sets action
- setConfiguredDailyTarget() : self
- Sets configured_daily_target
- setEffectiveDailyTarget() : self
- Sets effective_daily_target
- setExplanation() : self
- Sets explanation
- setReasonCode() : self
- Sets reason_code
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- 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
ACTION_HOLD
public
mixed
ACTION_HOLD
= 'HOLD'
ACTION_INCREASE
public
mixed
ACTION_INCREASE
= 'INCREASE'
ACTION_REDUCE
public
mixed
ACTION_REDUCE
= 'REDUCE'
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
= ['configured_daily_target' => 'configuredDailyTarget', 'effective_daily_target' => 'effectiveDailyTarget', 'action' => 'action', 'reason_code' => 'reasonCode', 'explanation' => 'explanation']
$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
= ['configured_daily_target' => 'getConfiguredDailyTarget', 'effective_daily_target' => 'getEffectiveDailyTarget', 'action' => 'getAction', 'reason_code' => 'getReasonCode', 'explanation' => 'getExplanation']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['configured_daily_target' => 'int32', 'effective_daily_target' => 'int32', 'action' => null, 'reason_code' => null, 'explanation' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'EmailWarmupPacingDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['configured_daily_target' => false, 'effective_daily_target' => false, 'action' => false, 'reason_code' => false, 'explanation' => 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
= ['configured_daily_target' => 'int', 'effective_daily_target' => 'int', 'action' => 'string', 'reason_code' => 'string', 'explanation' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['configured_daily_target' => 'setConfiguredDailyTarget', 'effective_daily_target' => 'setEffectiveDailyTarget', 'action' => 'setAction', 'reason_code' => 'setReasonCode', 'explanation' => 'setExplanation']
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> —getAction()
Gets action
public
getAction() : string
Return values
string —getActionAllowableValues()
Gets allowable values of the enum
public
getActionAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getConfiguredDailyTarget()
Gets configured_daily_target
public
getConfiguredDailyTarget() : int
Return values
int —getEffectiveDailyTarget()
Gets effective_daily_target
public
getEffectiveDailyTarget() : int
Return values
int —getExplanation()
Gets explanation
public
getExplanation() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getReasonCode()
Gets reason_code
public
getReasonCode() : string
Return values
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 —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> —setAction()
Sets action
public
setAction(string $action) : self
Parameters
- $action : string
-
action
Return values
self —setConfiguredDailyTarget()
Sets configured_daily_target
public
setConfiguredDailyTarget(int $configured_daily_target) : self
Parameters
- $configured_daily_target : int
-
configured_daily_target
Return values
self —setEffectiveDailyTarget()
Sets effective_daily_target
public
setEffectiveDailyTarget(int $effective_daily_target) : self
Parameters
- $effective_daily_target : int
-
effective_daily_target
Return values
self —setExplanation()
Sets explanation
public
setExplanation(string $explanation) : self
Parameters
- $explanation : string
-
explanation
Return values
self —setReasonCode()
Sets reason_code
public
setReasonCode(string $reason_code) : self
Parameters
- $reason_code : string
-
reason_code
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>