AutomatedInboxPlacementExecutionDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
AutomatedInboxPlacementExecutionDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- STATUS_COMPLETE = 'COMPLETE'
- STATUS_FAILED = 'FAILED'
- STATUS_PARTIAL = 'PARTIAL'
- STATUS_PREPARING = 'PREPARING'
- STATUS_SENDING = 'SENDING'
- STATUS_SENT_PENDING_CONFIRMATION = 'SENT_PENDING_CONFIRMATION'
- STATUS_UNCERTAIN = 'UNCERTAIN'
- TRIGGER_SOURCE_API = 'API'
- TRIGGER_SOURCE_SCHEDULE = 'SCHEDULE'
- $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
- getAttemptCount() : int
- Gets attempt_count
- getConnectionId() : string
- Gets connection_id
- getCreatedAt() : DateTime
- Gets created_at
- getFailureCode() : string|null
- Gets failure_code
- getFailureMessage() : string|null
- Gets failure_message
- getFinishedAt() : DateTime|null
- Gets finished_at
- getId() : string
- Gets id
- getInboxPlacementRunId() : string|null
- Gets inbox_placement_run_id
- getModelName() : string
- The original name of the model.
- getScheduledFor() : DateTime
- Gets scheduled_for
- getScheduleId() : string
- Gets schedule_id
- 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
- getTargetCount() : int
- Gets target_count
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTriggerSource() : string
- Gets trigger_source
- getTriggerSourceAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- 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
- setAttemptCount() : self
- Sets attempt_count
- setConnectionId() : self
- Sets connection_id
- setCreatedAt() : self
- Sets created_at
- setFailureCode() : self
- Sets failure_code
- setFailureMessage() : self
- Sets failure_message
- setFinishedAt() : self
- Sets finished_at
- setId() : self
- Sets id
- setInboxPlacementRunId() : self
- Sets inbox_placement_run_id
- setScheduledFor() : self
- Sets scheduled_for
- setScheduleId() : self
- Sets schedule_id
- setSentCount() : self
- Sets sent_count
- setStartedAt() : self
- Sets started_at
- setStatus() : self
- Sets status
- setTargetCount() : self
- Sets target_count
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTriggerSource() : self
- Sets trigger_source
- 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
STATUS_COMPLETE
public
mixed
STATUS_COMPLETE
= 'COMPLETE'
STATUS_FAILED
public
mixed
STATUS_FAILED
= 'FAILED'
STATUS_PARTIAL
public
mixed
STATUS_PARTIAL
= 'PARTIAL'
STATUS_PREPARING
public
mixed
STATUS_PREPARING
= 'PREPARING'
STATUS_SENDING
public
mixed
STATUS_SENDING
= 'SENDING'
STATUS_SENT_PENDING_CONFIRMATION
public
mixed
STATUS_SENT_PENDING_CONFIRMATION
= 'SENT_PENDING_CONFIRMATION'
STATUS_UNCERTAIN
public
mixed
STATUS_UNCERTAIN
= 'UNCERTAIN'
TRIGGER_SOURCE_API
public
mixed
TRIGGER_SOURCE_API
= 'API'
TRIGGER_SOURCE_SCHEDULE
public
mixed
TRIGGER_SOURCE_SCHEDULE
= 'SCHEDULE'
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', 'schedule_id' => 'scheduleId', 'connection_id' => 'connectionId', 'scheduled_for' => 'scheduledFor', 'trigger_source' => 'triggerSource', 'status' => 'status', 'inbox_placement_run_id' => 'inboxPlacementRunId', 'target_count' => 'targetCount', 'sent_count' => 'sentCount', 'attempt_count' => 'attemptCount', 'failure_code' => 'failureCode', 'failure_message' => 'failureMessage', 'started_at' => 'startedAt', 'finished_at' => 'finishedAt', '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', 'schedule_id' => 'getScheduleId', 'connection_id' => 'getConnectionId', 'scheduled_for' => 'getScheduledFor', 'trigger_source' => 'getTriggerSource', 'status' => 'getStatus', 'inbox_placement_run_id' => 'getInboxPlacementRunId', 'target_count' => 'getTargetCount', 'sent_count' => 'getSentCount', 'attempt_count' => 'getAttemptCount', 'failure_code' => 'getFailureCode', 'failure_message' => 'getFailureMessage', 'started_at' => 'getStartedAt', 'finished_at' => 'getFinishedAt', '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', 'schedule_id' => 'uuid', 'connection_id' => 'uuid', 'scheduled_for' => 'date-time', 'trigger_source' => null, 'status' => null, 'inbox_placement_run_id' => 'uuid', 'target_count' => 'int32', 'sent_count' => 'int32', 'attempt_count' => 'int32', 'failure_code' => null, 'failure_message' => null, 'started_at' => 'date-time', 'finished_at' => 'date-time', 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'AutomatedInboxPlacementExecutionDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'schedule_id' => false, 'connection_id' => false, 'scheduled_for' => false, 'trigger_source' => false, 'status' => false, 'inbox_placement_run_id' => true, 'target_count' => false, 'sent_count' => false, 'attempt_count' => false, 'failure_code' => true, 'failure_message' => true, 'started_at' => true, 'finished_at' => true, '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', 'schedule_id' => 'string', 'connection_id' => 'string', 'scheduled_for' => '\\DateTime', 'trigger_source' => 'string', 'status' => 'string', 'inbox_placement_run_id' => 'string', 'target_count' => 'int', 'sent_count' => 'int', 'attempt_count' => 'int', 'failure_code' => 'string', 'failure_message' => 'string', 'started_at' => '\\DateTime', 'finished_at' => '\\DateTime', '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', 'schedule_id' => 'setScheduleId', 'connection_id' => 'setConnectionId', 'scheduled_for' => 'setScheduledFor', 'trigger_source' => 'setTriggerSource', 'status' => 'setStatus', 'inbox_placement_run_id' => 'setInboxPlacementRunId', 'target_count' => 'setTargetCount', 'sent_count' => 'setSentCount', 'attempt_count' => 'setAttemptCount', 'failure_code' => 'setFailureCode', 'failure_message' => 'setFailureMessage', 'started_at' => 'setStartedAt', 'finished_at' => 'setFinishedAt', '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> —getAttemptCount()
Gets attempt_count
public
getAttemptCount() : int
Return values
int —getConnectionId()
Gets connection_id
public
getConnectionId() : string
Return values
string —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getFailureCode()
Gets failure_code
public
getFailureCode() : string|null
Return values
string|null —getFailureMessage()
Gets failure_message
public
getFailureMessage() : string|null
Return values
string|null —getFinishedAt()
Gets finished_at
public
getFinishedAt() : DateTime|null
Return values
DateTime|null —getId()
Gets id
public
getId() : string
Return values
string —getInboxPlacementRunId()
Gets inbox_placement_run_id
public
getInboxPlacementRunId() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getScheduledFor()
Gets scheduled_for
public
getScheduledFor() : DateTime
Return values
DateTime —getScheduleId()
Gets schedule_id
public
getScheduleId() : string
Return values
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> —getTargetCount()
Gets target_count
public
getTargetCount() : 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> —getTriggerSource()
Gets trigger_source
public
getTriggerSource() : string
Return values
string —getTriggerSourceAllowableValues()
Gets allowable values of the enum
public
getTriggerSourceAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —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> —setAttemptCount()
Sets attempt_count
public
setAttemptCount(int $attempt_count) : self
Parameters
- $attempt_count : int
-
attempt_count
Return values
self —setConnectionId()
Sets connection_id
public
setConnectionId(string $connection_id) : self
Parameters
- $connection_id : string
-
connection_id
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setFailureCode()
Sets failure_code
public
setFailureCode(string|null $failure_code) : self
Parameters
- $failure_code : string|null
-
failure_code
Return values
self —setFailureMessage()
Sets failure_message
public
setFailureMessage(string|null $failure_message) : self
Parameters
- $failure_message : string|null
-
failure_message
Return values
self —setFinishedAt()
Sets finished_at
public
setFinishedAt(DateTime|null $finished_at) : self
Parameters
- $finished_at : DateTime|null
-
finished_at
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setInboxPlacementRunId()
Sets inbox_placement_run_id
public
setInboxPlacementRunId(string|null $inbox_placement_run_id) : self
Parameters
- $inbox_placement_run_id : string|null
-
inbox_placement_run_id
Return values
self —setScheduledFor()
Sets scheduled_for
public
setScheduledFor(DateTime $scheduled_for) : self
Parameters
- $scheduled_for : DateTime
-
scheduled_for
Return values
self —setScheduleId()
Sets schedule_id
public
setScheduleId(string $schedule_id) : self
Parameters
- $schedule_id : string
-
schedule_id
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 —setTargetCount()
Sets target_count
public
setTargetCount(int $target_count) : self
Parameters
- $target_count : int
-
target_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> —setTriggerSource()
Sets trigger_source
public
setTriggerSource(string $trigger_source) : self
Parameters
- $trigger_source : string
-
trigger_source
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>