DeliverabilitySimulationJobDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
DeliverabilitySimulationJobDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- SCOPE_INBOX = 'INBOX'
- SCOPE_PHONE = 'PHONE'
- STATUS_CANCELLED = 'CANCELLED'
- STATUS_COMPLETED = 'COMPLETED'
- STATUS_FAILED = 'FAILED'
- STATUS_PAUSED = 'PAUSED'
- STATUS_RUNNING = 'RUNNING'
- $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
- getActiveTargetLabel() : string|null
- Gets active_target_label
- getCompletedAt() : DateTime|null
- Gets completed_at
- getConfigSnapshot() : DeliverabilitySimulationJobConfigDto
- Gets config_snapshot
- getCreatedAt() : DateTime
- Gets created_at
- getErrorSummary() : DeliverabilitySimulationJobErrorSummaryDto
- Gets error_summary
- getEstimatedRemainingMs() : int|null
- Gets estimated_remaining_ms
- getFailureCount() : int
- Gets failure_count
- getId() : string
- Gets id
- getModelName() : string
- The original name of the model.
- getNextSendIndex() : int
- Gets next_send_index
- getProgressPercent() : float
- Gets progress_percent
- getScope() : string
- Gets scope
- getScopeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getSentCount() : int
- Gets sent_count
- getStartedAt() : DateTime|null
- Gets started_at
- getStatus() : string
- Gets status
- getStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getSuccessCount() : int
- Gets success_count
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTestId() : string
- Gets test_id
- getTotalPlannedSends() : int
- Gets total_planned_sends
- getTotalTargets() : int
- Gets total_targets
- getUpdatedAt() : DateTime
- Gets updated_at
- 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
- setActiveTargetLabel() : self
- Sets active_target_label
- setCompletedAt() : self
- Sets completed_at
- setConfigSnapshot() : self
- Sets config_snapshot
- setCreatedAt() : self
- Sets created_at
- setErrorSummary() : self
- Sets error_summary
- setEstimatedRemainingMs() : self
- Sets estimated_remaining_ms
- setFailureCount() : self
- Sets failure_count
- setId() : self
- Sets id
- setNextSendIndex() : self
- Sets next_send_index
- setProgressPercent() : self
- Sets progress_percent
- setScope() : self
- Sets scope
- setSentCount() : self
- Sets sent_count
- setStartedAt() : self
- Sets started_at
- setStatus() : self
- Sets status
- setSuccessCount() : self
- Sets success_count
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTestId() : self
- Sets test_id
- setTotalPlannedSends() : self
- Sets total_planned_sends
- setTotalTargets() : self
- Sets total_targets
- setUpdatedAt() : self
- Sets updated_at
- 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
SCOPE_INBOX
public
mixed
SCOPE_INBOX
= 'INBOX'
SCOPE_PHONE
public
mixed
SCOPE_PHONE
= 'PHONE'
STATUS_CANCELLED
public
mixed
STATUS_CANCELLED
= 'CANCELLED'
STATUS_COMPLETED
public
mixed
STATUS_COMPLETED
= 'COMPLETED'
STATUS_FAILED
public
mixed
STATUS_FAILED
= 'FAILED'
STATUS_PAUSED
public
mixed
STATUS_PAUSED
= 'PAUSED'
STATUS_RUNNING
public
mixed
STATUS_RUNNING
= 'RUNNING'
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', 'test_id' => 'testId', 'scope' => 'scope', 'status' => 'status', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt', 'started_at' => 'startedAt', 'completed_at' => 'completedAt', 'total_targets' => 'totalTargets', 'total_planned_sends' => 'totalPlannedSends', 'next_send_index' => 'nextSendIndex', 'sent_count' => 'sentCount', 'success_count' => 'successCount', 'failure_count' => 'failureCount', 'progress_percent' => 'progressPercent', 'active_target_label' => 'activeTargetLabel', 'estimated_remaining_ms' => 'estimatedRemainingMs', 'config_snapshot' => 'configSnapshot', 'error_summary' => 'errorSummary']
$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', 'test_id' => 'getTestId', 'scope' => 'getScope', 'status' => 'getStatus', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt', 'started_at' => 'getStartedAt', 'completed_at' => 'getCompletedAt', 'total_targets' => 'getTotalTargets', 'total_planned_sends' => 'getTotalPlannedSends', 'next_send_index' => 'getNextSendIndex', 'sent_count' => 'getSentCount', 'success_count' => 'getSuccessCount', 'failure_count' => 'getFailureCount', 'progress_percent' => 'getProgressPercent', 'active_target_label' => 'getActiveTargetLabel', 'estimated_remaining_ms' => 'getEstimatedRemainingMs', 'config_snapshot' => 'getConfigSnapshot', 'error_summary' => 'getErrorSummary']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'test_id' => 'uuid', 'scope' => null, 'status' => null, 'created_at' => 'date-time', 'updated_at' => 'date-time', 'started_at' => 'date-time', 'completed_at' => 'date-time', 'total_targets' => 'int64', 'total_planned_sends' => 'int64', 'next_send_index' => 'int64', 'sent_count' => 'int64', 'success_count' => 'int64', 'failure_count' => 'int64', 'progress_percent' => 'double', 'active_target_label' => null, 'estimated_remaining_ms' => 'int64', 'config_snapshot' => null, 'error_summary' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'DeliverabilitySimulationJobDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'test_id' => false, 'scope' => false, 'status' => false, 'created_at' => false, 'updated_at' => false, 'started_at' => true, 'completed_at' => true, 'total_targets' => false, 'total_planned_sends' => false, 'next_send_index' => false, 'sent_count' => false, 'success_count' => false, 'failure_count' => false, 'progress_percent' => false, 'active_target_label' => true, 'estimated_remaining_ms' => true, 'config_snapshot' => false, 'error_summary' => 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', 'test_id' => 'string', 'scope' => 'string', 'status' => 'string', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime', 'started_at' => '\\DateTime', 'completed_at' => '\\DateTime', 'total_targets' => 'int', 'total_planned_sends' => 'int', 'next_send_index' => 'int', 'sent_count' => 'int', 'success_count' => 'int', 'failure_count' => 'int', 'progress_percent' => 'float', 'active_target_label' => 'string', 'estimated_remaining_ms' => 'int', 'config_snapshot' => '\\MailSlurp\\Models\\DeliverabilitySimulationJobConfigDto', 'error_summary' => '\\MailSlurp\\Models\\DeliverabilitySimulationJobErrorSummaryDto']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'test_id' => 'setTestId', 'scope' => 'setScope', 'status' => 'setStatus', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt', 'started_at' => 'setStartedAt', 'completed_at' => 'setCompletedAt', 'total_targets' => 'setTotalTargets', 'total_planned_sends' => 'setTotalPlannedSends', 'next_send_index' => 'setNextSendIndex', 'sent_count' => 'setSentCount', 'success_count' => 'setSuccessCount', 'failure_count' => 'setFailureCount', 'progress_percent' => 'setProgressPercent', 'active_target_label' => 'setActiveTargetLabel', 'estimated_remaining_ms' => 'setEstimatedRemainingMs', 'config_snapshot' => 'setConfigSnapshot', 'error_summary' => 'setErrorSummary']
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> —getActiveTargetLabel()
Gets active_target_label
public
getActiveTargetLabel() : string|null
Return values
string|null —getCompletedAt()
Gets completed_at
public
getCompletedAt() : DateTime|null
Return values
DateTime|null —getConfigSnapshot()
Gets config_snapshot
public
getConfigSnapshot() : DeliverabilitySimulationJobConfigDto
Return values
DeliverabilitySimulationJobConfigDto —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getErrorSummary()
Gets error_summary
public
getErrorSummary() : DeliverabilitySimulationJobErrorSummaryDto
Return values
DeliverabilitySimulationJobErrorSummaryDto —getEstimatedRemainingMs()
Gets estimated_remaining_ms
public
getEstimatedRemainingMs() : int|null
Return values
int|null —getFailureCount()
Gets failure_count
public
getFailureCount() : int
Return values
int —getId()
Gets id
public
getId() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getNextSendIndex()
Gets next_send_index
public
getNextSendIndex() : int
Return values
int —getProgressPercent()
Gets progress_percent
public
getProgressPercent() : float
Return values
float —getScope()
Gets scope
public
getScope() : string
Return values
string —getScopeAllowableValues()
Gets allowable values of the enum
public
getScopeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getSentCount()
Gets sent_count
public
getSentCount() : int
Return values
int —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> —getSuccessCount()
Gets success_count
public
getSuccessCount() : 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> —getTestId()
Gets test_id
public
getTestId() : string
Return values
string —getTotalPlannedSends()
Gets total_planned_sends
public
getTotalPlannedSends() : int
Return values
int —getTotalTargets()
Gets total_targets
public
getTotalTargets() : int
Return values
int —getUpdatedAt()
Gets updated_at
public
getUpdatedAt() : DateTime
Return values
DateTime —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> —setActiveTargetLabel()
Sets active_target_label
public
setActiveTargetLabel(string|null $active_target_label) : self
Parameters
- $active_target_label : string|null
-
active_target_label
Return values
self —setCompletedAt()
Sets completed_at
public
setCompletedAt(DateTime|null $completed_at) : self
Parameters
- $completed_at : DateTime|null
-
completed_at
Return values
self —setConfigSnapshot()
Sets config_snapshot
public
setConfigSnapshot(DeliverabilitySimulationJobConfigDto $config_snapshot) : self
Parameters
- $config_snapshot : DeliverabilitySimulationJobConfigDto
-
config_snapshot
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setErrorSummary()
Sets error_summary
public
setErrorSummary(DeliverabilitySimulationJobErrorSummaryDto $error_summary) : self
Parameters
- $error_summary : DeliverabilitySimulationJobErrorSummaryDto
-
error_summary
Return values
self —setEstimatedRemainingMs()
Sets estimated_remaining_ms
public
setEstimatedRemainingMs(int|null $estimated_remaining_ms) : self
Parameters
- $estimated_remaining_ms : int|null
-
estimated_remaining_ms
Return values
self —setFailureCount()
Sets failure_count
public
setFailureCount(int $failure_count) : self
Parameters
- $failure_count : int
-
failure_count
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setNextSendIndex()
Sets next_send_index
public
setNextSendIndex(int $next_send_index) : self
Parameters
- $next_send_index : int
-
next_send_index
Return values
self —setProgressPercent()
Sets progress_percent
public
setProgressPercent(float $progress_percent) : self
Parameters
- $progress_percent : float
-
progress_percent
Return values
self —setScope()
Sets scope
public
setScope(string $scope) : self
Parameters
- $scope : string
-
scope
Return values
self —setSentCount()
Sets sent_count
public
setSentCount(int $sent_count) : self
Parameters
- $sent_count : int
-
sent_count
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 —setSuccessCount()
Sets success_count
public
setSuccessCount(int $success_count) : self
Parameters
- $success_count : int
-
success_count
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> —setTestId()
Sets test_id
public
setTestId(string $test_id) : self
Parameters
- $test_id : string
-
test_id
Return values
self —setTotalPlannedSends()
Sets total_planned_sends
public
setTotalPlannedSends(int $total_planned_sends) : self
Parameters
- $total_planned_sends : int
-
total_planned_sends
Return values
self —setTotalTargets()
Sets total_targets
public
setTotalTargets(int $total_targets) : self
Parameters
- $total_targets : int
-
total_targets
Return values
self —setUpdatedAt()
Sets updated_at
public
setUpdatedAt(DateTime $updated_at) : self
Parameters
- $updated_at : DateTime
-
updated_at
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>