EmailWarmupProgramDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
EmailWarmupProgramDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- BASELINE_SOURCE_NONE = 'NONE'
- BASELINE_SOURCE_PROGRAM_CHECKPOINT = 'PROGRAM_CHECKPOINT'
- BASELINE_SOURCE_SUPPLIED = 'SUPPLIED'
- BLOCKERS_API_DISABLED = 'API_DISABLED'
- BLOCKERS_BILLING_NOT_READY = 'BILLING_NOT_READY'
- BLOCKERS_CHECKPOINTS_DISABLED = 'CHECKPOINTS_DISABLED'
- BLOCKERS_CONNECTION_NOT_VERIFIED = 'CONNECTION_NOT_VERIFIED'
- BLOCKERS_CONNECTION_VERIFICATION_STALE = 'CONNECTION_VERIFICATION_STALE'
- BLOCKERS_CONTROLLED_MX_UNAVAILABLE = 'CONTROLLED_MX_UNAVAILABLE'
- BLOCKERS_EXECUTION_DISABLED = 'EXECUTION_DISABLED'
- BLOCKERS_PREMIUM_COVERAGE_REQUIRED = 'PREMIUM_COVERAGE_REQUIRED'
- BLOCKERS_PROVIDER_DISABLED = 'PROVIDER_DISABLED'
- BLOCKERS_SENDER_IDENTITY_CHANGED = 'SENDER_IDENTITY_CHANGED'
- CONTENT_SOURCE_AI_ASSISTED_TEMPLATE = 'AI_ASSISTED_TEMPLATE'
- CONTENT_SOURCE_CUSTOM_TEMPLATE = 'CUSTOM_TEMPLATE'
- CONTENT_SOURCE_MANAGED_CONTROL = 'MANAGED_CONTROL'
- CUSTOMER_INTENT_EXISTING_SENDER_REPAIR = 'EXISTING_SENDER_REPAIR'
- CUSTOMER_INTENT_NEW_SENDER_WARMUP = 'NEW_SENDER_WARMUP'
- DISCRIMINATOR = null
- EXECUTION_POLICY_ASSISTED_CAMPAIGN_RAMP = 'ASSISTED_CAMPAIGN_RAMP'
- EXECUTION_POLICY_HIGH_VOLUME_INFRASTRUCTURE_RAMP = 'HIGH_VOLUME_INFRASTRUCTURE_RAMP'
- EXECUTION_POLICY_LOW_VOLUME_MAILBOX_RAMP = 'LOW_VOLUME_MAILBOX_RAMP'
- PROGRAM_MODE_ASSISTED = 'ASSISTED'
- PROGRAM_MODE_NATIVE_SEND = 'NATIVE_SEND'
- REQUESTED_COVERAGE_AUTO = 'AUTO'
- REQUESTED_COVERAGE_CONTROLLED = 'CONTROLLED'
- REQUESTED_COVERAGE_CORE = 'CORE'
- REQUESTED_COVERAGE_EXPANDED = 'EXPANDED'
- RESOLVED_COVERAGE_AUTO = 'AUTO'
- RESOLVED_COVERAGE_CONTROLLED = 'CONTROLLED'
- RESOLVED_COVERAGE_CORE = 'CORE'
- RESOLVED_COVERAGE_EXPANDED = 'EXPANDED'
- SCHEDULE_PRESET_CUSTOM = 'CUSTOM'
- SCHEDULE_PRESET_GENTLE = 'GENTLE'
- SCHEDULE_PRESET_REPAIR = 'REPAIR'
- SCHEDULE_PRESET_STANDARD = 'STANDARD'
- STATUS_ACTIVE = 'ACTIVE'
- STATUS_COMPLETED = 'COMPLETED'
- STATUS_DRAFT = 'DRAFT'
- STATUS_ESTABLISHING_BASELINE = 'ESTABLISHING_BASELINE'
- STATUS_MONITORING = 'MONITORING'
- STATUS_PAUSED_BILLING = 'PAUSED_BILLING'
- STATUS_PAUSED_CAPACITY = 'PAUSED_CAPACITY'
- STATUS_PAUSED_CONNECTION = 'PAUSED_CONNECTION'
- STATUS_PAUSED_CUSTOMER = 'PAUSED_CUSTOMER'
- STATUS_PAUSED_SAFETY = 'PAUSED_SAFETY'
- STATUS_READY = 'READY'
- STATUS_STOPPED = 'STOPPED'
- STATUS_VERIFYING = 'VERIFYING'
- $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
- getAttestationPolicyVersion() : string
- Gets attestation_policy_version
- getBaselineSource() : string
- Gets baseline_source
- getBaselineSourceAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getBaselineTestId() : string|null
- Gets baseline_test_id
- getBlockers() : array<string|int, string>
- Gets blockers
- getBlockersAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getCompletedAt() : DateTime|null
- Gets completed_at
- getCompletionCode() : string|null
- Gets completion_code
- getConnectionId() : string
- Gets connection_id
- getContent() : EmailWarmupContentOptions
- Gets content
- getContentHash() : string
- Gets content_hash
- getContentPolicyVersion() : string
- Gets content_policy_version
- getContentSource() : string
- Gets content_source
- getContentSourceAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getCreatedAt() : DateTime
- Gets created_at
- getCurrentDailyVolume() : int
- Gets current_daily_volume
- getCustomerIntent() : string
- Gets customer_intent
- getCustomerIntentAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getExecutionPolicy() : string
- Gets execution_policy
- getExecutionPolicyAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getGoalDailyVolume() : int
- Gets goal_daily_volume
- getId() : string
- Gets id
- getMaintenanceDailyVolume() : int
- Gets maintenance_daily_volume
- getMaintenanceEnabled() : bool
- Gets maintenance_enabled
- getModelName() : string
- The original name of the model.
- getName() : string
- Gets name
- getNextActionAt() : DateTime|null
- Gets next_action_at
- getPermissionBasedSendingAttestedAt() : DateTime
- Gets permission_based_sending_attested_at
- getPolicyVersion() : string
- Gets policy_version
- getProgramMode() : string
- Gets program_mode
- getProgramModeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getRampDurationDays() : int
- Gets ramp_duration_days
- getRecipientPolicyVersion() : string
- Gets recipient_policy_version
- getRequestedCoverage() : string
- Gets requested_coverage
- getRequestedCoverageAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getResolvedCoverage() : string
- Gets resolved_coverage
- getResolvedCoverageAllowableValues() : 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
- getSenderEmail() : string
- Gets sender_email
- getSenderOwnershipAttestedAt() : DateTime
- Gets sender_ownership_attested_at
- getSendWindowEnd() : string
- Gets send_window_end
- getSendWindowStart() : string
- Gets send_window_start
- getStartedAt() : DateTime|null
- Gets started_at
- getStatus() : string
- Gets status
- getStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTimeZone() : string
- Gets time_zone
- getUpdatedAt() : DateTime
- Gets updated_at
- getVersion() : int
- Gets version
- 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
- setAttestationPolicyVersion() : self
- Sets attestation_policy_version
- setBaselineSource() : self
- Sets baseline_source
- setBaselineTestId() : self
- Sets baseline_test_id
- setBlockers() : self
- Sets blockers
- setCompletedAt() : self
- Sets completed_at
- setCompletionCode() : self
- Sets completion_code
- setConnectionId() : self
- Sets connection_id
- setContent() : self
- Sets content
- setContentHash() : self
- Sets content_hash
- setContentPolicyVersion() : self
- Sets content_policy_version
- setContentSource() : self
- Sets content_source
- setCreatedAt() : self
- Sets created_at
- setCurrentDailyVolume() : self
- Sets current_daily_volume
- setCustomerIntent() : self
- Sets customer_intent
- setExecutionPolicy() : self
- Sets execution_policy
- setGoalDailyVolume() : self
- Sets goal_daily_volume
- setId() : self
- Sets id
- setMaintenanceDailyVolume() : self
- Sets maintenance_daily_volume
- setMaintenanceEnabled() : self
- Sets maintenance_enabled
- setName() : self
- Sets name
- setNextActionAt() : self
- Sets next_action_at
- setPermissionBasedSendingAttestedAt() : self
- Sets permission_based_sending_attested_at
- setPolicyVersion() : self
- Sets policy_version
- setProgramMode() : self
- Sets program_mode
- setRampDurationDays() : self
- Sets ramp_duration_days
- setRecipientPolicyVersion() : self
- Sets recipient_policy_version
- setRequestedCoverage() : self
- Sets requested_coverage
- setResolvedCoverage() : self
- Sets resolved_coverage
- setSchedulePreset() : self
- Sets schedule_preset
- setSenderEmail() : self
- Sets sender_email
- setSenderOwnershipAttestedAt() : self
- Sets sender_ownership_attested_at
- setSendWindowEnd() : self
- Sets send_window_end
- setSendWindowStart() : self
- Sets send_window_start
- setStartedAt() : self
- Sets started_at
- setStatus() : self
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTimeZone() : self
- Sets time_zone
- setUpdatedAt() : self
- Sets updated_at
- setVersion() : self
- Sets version
- 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
BASELINE_SOURCE_NONE
public
mixed
BASELINE_SOURCE_NONE
= 'NONE'
BASELINE_SOURCE_PROGRAM_CHECKPOINT
public
mixed
BASELINE_SOURCE_PROGRAM_CHECKPOINT
= 'PROGRAM_CHECKPOINT'
BASELINE_SOURCE_SUPPLIED
public
mixed
BASELINE_SOURCE_SUPPLIED
= 'SUPPLIED'
BLOCKERS_API_DISABLED
public
mixed
BLOCKERS_API_DISABLED
= 'API_DISABLED'
BLOCKERS_BILLING_NOT_READY
public
mixed
BLOCKERS_BILLING_NOT_READY
= 'BILLING_NOT_READY'
BLOCKERS_CHECKPOINTS_DISABLED
public
mixed
BLOCKERS_CHECKPOINTS_DISABLED
= 'CHECKPOINTS_DISABLED'
BLOCKERS_CONNECTION_NOT_VERIFIED
public
mixed
BLOCKERS_CONNECTION_NOT_VERIFIED
= 'CONNECTION_NOT_VERIFIED'
BLOCKERS_CONNECTION_VERIFICATION_STALE
public
mixed
BLOCKERS_CONNECTION_VERIFICATION_STALE
= 'CONNECTION_VERIFICATION_STALE'
BLOCKERS_CONTROLLED_MX_UNAVAILABLE
public
mixed
BLOCKERS_CONTROLLED_MX_UNAVAILABLE
= 'CONTROLLED_MX_UNAVAILABLE'
BLOCKERS_EXECUTION_DISABLED
public
mixed
BLOCKERS_EXECUTION_DISABLED
= 'EXECUTION_DISABLED'
BLOCKERS_PREMIUM_COVERAGE_REQUIRED
public
mixed
BLOCKERS_PREMIUM_COVERAGE_REQUIRED
= 'PREMIUM_COVERAGE_REQUIRED'
BLOCKERS_PROVIDER_DISABLED
public
mixed
BLOCKERS_PROVIDER_DISABLED
= 'PROVIDER_DISABLED'
BLOCKERS_SENDER_IDENTITY_CHANGED
public
mixed
BLOCKERS_SENDER_IDENTITY_CHANGED
= 'SENDER_IDENTITY_CHANGED'
CONTENT_SOURCE_AI_ASSISTED_TEMPLATE
public
mixed
CONTENT_SOURCE_AI_ASSISTED_TEMPLATE
= 'AI_ASSISTED_TEMPLATE'
CONTENT_SOURCE_CUSTOM_TEMPLATE
public
mixed
CONTENT_SOURCE_CUSTOM_TEMPLATE
= 'CUSTOM_TEMPLATE'
CONTENT_SOURCE_MANAGED_CONTROL
public
mixed
CONTENT_SOURCE_MANAGED_CONTROL
= 'MANAGED_CONTROL'
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
EXECUTION_POLICY_ASSISTED_CAMPAIGN_RAMP
public
mixed
EXECUTION_POLICY_ASSISTED_CAMPAIGN_RAMP
= 'ASSISTED_CAMPAIGN_RAMP'
EXECUTION_POLICY_HIGH_VOLUME_INFRASTRUCTURE_RAMP
public
mixed
EXECUTION_POLICY_HIGH_VOLUME_INFRASTRUCTURE_RAMP
= 'HIGH_VOLUME_INFRASTRUCTURE_RAMP'
EXECUTION_POLICY_LOW_VOLUME_MAILBOX_RAMP
public
mixed
EXECUTION_POLICY_LOW_VOLUME_MAILBOX_RAMP
= 'LOW_VOLUME_MAILBOX_RAMP'
PROGRAM_MODE_ASSISTED
public
mixed
PROGRAM_MODE_ASSISTED
= 'ASSISTED'
PROGRAM_MODE_NATIVE_SEND
public
mixed
PROGRAM_MODE_NATIVE_SEND
= 'NATIVE_SEND'
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'
RESOLVED_COVERAGE_AUTO
public
mixed
RESOLVED_COVERAGE_AUTO
= 'AUTO'
RESOLVED_COVERAGE_CONTROLLED
public
mixed
RESOLVED_COVERAGE_CONTROLLED
= 'CONTROLLED'
RESOLVED_COVERAGE_CORE
public
mixed
RESOLVED_COVERAGE_CORE
= 'CORE'
RESOLVED_COVERAGE_EXPANDED
public
mixed
RESOLVED_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'
STATUS_ACTIVE
public
mixed
STATUS_ACTIVE
= 'ACTIVE'
STATUS_COMPLETED
public
mixed
STATUS_COMPLETED
= 'COMPLETED'
STATUS_DRAFT
public
mixed
STATUS_DRAFT
= 'DRAFT'
STATUS_ESTABLISHING_BASELINE
public
mixed
STATUS_ESTABLISHING_BASELINE
= 'ESTABLISHING_BASELINE'
STATUS_MONITORING
public
mixed
STATUS_MONITORING
= 'MONITORING'
STATUS_PAUSED_BILLING
public
mixed
STATUS_PAUSED_BILLING
= 'PAUSED_BILLING'
STATUS_PAUSED_CAPACITY
public
mixed
STATUS_PAUSED_CAPACITY
= 'PAUSED_CAPACITY'
STATUS_PAUSED_CONNECTION
public
mixed
STATUS_PAUSED_CONNECTION
= 'PAUSED_CONNECTION'
STATUS_PAUSED_CUSTOMER
public
mixed
STATUS_PAUSED_CUSTOMER
= 'PAUSED_CUSTOMER'
STATUS_PAUSED_SAFETY
public
mixed
STATUS_PAUSED_SAFETY
= 'PAUSED_SAFETY'
STATUS_READY
public
mixed
STATUS_READY
= 'READY'
STATUS_STOPPED
public
mixed
STATUS_STOPPED
= 'STOPPED'
STATUS_VERIFYING
public
mixed
STATUS_VERIFYING
= 'VERIFYING'
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
= ['id' => 'id', 'connection_id' => 'connectionId', 'sender_email' => 'senderEmail', 'name' => 'name', 'customer_intent' => 'customerIntent', 'execution_policy' => 'executionPolicy', 'program_mode' => 'programMode', 'status' => 'status', 'blockers' => 'blockers', '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', 'resolved_coverage' => 'resolvedCoverage', 'baseline_test_id' => 'baselineTestId', 'baseline_source' => 'baselineSource', 'content_source' => 'contentSource', 'content' => 'content', 'content_hash' => 'contentHash', 'sender_ownership_attested_at' => 'senderOwnershipAttestedAt', 'permission_based_sending_attested_at' => 'permissionBasedSendingAttestedAt', 'attestation_policy_version' => 'attestationPolicyVersion', 'policy_version' => 'policyVersion', 'content_policy_version' => 'contentPolicyVersion', 'recipient_policy_version' => 'recipientPolicyVersion', 'next_action_at' => 'nextActionAt', 'started_at' => 'startedAt', 'completed_at' => 'completedAt', 'completion_code' => 'completionCode', 'version' => 'version', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt']
$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
= ['id' => 'getId', 'connection_id' => 'getConnectionId', 'sender_email' => 'getSenderEmail', 'name' => 'getName', 'customer_intent' => 'getCustomerIntent', 'execution_policy' => 'getExecutionPolicy', 'program_mode' => 'getProgramMode', 'status' => 'getStatus', 'blockers' => 'getBlockers', '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', 'resolved_coverage' => 'getResolvedCoverage', 'baseline_test_id' => 'getBaselineTestId', 'baseline_source' => 'getBaselineSource', 'content_source' => 'getContentSource', 'content' => 'getContent', 'content_hash' => 'getContentHash', 'sender_ownership_attested_at' => 'getSenderOwnershipAttestedAt', 'permission_based_sending_attested_at' => 'getPermissionBasedSendingAttestedAt', 'attestation_policy_version' => 'getAttestationPolicyVersion', 'policy_version' => 'getPolicyVersion', 'content_policy_version' => 'getContentPolicyVersion', 'recipient_policy_version' => 'getRecipientPolicyVersion', 'next_action_at' => 'getNextActionAt', 'started_at' => 'getStartedAt', 'completed_at' => 'getCompletedAt', 'completion_code' => 'getCompletionCode', 'version' => 'getVersion', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'connection_id' => 'uuid', 'sender_email' => null, 'name' => null, 'customer_intent' => null, 'execution_policy' => null, 'program_mode' => null, 'status' => null, 'blockers' => 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, 'resolved_coverage' => null, 'baseline_test_id' => 'uuid', 'baseline_source' => null, 'content_source' => null, 'content' => null, 'content_hash' => null, 'sender_ownership_attested_at' => 'date-time', 'permission_based_sending_attested_at' => 'date-time', 'attestation_policy_version' => null, 'policy_version' => null, 'content_policy_version' => null, 'recipient_policy_version' => null, 'next_action_at' => 'date-time', 'started_at' => 'date-time', 'completed_at' => 'date-time', 'completion_code' => null, 'version' => 'int64', 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'EmailWarmupProgramDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'connection_id' => false, 'sender_email' => false, 'name' => false, 'customer_intent' => false, 'execution_policy' => false, 'program_mode' => false, 'status' => false, 'blockers' => 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, 'resolved_coverage' => false, 'baseline_test_id' => true, 'baseline_source' => false, 'content_source' => false, 'content' => false, 'content_hash' => false, 'sender_ownership_attested_at' => false, 'permission_based_sending_attested_at' => false, 'attestation_policy_version' => false, 'policy_version' => false, 'content_policy_version' => false, 'recipient_policy_version' => false, 'next_action_at' => true, 'started_at' => true, 'completed_at' => true, 'completion_code' => true, 'version' => false, 'created_at' => false, 'updated_at' => 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
= ['id' => 'string', 'connection_id' => 'string', 'sender_email' => 'string', 'name' => 'string', 'customer_intent' => 'string', 'execution_policy' => 'string', 'program_mode' => 'string', 'status' => 'string', 'blockers' => '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', 'resolved_coverage' => 'string', 'baseline_test_id' => 'string', 'baseline_source' => 'string', 'content_source' => 'string', 'content' => '\\MailSlurp\\Models\\EmailWarmupContentOptions', 'content_hash' => 'string', 'sender_ownership_attested_at' => '\\DateTime', 'permission_based_sending_attested_at' => '\\DateTime', 'attestation_policy_version' => 'string', 'policy_version' => 'string', 'content_policy_version' => 'string', 'recipient_policy_version' => 'string', 'next_action_at' => '\\DateTime', 'started_at' => '\\DateTime', 'completed_at' => '\\DateTime', 'completion_code' => 'string', 'version' => 'int', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'connection_id' => 'setConnectionId', 'sender_email' => 'setSenderEmail', 'name' => 'setName', 'customer_intent' => 'setCustomerIntent', 'execution_policy' => 'setExecutionPolicy', 'program_mode' => 'setProgramMode', 'status' => 'setStatus', 'blockers' => 'setBlockers', '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', 'resolved_coverage' => 'setResolvedCoverage', 'baseline_test_id' => 'setBaselineTestId', 'baseline_source' => 'setBaselineSource', 'content_source' => 'setContentSource', 'content' => 'setContent', 'content_hash' => 'setContentHash', 'sender_ownership_attested_at' => 'setSenderOwnershipAttestedAt', 'permission_based_sending_attested_at' => 'setPermissionBasedSendingAttestedAt', 'attestation_policy_version' => 'setAttestationPolicyVersion', 'policy_version' => 'setPolicyVersion', 'content_policy_version' => 'setContentPolicyVersion', 'recipient_policy_version' => 'setRecipientPolicyVersion', 'next_action_at' => 'setNextActionAt', 'started_at' => 'setStartedAt', 'completed_at' => 'setCompletedAt', 'completion_code' => 'setCompletionCode', 'version' => 'setVersion', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt']
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> —getAttestationPolicyVersion()
Gets attestation_policy_version
public
getAttestationPolicyVersion() : string
Return values
string —getBaselineSource()
Gets baseline_source
public
getBaselineSource() : string
Return values
string —getBaselineSourceAllowableValues()
Gets allowable values of the enum
public
getBaselineSourceAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getBaselineTestId()
Gets baseline_test_id
public
getBaselineTestId() : string|null
Return values
string|null —getBlockers()
Gets blockers
public
getBlockers() : array<string|int, string>
Return values
array<string|int, string> —getBlockersAllowableValues()
Gets allowable values of the enum
public
getBlockersAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getCompletedAt()
Gets completed_at
public
getCompletedAt() : DateTime|null
Return values
DateTime|null —getCompletionCode()
Gets completion_code
public
getCompletionCode() : 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 —getContentHash()
Gets content_hash
public
getContentHash() : string
Return values
string —getContentPolicyVersion()
Gets content_policy_version
public
getContentPolicyVersion() : string
Return values
string —getContentSource()
Gets content_source
public
getContentSource() : string
Return values
string —getContentSourceAllowableValues()
Gets allowable values of the enum
public
getContentSourceAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —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> —getExecutionPolicy()
Gets execution_policy
public
getExecutionPolicy() : string
Return values
string —getExecutionPolicyAllowableValues()
Gets allowable values of the enum
public
getExecutionPolicyAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getGoalDailyVolume()
Gets goal_daily_volume
public
getGoalDailyVolume() : int
Return values
int —getId()
Gets id
public
getId() : string
Return values
string —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 —getNextActionAt()
Gets next_action_at
public
getNextActionAt() : DateTime|null
Return values
DateTime|null —getPermissionBasedSendingAttestedAt()
Gets permission_based_sending_attested_at
public
getPermissionBasedSendingAttestedAt() : DateTime
Return values
DateTime —getPolicyVersion()
Gets policy_version
public
getPolicyVersion() : string
Return values
string —getProgramMode()
Gets program_mode
public
getProgramMode() : string
Return values
string —getProgramModeAllowableValues()
Gets allowable values of the enum
public
getProgramModeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getRampDurationDays()
Gets ramp_duration_days
public
getRampDurationDays() : int
Return values
int —getRecipientPolicyVersion()
Gets recipient_policy_version
public
getRecipientPolicyVersion() : string
Return values
string —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> —getResolvedCoverage()
Gets resolved_coverage
public
getResolvedCoverage() : string
Return values
string —getResolvedCoverageAllowableValues()
Gets allowable values of the enum
public
getResolvedCoverageAllowableValues() : 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> —getSenderEmail()
Gets sender_email
public
getSenderEmail() : string
Return values
string —getSenderOwnershipAttestedAt()
Gets sender_ownership_attested_at
public
getSenderOwnershipAttestedAt() : DateTime
Return values
DateTime —getSendWindowEnd()
Gets send_window_end
public
getSendWindowEnd() : string
Return values
string —getSendWindowStart()
Gets send_window_start
public
getSendWindowStart() : string
Return values
string —getStartedAt()
Gets started_at
public
getStartedAt() : DateTime|null
Return values
DateTime|null —getStatus()
Gets status
public
getStatus() : string
Return values
string —getStatusAllowableValues()
Gets allowable values of the enum
public
getStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, 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 —getUpdatedAt()
Gets updated_at
public
getUpdatedAt() : DateTime
Return values
DateTime —getVersion()
Gets version
public
getVersion() : 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> —setAttestationPolicyVersion()
Sets attestation_policy_version
public
setAttestationPolicyVersion(string $attestation_policy_version) : self
Parameters
- $attestation_policy_version : string
-
attestation_policy_version
Return values
self —setBaselineSource()
Sets baseline_source
public
setBaselineSource(string $baseline_source) : self
Parameters
- $baseline_source : string
-
baseline_source
Return values
self —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 —setBlockers()
Sets blockers
public
setBlockers(array<string|int, string> $blockers) : self
Parameters
- $blockers : array<string|int, string>
-
blockers
Return values
self —setCompletedAt()
Sets completed_at
public
setCompletedAt(DateTime|null $completed_at) : self
Parameters
- $completed_at : DateTime|null
-
completed_at
Return values
self —setCompletionCode()
Sets completion_code
public
setCompletionCode(string|null $completion_code) : self
Parameters
- $completion_code : string|null
-
completion_code
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 —setContentHash()
Sets content_hash
public
setContentHash(string $content_hash) : self
Parameters
- $content_hash : string
-
content_hash
Return values
self —setContentPolicyVersion()
Sets content_policy_version
public
setContentPolicyVersion(string $content_policy_version) : self
Parameters
- $content_policy_version : string
-
content_policy_version
Return values
self —setContentSource()
Sets content_source
public
setContentSource(string $content_source) : self
Parameters
- $content_source : string
-
content_source
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
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 —setExecutionPolicy()
Sets execution_policy
public
setExecutionPolicy(string $execution_policy) : self
Parameters
- $execution_policy : string
-
execution_policy
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 —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
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 —setNextActionAt()
Sets next_action_at
public
setNextActionAt(DateTime|null $next_action_at) : self
Parameters
- $next_action_at : DateTime|null
-
next_action_at
Return values
self —setPermissionBasedSendingAttestedAt()
Sets permission_based_sending_attested_at
public
setPermissionBasedSendingAttestedAt(DateTime $permission_based_sending_attested_at) : self
Parameters
- $permission_based_sending_attested_at : DateTime
-
permission_based_sending_attested_at
Return values
self —setPolicyVersion()
Sets policy_version
public
setPolicyVersion(string $policy_version) : self
Parameters
- $policy_version : string
-
policy_version
Return values
self —setProgramMode()
Sets program_mode
public
setProgramMode(string $program_mode) : self
Parameters
- $program_mode : string
-
program_mode
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 —setRecipientPolicyVersion()
Sets recipient_policy_version
public
setRecipientPolicyVersion(string $recipient_policy_version) : self
Parameters
- $recipient_policy_version : string
-
recipient_policy_version
Return values
self —setRequestedCoverage()
Sets requested_coverage
public
setRequestedCoverage(string $requested_coverage) : self
Parameters
- $requested_coverage : string
-
requested_coverage
Return values
self —setResolvedCoverage()
Sets resolved_coverage
public
setResolvedCoverage(string $resolved_coverage) : self
Parameters
- $resolved_coverage : string
-
resolved_coverage
Return values
self —setSchedulePreset()
Sets schedule_preset
public
setSchedulePreset(string $schedule_preset) : self
Parameters
- $schedule_preset : string
-
schedule_preset
Return values
self —setSenderEmail()
Sets sender_email
public
setSenderEmail(string $sender_email) : self
Parameters
- $sender_email : string
-
sender_email
Return values
self —setSenderOwnershipAttestedAt()
Sets sender_ownership_attested_at
public
setSenderOwnershipAttestedAt(DateTime $sender_ownership_attested_at) : self
Parameters
- $sender_ownership_attested_at : DateTime
-
sender_ownership_attested_at
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 —setStartedAt()
Sets started_at
public
setStartedAt(DateTime|null $started_at) : self
Parameters
- $started_at : DateTime|null
-
started_at
Return values
self —setStatus()
Sets status
public
setStatus(string $status) : self
Parameters
- $status : string
-
status
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 —setUpdatedAt()
Sets updated_at
public
setUpdatedAt(DateTime $updated_at) : self
Parameters
- $updated_at : DateTime
-
updated_at
Return values
self —setVersion()
Sets version
public
setVersion(int $version) : self
Parameters
- $version : int
-
version
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>