AutomatedInboxPlacementScheduleDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
AutomatedInboxPlacementScheduleDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- LAST_STATUS_COMPLETE = 'COMPLETE'
- LAST_STATUS_FAILED = 'FAILED'
- LAST_STATUS_PARTIAL = 'PARTIAL'
- LAST_STATUS_PREPARING = 'PREPARING'
- LAST_STATUS_SENDING = 'SENDING'
- LAST_STATUS_SENT_PENDING_CONFIRMATION = 'SENT_PENDING_CONFIRMATION'
- LAST_STATUS_UNCERTAIN = 'UNCERTAIN'
- REQUESTED_SEGMENT_ALL_INBOXES = 'ALL_INBOXES'
- REQUESTED_SEGMENT_PERSONAL_INBOXES = 'PERSONAL_INBOXES'
- REQUESTED_SEGMENT_PROFESSIONAL_INBOXES = 'PROFESSIONAL_INBOXES'
- $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
- getConnectionId() : string
- Gets connection_id
- getConsecutiveFailures() : int
- Gets consecutive_failures
- getCreatedAt() : DateTime
- Gets created_at
- getEnabled() : bool
- Gets enabled
- getHtmlBodyTemplate() : string|null
- Gets html_body_template
- getId() : string
- Gets id
- getIntervalMinutes() : int
- Gets interval_minutes
- getLastRunAt() : DateTime|null
- Gets last_run_at
- getLastStatus() : string|null
- Gets last_status
- getLastStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getModelName() : string
- The original name of the model.
- getName() : string
- Gets name
- getNextRunAt() : DateTime|null
- Gets next_run_at
- getRequestedSegment() : string
- Gets requested_segment
- getRequestedSegmentAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getSeedlistProfile() : string|null
- Gets seedlist_profile
- getSourceRunId() : string|null
- Gets source_run_id
- getSubjectTemplate() : string
- Gets subject_template
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTextBodyTemplate() : string|null
- Gets text_body_template
- 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
- setConnectionId() : self
- Sets connection_id
- setConsecutiveFailures() : self
- Sets consecutive_failures
- setCreatedAt() : self
- Sets created_at
- setEnabled() : self
- Sets enabled
- setHtmlBodyTemplate() : self
- Sets html_body_template
- setId() : self
- Sets id
- setIntervalMinutes() : self
- Sets interval_minutes
- setLastRunAt() : self
- Sets last_run_at
- setLastStatus() : self
- Sets last_status
- setName() : self
- Sets name
- setNextRunAt() : self
- Sets next_run_at
- setRequestedSegment() : self
- Sets requested_segment
- setSeedlistProfile() : self
- Sets seedlist_profile
- setSourceRunId() : self
- Sets source_run_id
- setSubjectTemplate() : self
- Sets subject_template
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTextBodyTemplate() : self
- Sets text_body_template
- 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
LAST_STATUS_COMPLETE
public
mixed
LAST_STATUS_COMPLETE
= 'COMPLETE'
LAST_STATUS_FAILED
public
mixed
LAST_STATUS_FAILED
= 'FAILED'
LAST_STATUS_PARTIAL
public
mixed
LAST_STATUS_PARTIAL
= 'PARTIAL'
LAST_STATUS_PREPARING
public
mixed
LAST_STATUS_PREPARING
= 'PREPARING'
LAST_STATUS_SENDING
public
mixed
LAST_STATUS_SENDING
= 'SENDING'
LAST_STATUS_SENT_PENDING_CONFIRMATION
public
mixed
LAST_STATUS_SENT_PENDING_CONFIRMATION
= 'SENT_PENDING_CONFIRMATION'
LAST_STATUS_UNCERTAIN
public
mixed
LAST_STATUS_UNCERTAIN
= 'UNCERTAIN'
REQUESTED_SEGMENT_ALL_INBOXES
public
mixed
REQUESTED_SEGMENT_ALL_INBOXES
= 'ALL_INBOXES'
REQUESTED_SEGMENT_PERSONAL_INBOXES
public
mixed
REQUESTED_SEGMENT_PERSONAL_INBOXES
= 'PERSONAL_INBOXES'
REQUESTED_SEGMENT_PROFESSIONAL_INBOXES
public
mixed
REQUESTED_SEGMENT_PROFESSIONAL_INBOXES
= 'PROFESSIONAL_INBOXES'
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', 'name' => 'name', 'enabled' => 'enabled', 'interval_minutes' => 'intervalMinutes', 'requested_segment' => 'requestedSegment', 'seedlist_profile' => 'seedlistProfile', 'subject_template' => 'subjectTemplate', 'text_body_template' => 'textBodyTemplate', 'html_body_template' => 'htmlBodyTemplate', 'source_run_id' => 'sourceRunId', 'last_status' => 'lastStatus', 'consecutive_failures' => 'consecutiveFailures', 'last_run_at' => 'lastRunAt', 'next_run_at' => 'nextRunAt', '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', 'name' => 'getName', 'enabled' => 'getEnabled', 'interval_minutes' => 'getIntervalMinutes', 'requested_segment' => 'getRequestedSegment', 'seedlist_profile' => 'getSeedlistProfile', 'subject_template' => 'getSubjectTemplate', 'text_body_template' => 'getTextBodyTemplate', 'html_body_template' => 'getHtmlBodyTemplate', 'source_run_id' => 'getSourceRunId', 'last_status' => 'getLastStatus', 'consecutive_failures' => 'getConsecutiveFailures', 'last_run_at' => 'getLastRunAt', 'next_run_at' => 'getNextRunAt', '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', 'name' => null, 'enabled' => null, 'interval_minutes' => 'int64', 'requested_segment' => null, 'seedlist_profile' => null, 'subject_template' => null, 'text_body_template' => null, 'html_body_template' => null, 'source_run_id' => 'uuid', 'last_status' => null, 'consecutive_failures' => 'int32', 'last_run_at' => 'date-time', 'next_run_at' => 'date-time', 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'AutomatedInboxPlacementScheduleDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'connection_id' => false, 'name' => false, 'enabled' => false, 'interval_minutes' => false, 'requested_segment' => false, 'seedlist_profile' => true, 'subject_template' => false, 'text_body_template' => true, 'html_body_template' => true, 'source_run_id' => true, 'last_status' => true, 'consecutive_failures' => false, 'last_run_at' => true, 'next_run_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', 'connection_id' => 'string', 'name' => 'string', 'enabled' => 'bool', 'interval_minutes' => 'int', 'requested_segment' => 'string', 'seedlist_profile' => 'string', 'subject_template' => 'string', 'text_body_template' => 'string', 'html_body_template' => 'string', 'source_run_id' => 'string', 'last_status' => 'string', 'consecutive_failures' => 'int', 'last_run_at' => '\\DateTime', 'next_run_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', 'connection_id' => 'setConnectionId', 'name' => 'setName', 'enabled' => 'setEnabled', 'interval_minutes' => 'setIntervalMinutes', 'requested_segment' => 'setRequestedSegment', 'seedlist_profile' => 'setSeedlistProfile', 'subject_template' => 'setSubjectTemplate', 'text_body_template' => 'setTextBodyTemplate', 'html_body_template' => 'setHtmlBodyTemplate', 'source_run_id' => 'setSourceRunId', 'last_status' => 'setLastStatus', 'consecutive_failures' => 'setConsecutiveFailures', 'last_run_at' => 'setLastRunAt', 'next_run_at' => 'setNextRunAt', '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> —getConnectionId()
Gets connection_id
public
getConnectionId() : string
Return values
string —getConsecutiveFailures()
Gets consecutive_failures
public
getConsecutiveFailures() : int
Return values
int —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getEnabled()
Gets enabled
public
getEnabled() : bool
Return values
bool —getHtmlBodyTemplate()
Gets html_body_template
public
getHtmlBodyTemplate() : string|null
Return values
string|null —getId()
Gets id
public
getId() : string
Return values
string —getIntervalMinutes()
Gets interval_minutes
public
getIntervalMinutes() : int
Return values
int —getLastRunAt()
Gets last_run_at
public
getLastRunAt() : DateTime|null
Return values
DateTime|null —getLastStatus()
Gets last_status
public
getLastStatus() : string|null
Return values
string|null —getLastStatusAllowableValues()
Gets allowable values of the enum
public
getLastStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string
Return values
string —getNextRunAt()
Gets next_run_at
public
getNextRunAt() : DateTime|null
Return values
DateTime|null —getRequestedSegment()
Gets requested_segment
public
getRequestedSegment() : string
Return values
string —getRequestedSegmentAllowableValues()
Gets allowable values of the enum
public
getRequestedSegmentAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getSeedlistProfile()
Gets seedlist_profile
public
getSeedlistProfile() : string|null
Return values
string|null —getSourceRunId()
Gets source_run_id
public
getSourceRunId() : string|null
Return values
string|null —getSubjectTemplate()
Gets subject_template
public
getSubjectTemplate() : 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> —getTextBodyTemplate()
Gets text_body_template
public
getTextBodyTemplate() : string|null
Return values
string|null —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> —setConnectionId()
Sets connection_id
public
setConnectionId(string $connection_id) : self
Parameters
- $connection_id : string
-
connection_id
Return values
self —setConsecutiveFailures()
Sets consecutive_failures
public
setConsecutiveFailures(int $consecutive_failures) : self
Parameters
- $consecutive_failures : int
-
consecutive_failures
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setEnabled()
Sets enabled
public
setEnabled(bool $enabled) : self
Parameters
- $enabled : bool
-
enabled
Return values
self —setHtmlBodyTemplate()
Sets html_body_template
public
setHtmlBodyTemplate(string|null $html_body_template) : self
Parameters
- $html_body_template : string|null
-
html_body_template
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setIntervalMinutes()
Sets interval_minutes
public
setIntervalMinutes(int $interval_minutes) : self
Parameters
- $interval_minutes : int
-
interval_minutes
Return values
self —setLastRunAt()
Sets last_run_at
public
setLastRunAt(DateTime|null $last_run_at) : self
Parameters
- $last_run_at : DateTime|null
-
last_run_at
Return values
self —setLastStatus()
Sets last_status
public
setLastStatus(string|null $last_status) : self
Parameters
- $last_status : string|null
-
last_status
Return values
self —setName()
Sets name
public
setName(string $name) : self
Parameters
- $name : string
-
name
Return values
self —setNextRunAt()
Sets next_run_at
public
setNextRunAt(DateTime|null $next_run_at) : self
Parameters
- $next_run_at : DateTime|null
-
next_run_at
Return values
self —setRequestedSegment()
Sets requested_segment
public
setRequestedSegment(string $requested_segment) : self
Parameters
- $requested_segment : string
-
requested_segment
Return values
self —setSeedlistProfile()
Sets seedlist_profile
public
setSeedlistProfile(string|null $seedlist_profile) : self
Parameters
- $seedlist_profile : string|null
-
seedlist_profile
Return values
self —setSourceRunId()
Sets source_run_id
public
setSourceRunId(string|null $source_run_id) : self
Parameters
- $source_run_id : string|null
-
source_run_id
Return values
self —setSubjectTemplate()
Sets subject_template
public
setSubjectTemplate(string $subject_template) : self
Parameters
- $subject_template : string
-
subject_template
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> —setTextBodyTemplate()
Sets text_body_template
public
setTextBodyTemplate(string|null $text_body_template) : self
Parameters
- $text_body_template : string|null
-
text_body_template
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>