InboxPlacementRemoteTestSummaryDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
InboxPlacementRemoteTestSummaryDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- $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
- getExpiresAt() : DateTime|null
- Gets expires_at
- getFromEmail() : string|null
- Gets from_email
- getMode() : string
- Gets mode
- getModelName() : string
- The original name of the model.
- getReportStatus() : string
- Gets report_status
- getRequestedSegment() : string
- Gets requested_segment
- getSeedlistProfile() : string
- Gets seedlist_profile
- getSenderDomain() : string|null
- Gets sender_domain
- getStartedAt() : DateTime|null
- Gets started_at
- getStatus() : string
- Gets status
- getSubjectHint() : string|null
- Gets subject_hint
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTestId() : string
- Gets test_id
- 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
- setExpiresAt() : self
- Sets expires_at
- setFromEmail() : self
- Sets from_email
- setMode() : self
- Sets mode
- setReportStatus() : self
- Sets report_status
- setRequestedSegment() : self
- Sets requested_segment
- setSeedlistProfile() : self
- Sets seedlist_profile
- setSenderDomain() : self
- Sets sender_domain
- setStartedAt() : self
- Sets started_at
- setStatus() : self
- Sets status
- setSubjectHint() : self
- Sets subject_hint
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTestId() : self
- Sets test_id
- 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
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
= ['test_id' => 'testId', 'mode' => 'mode', 'status' => 'status', 'report_status' => 'reportStatus', 'requested_segment' => 'requestedSegment', 'seedlist_profile' => 'seedlistProfile', 'sender_domain' => 'senderDomain', 'from_email' => 'fromEmail', 'subject_hint' => 'subjectHint', 'started_at' => 'startedAt', 'expires_at' => 'expiresAt']
$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
= ['test_id' => 'getTestId', 'mode' => 'getMode', 'status' => 'getStatus', 'report_status' => 'getReportStatus', 'requested_segment' => 'getRequestedSegment', 'seedlist_profile' => 'getSeedlistProfile', 'sender_domain' => 'getSenderDomain', 'from_email' => 'getFromEmail', 'subject_hint' => 'getSubjectHint', 'started_at' => 'getStartedAt', 'expires_at' => 'getExpiresAt']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['test_id' => 'uuid', 'mode' => null, 'status' => null, 'report_status' => null, 'requested_segment' => null, 'seedlist_profile' => null, 'sender_domain' => null, 'from_email' => null, 'subject_hint' => null, 'started_at' => 'date-time', 'expires_at' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'InboxPlacementRemoteTestSummaryDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['test_id' => false, 'mode' => false, 'status' => false, 'report_status' => false, 'requested_segment' => false, 'seedlist_profile' => false, 'sender_domain' => true, 'from_email' => true, 'subject_hint' => true, 'started_at' => true, 'expires_at' => true]
$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
= ['test_id' => 'string', 'mode' => 'string', 'status' => 'string', 'report_status' => 'string', 'requested_segment' => 'string', 'seedlist_profile' => 'string', 'sender_domain' => 'string', 'from_email' => 'string', 'subject_hint' => 'string', 'started_at' => '\\DateTime', 'expires_at' => '\\DateTime']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['test_id' => 'setTestId', 'mode' => 'setMode', 'status' => 'setStatus', 'report_status' => 'setReportStatus', 'requested_segment' => 'setRequestedSegment', 'seedlist_profile' => 'setSeedlistProfile', 'sender_domain' => 'setSenderDomain', 'from_email' => 'setFromEmail', 'subject_hint' => 'setSubjectHint', 'started_at' => 'setStartedAt', 'expires_at' => 'setExpiresAt']
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> —getExpiresAt()
Gets expires_at
public
getExpiresAt() : DateTime|null
Return values
DateTime|null —getFromEmail()
Gets from_email
public
getFromEmail() : string|null
Return values
string|null —getMode()
Gets mode
public
getMode() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getReportStatus()
Gets report_status
public
getReportStatus() : string
Return values
string —getRequestedSegment()
Gets requested_segment
public
getRequestedSegment() : string
Return values
string —getSeedlistProfile()
Gets seedlist_profile
public
getSeedlistProfile() : string
Return values
string —getSenderDomain()
Gets sender_domain
public
getSenderDomain() : string|null
Return values
string|null —getStartedAt()
Gets started_at
public
getStartedAt() : DateTime|null
Return values
DateTime|null —getStatus()
Gets status
public
getStatus() : string
Return values
string —getSubjectHint()
Gets subject_hint
public
getSubjectHint() : string|null
Return values
string|null —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 —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> —setExpiresAt()
Sets expires_at
public
setExpiresAt(DateTime|null $expires_at) : self
Parameters
- $expires_at : DateTime|null
-
expires_at
Return values
self —setFromEmail()
Sets from_email
public
setFromEmail(string|null $from_email) : self
Parameters
- $from_email : string|null
-
from_email
Return values
self —setMode()
Sets mode
public
setMode(string $mode) : self
Parameters
- $mode : string
-
mode
Return values
self —setReportStatus()
Sets report_status
public
setReportStatus(string $report_status) : self
Parameters
- $report_status : string
-
report_status
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 $seedlist_profile) : self
Parameters
- $seedlist_profile : string
-
seedlist_profile
Return values
self —setSenderDomain()
Sets sender_domain
public
setSenderDomain(string|null $sender_domain) : self
Parameters
- $sender_domain : string|null
-
sender_domain
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 —setSubjectHint()
Sets subject_hint
public
setSubjectHint(string|null $subject_hint) : self
Parameters
- $subject_hint : string|null
-
subject_hint
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 —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>