UpdateEmailWarmupProgramOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
UpdateEmailWarmupProgramOptions Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- SCHEDULE_PRESET_CUSTOM = 'CUSTOM'
- SCHEDULE_PRESET_GENTLE = 'GENTLE'
- SCHEDULE_PRESET_REPAIR = 'REPAIR'
- SCHEDULE_PRESET_STANDARD = 'STANDARD'
- $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
- getContent() : UpdateEmailWarmupProgramOptionsContent|null
- Gets content
- getExpectedVersion() : int
- Gets expected_version
- getGoalDailyVolume() : int|null
- Gets goal_daily_volume
- getMaintenanceDailyVolume() : int|null
- Gets maintenance_daily_volume
- getMaintenanceEnabled() : bool|null
- Gets maintenance_enabled
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getRampDurationDays() : int|null
- Gets ramp_duration_days
- getSchedulePreset() : string|null
- Gets schedule_preset
- getSchedulePresetAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getSendWindowEnd() : string|null
- Gets send_window_end
- getSendWindowStart() : string|null
- Gets send_window_start
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTimeZone() : string|null
- Gets time_zone
- 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
- setContent() : self
- Sets content
- setExpectedVersion() : self
- Sets expected_version
- setGoalDailyVolume() : self
- Sets goal_daily_volume
- setMaintenanceDailyVolume() : self
- Sets maintenance_daily_volume
- setMaintenanceEnabled() : self
- Sets maintenance_enabled
- setName() : self
- Sets name
- setRampDurationDays() : self
- Sets ramp_duration_days
- setSchedulePreset() : self
- Sets schedule_preset
- setSendWindowEnd() : self
- Sets send_window_end
- setSendWindowStart() : self
- Sets send_window_start
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTimeZone() : self
- Sets time_zone
- 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
SCHEDULE_PRESET_CUSTOM
public
mixed
SCHEDULE_PRESET_CUSTOM
= 'CUSTOM'
SCHEDULE_PRESET_GENTLE
public
mixed
SCHEDULE_PRESET_GENTLE
= 'GENTLE'
SCHEDULE_PRESET_REPAIR
public
mixed
SCHEDULE_PRESET_REPAIR
= 'REPAIR'
SCHEDULE_PRESET_STANDARD
public
mixed
SCHEDULE_PRESET_STANDARD
= 'STANDARD'
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
= ['expected_version' => 'expectedVersion', 'name' => 'name', 'goal_daily_volume' => 'goalDailyVolume', 'schedule_preset' => 'schedulePreset', 'ramp_duration_days' => 'rampDurationDays', 'maintenance_enabled' => 'maintenanceEnabled', 'maintenance_daily_volume' => 'maintenanceDailyVolume', 'send_window_start' => 'sendWindowStart', 'send_window_end' => 'sendWindowEnd', 'time_zone' => 'timeZone', 'content' => 'content']
$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
= ['expected_version' => 'getExpectedVersion', 'name' => 'getName', 'goal_daily_volume' => 'getGoalDailyVolume', 'schedule_preset' => 'getSchedulePreset', 'ramp_duration_days' => 'getRampDurationDays', 'maintenance_enabled' => 'getMaintenanceEnabled', 'maintenance_daily_volume' => 'getMaintenanceDailyVolume', 'send_window_start' => 'getSendWindowStart', 'send_window_end' => 'getSendWindowEnd', 'time_zone' => 'getTimeZone', 'content' => 'getContent']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['expected_version' => 'int64', 'name' => null, 'goal_daily_volume' => 'int32', 'schedule_preset' => null, 'ramp_duration_days' => 'int32', 'maintenance_enabled' => null, 'maintenance_daily_volume' => 'int32', 'send_window_start' => null, 'send_window_end' => null, 'time_zone' => null, 'content' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'UpdateEmailWarmupProgramOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['expected_version' => false, 'name' => true, 'goal_daily_volume' => true, 'schedule_preset' => true, 'ramp_duration_days' => true, 'maintenance_enabled' => true, 'maintenance_daily_volume' => true, 'send_window_start' => true, 'send_window_end' => true, 'time_zone' => true, 'content' => 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
= ['expected_version' => 'int', 'name' => 'string', 'goal_daily_volume' => 'int', 'schedule_preset' => 'string', 'ramp_duration_days' => 'int', 'maintenance_enabled' => 'bool', 'maintenance_daily_volume' => 'int', 'send_window_start' => 'string', 'send_window_end' => 'string', 'time_zone' => 'string', 'content' => '\\MailSlurp\\Models\\UpdateEmailWarmupProgramOptionsContent']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['expected_version' => 'setExpectedVersion', 'name' => 'setName', 'goal_daily_volume' => 'setGoalDailyVolume', 'schedule_preset' => 'setSchedulePreset', 'ramp_duration_days' => 'setRampDurationDays', 'maintenance_enabled' => 'setMaintenanceEnabled', 'maintenance_daily_volume' => 'setMaintenanceDailyVolume', 'send_window_start' => 'setSendWindowStart', 'send_window_end' => 'setSendWindowEnd', 'time_zone' => 'setTimeZone', 'content' => 'setContent']
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> —getContent()
Gets content
public
getContent() : UpdateEmailWarmupProgramOptionsContent|null
Return values
UpdateEmailWarmupProgramOptionsContent|null —getExpectedVersion()
Gets expected_version
public
getExpectedVersion() : int
Return values
int —getGoalDailyVolume()
Gets goal_daily_volume
public
getGoalDailyVolume() : int|null
Return values
int|null —getMaintenanceDailyVolume()
Gets maintenance_daily_volume
public
getMaintenanceDailyVolume() : int|null
Return values
int|null —getMaintenanceEnabled()
Gets maintenance_enabled
public
getMaintenanceEnabled() : bool|null
Return values
bool|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getRampDurationDays()
Gets ramp_duration_days
public
getRampDurationDays() : int|null
Return values
int|null —getSchedulePreset()
Gets schedule_preset
public
getSchedulePreset() : string|null
Return values
string|null —getSchedulePresetAllowableValues()
Gets allowable values of the enum
public
getSchedulePresetAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getSendWindowEnd()
Gets send_window_end
public
getSendWindowEnd() : string|null
Return values
string|null —getSendWindowStart()
Gets send_window_start
public
getSendWindowStart() : string|null
Return values
string|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> —getTimeZone()
Gets time_zone
public
getTimeZone() : string|null
Return values
string|null —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> —setContent()
Sets content
public
setContent(UpdateEmailWarmupProgramOptionsContent|null $content) : self
Parameters
- $content : UpdateEmailWarmupProgramOptionsContent|null
-
content
Return values
self —setExpectedVersion()
Sets expected_version
public
setExpectedVersion(int $expected_version) : self
Parameters
- $expected_version : int
-
expected_version
Return values
self —setGoalDailyVolume()
Sets goal_daily_volume
public
setGoalDailyVolume(int|null $goal_daily_volume) : self
Parameters
- $goal_daily_volume : int|null
-
goal_daily_volume
Return values
self —setMaintenanceDailyVolume()
Sets maintenance_daily_volume
public
setMaintenanceDailyVolume(int|null $maintenance_daily_volume) : self
Parameters
- $maintenance_daily_volume : int|null
-
maintenance_daily_volume
Return values
self —setMaintenanceEnabled()
Sets maintenance_enabled
public
setMaintenanceEnabled(bool|null $maintenance_enabled) : self
Parameters
- $maintenance_enabled : bool|null
-
maintenance_enabled
Return values
self —setName()
Sets name
public
setName(string|null $name) : self
Parameters
- $name : string|null
-
name
Return values
self —setRampDurationDays()
Sets ramp_duration_days
public
setRampDurationDays(int|null $ramp_duration_days) : self
Parameters
- $ramp_duration_days : int|null
-
ramp_duration_days
Return values
self —setSchedulePreset()
Sets schedule_preset
public
setSchedulePreset(string|null $schedule_preset) : self
Parameters
- $schedule_preset : string|null
-
schedule_preset
Return values
self —setSendWindowEnd()
Sets send_window_end
public
setSendWindowEnd(string|null $send_window_end) : self
Parameters
- $send_window_end : string|null
-
send_window_end
Return values
self —setSendWindowStart()
Sets send_window_start
public
setSendWindowStart(string|null $send_window_start) : self
Parameters
- $send_window_start : string|null
-
send_window_start
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> —setTimeZone()
Sets time_zone
public
setTimeZone(string|null $time_zone) : self
Parameters
- $time_zone : string|null
-
time_zone
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>