CreateEmailWarmupProgramOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
CreateEmailWarmupProgramOptions Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- CUSTOMER_INTENT_EXISTING_SENDER_REPAIR = 'EXISTING_SENDER_REPAIR'
- CUSTOMER_INTENT_NEW_SENDER_WARMUP = 'NEW_SENDER_WARMUP'
- DISCRIMINATOR = null
- REQUESTED_COVERAGE_AUTO = 'AUTO'
- REQUESTED_COVERAGE_CONTROLLED = 'CONTROLLED'
- REQUESTED_COVERAGE_CORE = 'CORE'
- REQUESTED_COVERAGE_EXPANDED = 'EXPANDED'
- 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
- getBaselineTestId() : string|null
- Gets baseline_test_id
- getConnectionId() : string
- Gets connection_id
- getContent() : EmailWarmupContentOptions
- Gets content
- getCurrentDailyVolume() : int
- Gets current_daily_volume
- getCustomerIntent() : string
- Gets customer_intent
- getCustomerIntentAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getGoalDailyVolume() : int
- Gets goal_daily_volume
- getMaintenanceDailyVolume() : int
- Gets maintenance_daily_volume
- getMaintenanceEnabled() : bool
- Gets maintenance_enabled
- getModelName() : string
- The original name of the model.
- getName() : string
- Gets name
- getPermissionBasedSendingAttested() : bool
- Gets permission_based_sending_attested
- getRampDurationDays() : int
- Gets ramp_duration_days
- getRequestedCoverage() : string
- Gets requested_coverage
- getRequestedCoverageAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getSchedulePreset() : string
- Gets schedule_preset
- getSchedulePresetAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getSenderOwnershipAttested() : bool
- Gets sender_ownership_attested
- getSendWindowEnd() : string
- Gets send_window_end
- getSendWindowStart() : string
- Gets send_window_start
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTimeZone() : string
- 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
- setBaselineTestId() : self
- Sets baseline_test_id
- setConnectionId() : self
- Sets connection_id
- setContent() : self
- Sets content
- setCurrentDailyVolume() : self
- Sets current_daily_volume
- setCustomerIntent() : self
- Sets customer_intent
- setGoalDailyVolume() : self
- Sets goal_daily_volume
- setMaintenanceDailyVolume() : self
- Sets maintenance_daily_volume
- setMaintenanceEnabled() : self
- Sets maintenance_enabled
- setName() : self
- Sets name
- setPermissionBasedSendingAttested() : self
- Sets permission_based_sending_attested
- setRampDurationDays() : self
- Sets ramp_duration_days
- setRequestedCoverage() : self
- Sets requested_coverage
- setSchedulePreset() : self
- Sets schedule_preset
- setSenderOwnershipAttested() : self
- Sets sender_ownership_attested
- 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
CUSTOMER_INTENT_EXISTING_SENDER_REPAIR
public
mixed
CUSTOMER_INTENT_EXISTING_SENDER_REPAIR
= 'EXISTING_SENDER_REPAIR'
CUSTOMER_INTENT_NEW_SENDER_WARMUP
public
mixed
CUSTOMER_INTENT_NEW_SENDER_WARMUP
= 'NEW_SENDER_WARMUP'
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
REQUESTED_COVERAGE_AUTO
public
mixed
REQUESTED_COVERAGE_AUTO
= 'AUTO'
REQUESTED_COVERAGE_CONTROLLED
public
mixed
REQUESTED_COVERAGE_CONTROLLED
= 'CONTROLLED'
REQUESTED_COVERAGE_CORE
public
mixed
REQUESTED_COVERAGE_CORE
= 'CORE'
REQUESTED_COVERAGE_EXPANDED
public
mixed
REQUESTED_COVERAGE_EXPANDED
= 'EXPANDED'
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
= ['name' => 'name', 'connection_id' => 'connectionId', 'customer_intent' => 'customerIntent', 'current_daily_volume' => 'currentDailyVolume', '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', 'requested_coverage' => 'requestedCoverage', 'baseline_test_id' => 'baselineTestId', 'content' => 'content', 'sender_ownership_attested' => 'senderOwnershipAttested', 'permission_based_sending_attested' => 'permissionBasedSendingAttested']
$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
= ['name' => 'getName', 'connection_id' => 'getConnectionId', 'customer_intent' => 'getCustomerIntent', 'current_daily_volume' => 'getCurrentDailyVolume', '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', 'requested_coverage' => 'getRequestedCoverage', 'baseline_test_id' => 'getBaselineTestId', 'content' => 'getContent', 'sender_ownership_attested' => 'getSenderOwnershipAttested', 'permission_based_sending_attested' => 'getPermissionBasedSendingAttested']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['name' => null, 'connection_id' => 'uuid', 'customer_intent' => null, 'current_daily_volume' => 'int32', '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, 'requested_coverage' => null, 'baseline_test_id' => 'uuid', 'content' => null, 'sender_ownership_attested' => null, 'permission_based_sending_attested' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'CreateEmailWarmupProgramOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['name' => false, 'connection_id' => false, 'customer_intent' => false, 'current_daily_volume' => false, 'goal_daily_volume' => false, 'schedule_preset' => false, 'ramp_duration_days' => false, 'maintenance_enabled' => false, 'maintenance_daily_volume' => false, 'send_window_start' => false, 'send_window_end' => false, 'time_zone' => false, 'requested_coverage' => false, 'baseline_test_id' => true, 'content' => false, 'sender_ownership_attested' => false, 'permission_based_sending_attested' => 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
= ['name' => 'string', 'connection_id' => 'string', 'customer_intent' => 'string', 'current_daily_volume' => 'int', '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', 'requested_coverage' => 'string', 'baseline_test_id' => 'string', 'content' => '\\MailSlurp\\Models\\EmailWarmupContentOptions', 'sender_ownership_attested' => 'bool', 'permission_based_sending_attested' => 'bool']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['name' => 'setName', 'connection_id' => 'setConnectionId', 'customer_intent' => 'setCustomerIntent', 'current_daily_volume' => 'setCurrentDailyVolume', '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', 'requested_coverage' => 'setRequestedCoverage', 'baseline_test_id' => 'setBaselineTestId', 'content' => 'setContent', 'sender_ownership_attested' => 'setSenderOwnershipAttested', 'permission_based_sending_attested' => 'setPermissionBasedSendingAttested']
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> —getBaselineTestId()
Gets baseline_test_id
public
getBaselineTestId() : string|null
Return values
string|null —getConnectionId()
Gets connection_id
public
getConnectionId() : string
Return values
string —getContent()
Gets content
public
getContent() : EmailWarmupContentOptions
Return values
EmailWarmupContentOptions —getCurrentDailyVolume()
Gets current_daily_volume
public
getCurrentDailyVolume() : int
Return values
int —getCustomerIntent()
Gets customer_intent
public
getCustomerIntent() : string
Return values
string —getCustomerIntentAllowableValues()
Gets allowable values of the enum
public
getCustomerIntentAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getGoalDailyVolume()
Gets goal_daily_volume
public
getGoalDailyVolume() : int
Return values
int —getMaintenanceDailyVolume()
Gets maintenance_daily_volume
public
getMaintenanceDailyVolume() : int
Return values
int —getMaintenanceEnabled()
Gets maintenance_enabled
public
getMaintenanceEnabled() : bool
Return values
bool —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string
Return values
string —getPermissionBasedSendingAttested()
Gets permission_based_sending_attested
public
getPermissionBasedSendingAttested() : bool
Return values
bool —getRampDurationDays()
Gets ramp_duration_days
public
getRampDurationDays() : int
Return values
int —getRequestedCoverage()
Gets requested_coverage
public
getRequestedCoverage() : string
Return values
string —getRequestedCoverageAllowableValues()
Gets allowable values of the enum
public
getRequestedCoverageAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getSchedulePreset()
Gets schedule_preset
public
getSchedulePreset() : string
Return values
string —getSchedulePresetAllowableValues()
Gets allowable values of the enum
public
getSchedulePresetAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getSenderOwnershipAttested()
Gets sender_ownership_attested
public
getSenderOwnershipAttested() : bool
Return values
bool —getSendWindowEnd()
Gets send_window_end
public
getSendWindowEnd() : string
Return values
string —getSendWindowStart()
Gets send_window_start
public
getSendWindowStart() : 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> —getTimeZone()
Gets time_zone
public
getTimeZone() : string
Return values
string —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> —setBaselineTestId()
Sets baseline_test_id
public
setBaselineTestId(string|null $baseline_test_id) : self
Parameters
- $baseline_test_id : string|null
-
baseline_test_id
Return values
self —setConnectionId()
Sets connection_id
public
setConnectionId(string $connection_id) : self
Parameters
- $connection_id : string
-
connection_id
Return values
self —setContent()
Sets content
public
setContent(EmailWarmupContentOptions $content) : self
Parameters
- $content : EmailWarmupContentOptions
-
content
Return values
self —setCurrentDailyVolume()
Sets current_daily_volume
public
setCurrentDailyVolume(int $current_daily_volume) : self
Parameters
- $current_daily_volume : int
-
current_daily_volume
Return values
self —setCustomerIntent()
Sets customer_intent
public
setCustomerIntent(string $customer_intent) : self
Parameters
- $customer_intent : string
-
customer_intent
Return values
self —setGoalDailyVolume()
Sets goal_daily_volume
public
setGoalDailyVolume(int $goal_daily_volume) : self
Parameters
- $goal_daily_volume : int
-
goal_daily_volume
Return values
self —setMaintenanceDailyVolume()
Sets maintenance_daily_volume
public
setMaintenanceDailyVolume(int $maintenance_daily_volume) : self
Parameters
- $maintenance_daily_volume : int
-
maintenance_daily_volume
Return values
self —setMaintenanceEnabled()
Sets maintenance_enabled
public
setMaintenanceEnabled(bool $maintenance_enabled) : self
Parameters
- $maintenance_enabled : bool
-
maintenance_enabled
Return values
self —setName()
Sets name
public
setName(string $name) : self
Parameters
- $name : string
-
name
Return values
self —setPermissionBasedSendingAttested()
Sets permission_based_sending_attested
public
setPermissionBasedSendingAttested(bool $permission_based_sending_attested) : self
Parameters
- $permission_based_sending_attested : bool
-
permission_based_sending_attested
Return values
self —setRampDurationDays()
Sets ramp_duration_days
public
setRampDurationDays(int $ramp_duration_days) : self
Parameters
- $ramp_duration_days : int
-
ramp_duration_days
Return values
self —setRequestedCoverage()
Sets requested_coverage
public
setRequestedCoverage(string $requested_coverage) : self
Parameters
- $requested_coverage : string
-
requested_coverage
Return values
self —setSchedulePreset()
Sets schedule_preset
public
setSchedulePreset(string $schedule_preset) : self
Parameters
- $schedule_preset : string
-
schedule_preset
Return values
self —setSenderOwnershipAttested()
Sets sender_ownership_attested
public
setSenderOwnershipAttested(bool $sender_ownership_attested) : self
Parameters
- $sender_ownership_attested : bool
-
sender_ownership_attested
Return values
self —setSendWindowEnd()
Sets send_window_end
public
setSendWindowEnd(string $send_window_end) : self
Parameters
- $send_window_end : string
-
send_window_end
Return values
self —setSendWindowStart()
Sets send_window_start
public
setSendWindowStart(string $send_window_start) : self
Parameters
- $send_window_start : string
-
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 $time_zone) : self
Parameters
- $time_zone : string
-
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>