Documentation

InboxPlacementTestRunDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

InboxPlacementTestRunDto Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

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
getBilledAt()  : DateTime|null
Gets billed_at
getCompletedAt()  : DateTime|null
Gets completed_at
getCreatedAt()  : DateTime
Gets created_at
getExpiresAt()  : DateTime|null
Gets expires_at
getFirstMatchAt()  : DateTime|null
Gets first_match_at
getFromEmail()  : string|null
Gets from_email
getId()  : string
Gets id
getInboxTargets()  : int
Gets inbox_targets
getLastEventAt()  : DateTime|null
Gets last_event_at
getLastSyncedAt()  : DateTime|null
Gets last_synced_at
getMatchedTargets()  : int
Gets matched_targets
getMode()  : string|null
Gets mode
getModelName()  : string
The original name of the model.
getNotReceivedTargets()  : int
Gets not_received_targets
getRemoteTestId()  : string
Gets remote_test_id
getReportStatus()  : string|null
Gets report_status
getRequestedSegment()  : string|null
Gets requested_segment
getSeedAddresses()  : array<string|int, string>
Gets seed_addresses
getSeedAddressFormats()  : array<string, string>
Gets seed_address_formats
getSeedlistProfile()  : string|null
Gets seedlist_profile
getSenderDomain()  : string|null
Gets sender_domain
getSpamTargets()  : int
Gets spam_targets
getStartedAt()  : DateTime|null
Gets started_at
getStatus()  : string|null
Gets status
getSubjectHint()  : string|null
Gets subject_hint
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTotalTargets()  : int
Gets total_targets
getTrackingToken()  : string|null
Gets tracking_token
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
setBilledAt()  : self
Sets billed_at
setCompletedAt()  : self
Sets completed_at
setCreatedAt()  : self
Sets created_at
setExpiresAt()  : self
Sets expires_at
setFirstMatchAt()  : self
Sets first_match_at
setFromEmail()  : self
Sets from_email
setId()  : self
Sets id
setInboxTargets()  : self
Sets inbox_targets
setLastEventAt()  : self
Sets last_event_at
setLastSyncedAt()  : self
Sets last_synced_at
setMatchedTargets()  : self
Sets matched_targets
setMode()  : self
Sets mode
setNotReceivedTargets()  : self
Sets not_received_targets
setRemoteTestId()  : self
Sets remote_test_id
setReportStatus()  : self
Sets report_status
setRequestedSegment()  : self
Sets requested_segment
setSeedAddresses()  : self
Sets seed_addresses
setSeedAddressFormats()  : self
Sets seed_address_formats
setSeedlistProfile()  : self
Sets seedlist_profile
setSenderDomain()  : self
Sets sender_domain
setSpamTargets()  : self
Sets spam_targets
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)
setTotalTargets()  : self
Sets total_targets
setTrackingToken()  : self
Sets tracking_token
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

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', 'remote_test_id' => 'remoteTestId', 'mode' => 'mode', 'status' => 'status', 'report_status' => 'reportStatus', 'requested_segment' => 'requestedSegment', 'seedlist_profile' => 'seedlistProfile', 'sender_domain' => 'senderDomain', 'from_email' => 'fromEmail', 'subject_hint' => 'subjectHint', 'tracking_token' => 'trackingToken', 'seed_addresses' => 'seedAddresses', 'seed_address_formats' => 'seedAddressFormats', 'total_targets' => 'totalTargets', 'matched_targets' => 'matchedTargets', 'inbox_targets' => 'inboxTargets', 'spam_targets' => 'spamTargets', 'not_received_targets' => 'notReceivedTargets', 'started_at' => 'startedAt', 'first_match_at' => 'firstMatchAt', 'completed_at' => 'completedAt', 'expires_at' => 'expiresAt', 'last_event_at' => 'lastEventAt', 'last_synced_at' => 'lastSyncedAt', 'billed_at' => 'billedAt', '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', 'remote_test_id' => 'getRemoteTestId', 'mode' => 'getMode', 'status' => 'getStatus', 'report_status' => 'getReportStatus', 'requested_segment' => 'getRequestedSegment', 'seedlist_profile' => 'getSeedlistProfile', 'sender_domain' => 'getSenderDomain', 'from_email' => 'getFromEmail', 'subject_hint' => 'getSubjectHint', 'tracking_token' => 'getTrackingToken', 'seed_addresses' => 'getSeedAddresses', 'seed_address_formats' => 'getSeedAddressFormats', 'total_targets' => 'getTotalTargets', 'matched_targets' => 'getMatchedTargets', 'inbox_targets' => 'getInboxTargets', 'spam_targets' => 'getSpamTargets', 'not_received_targets' => 'getNotReceivedTargets', 'started_at' => 'getStartedAt', 'first_match_at' => 'getFirstMatchAt', 'completed_at' => 'getCompletedAt', 'expires_at' => 'getExpiresAt', 'last_event_at' => 'getLastEventAt', 'last_synced_at' => 'getLastSyncedAt', 'billed_at' => 'getBilledAt', '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', 'remote_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, 'tracking_token' => null, 'seed_addresses' => null, 'seed_address_formats' => null, 'total_targets' => 'int32', 'matched_targets' => 'int32', 'inbox_targets' => 'int32', 'spam_targets' => 'int32', 'not_received_targets' => 'int32', 'started_at' => 'date-time', 'first_match_at' => 'date-time', 'completed_at' => 'date-time', 'expires_at' => 'date-time', 'last_event_at' => 'date-time', 'last_synced_at' => 'date-time', 'billed_at' => 'date-time', 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'InboxPlacementTestRunDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['id' => false, 'remote_test_id' => false, 'mode' => true, 'status' => true, 'report_status' => true, 'requested_segment' => true, 'seedlist_profile' => true, 'sender_domain' => true, 'from_email' => true, 'subject_hint' => true, 'tracking_token' => true, 'seed_addresses' => false, 'seed_address_formats' => false, 'total_targets' => false, 'matched_targets' => false, 'inbox_targets' => false, 'spam_targets' => false, 'not_received_targets' => false, 'started_at' => true, 'first_match_at' => true, 'completed_at' => true, 'expires_at' => true, 'last_event_at' => true, 'last_synced_at' => true, 'billed_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', 'remote_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', 'tracking_token' => 'string', 'seed_addresses' => 'string[]', 'seed_address_formats' => 'array<string,string>', 'total_targets' => 'int', 'matched_targets' => 'int', 'inbox_targets' => 'int', 'spam_targets' => 'int', 'not_received_targets' => 'int', 'started_at' => '\\DateTime', 'first_match_at' => '\\DateTime', 'completed_at' => '\\DateTime', 'expires_at' => '\\DateTime', 'last_event_at' => '\\DateTime', 'last_synced_at' => '\\DateTime', 'billed_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', 'remote_test_id' => 'setRemoteTestId', 'mode' => 'setMode', 'status' => 'setStatus', 'report_status' => 'setReportStatus', 'requested_segment' => 'setRequestedSegment', 'seedlist_profile' => 'setSeedlistProfile', 'sender_domain' => 'setSenderDomain', 'from_email' => 'setFromEmail', 'subject_hint' => 'setSubjectHint', 'tracking_token' => 'setTrackingToken', 'seed_addresses' => 'setSeedAddresses', 'seed_address_formats' => 'setSeedAddressFormats', 'total_targets' => 'setTotalTargets', 'matched_targets' => 'setMatchedTargets', 'inbox_targets' => 'setInboxTargets', 'spam_targets' => 'setSpamTargets', 'not_received_targets' => 'setNotReceivedTargets', 'started_at' => 'setStartedAt', 'first_match_at' => 'setFirstMatchAt', 'completed_at' => 'setCompletedAt', 'expires_at' => 'setExpiresAt', 'last_event_at' => 'setLastEventAt', 'last_synced_at' => 'setLastSyncedAt', 'billed_at' => 'setBilledAt', '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> —

getCompletedAt()

Gets completed_at

public getCompletedAt() : DateTime|null
Return values
DateTime|null —

getFirstMatchAt()

Gets first_match_at

public getFirstMatchAt() : DateTime|null
Return values
DateTime|null —

getLastEventAt()

Gets last_event_at

public getLastEventAt() : DateTime|null
Return values
DateTime|null —

getLastSyncedAt()

Gets last_synced_at

public getLastSyncedAt() : DateTime|null
Return values
DateTime|null —

getNotReceivedTargets()

Gets not_received_targets

public getNotReceivedTargets() : int
Return values
int —

getReportStatus()

Gets report_status

public getReportStatus() : string|null
Return values
string|null —

getRequestedSegment()

Gets requested_segment

public getRequestedSegment() : string|null
Return values
string|null —

getSeedAddresses()

Gets seed_addresses

public getSeedAddresses() : array<string|int, string>
Return values
array<string|int, string> —

getSeedAddressFormats()

Gets seed_address_formats

public getSeedAddressFormats() : array<string, string>
Return values
array<string, string> —

getSeedlistProfile()

Gets seedlist_profile

public getSeedlistProfile() : string|null
Return values
string|null —

getSenderDomain()

Gets sender_domain

public getSenderDomain() : 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> —

getTrackingToken()

Gets tracking_token

public getTrackingToken() : string|null
Return values
string|null —

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 —

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> —

setBilledAt()

Sets billed_at

public setBilledAt(DateTime|null $billed_at) : self
Parameters
$billed_at : DateTime|null

billed_at

Return values
self —

setCompletedAt()

Sets completed_at

public setCompletedAt(DateTime|null $completed_at) : self
Parameters
$completed_at : DateTime|null

completed_at

Return values
self —

setCreatedAt()

Sets created_at

public setCreatedAt(DateTime $created_at) : self
Parameters
$created_at : DateTime

created_at

Return values
self —

setExpiresAt()

Sets expires_at

public setExpiresAt(DateTime|null $expires_at) : self
Parameters
$expires_at : DateTime|null

expires_at

Return values
self —

setFirstMatchAt()

Sets first_match_at

public setFirstMatchAt(DateTime|null $first_match_at) : self
Parameters
$first_match_at : DateTime|null

first_match_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 —

setInboxTargets()

Sets inbox_targets

public setInboxTargets(int $inbox_targets) : self
Parameters
$inbox_targets : int

inbox_targets

Return values
self —

setLastEventAt()

Sets last_event_at

public setLastEventAt(DateTime|null $last_event_at) : self
Parameters
$last_event_at : DateTime|null

last_event_at

Return values
self —

setLastSyncedAt()

Sets last_synced_at

public setLastSyncedAt(DateTime|null $last_synced_at) : self
Parameters
$last_synced_at : DateTime|null

last_synced_at

Return values
self —

setMatchedTargets()

Sets matched_targets

public setMatchedTargets(int $matched_targets) : self
Parameters
$matched_targets : int

matched_targets

Return values
self —

setMode()

Sets mode

public setMode(string|null $mode) : self
Parameters
$mode : string|null

mode

Return values
self —

setNotReceivedTargets()

Sets not_received_targets

public setNotReceivedTargets(int $not_received_targets) : self
Parameters
$not_received_targets : int

not_received_targets

Return values
self —

setRemoteTestId()

Sets remote_test_id

public setRemoteTestId(string $remote_test_id) : self
Parameters
$remote_test_id : string

remote_test_id

Return values
self —

setReportStatus()

Sets report_status

public setReportStatus(string|null $report_status) : self
Parameters
$report_status : string|null

report_status

Return values
self —

setRequestedSegment()

Sets requested_segment

public setRequestedSegment(string|null $requested_segment) : self
Parameters
$requested_segment : string|null

requested_segment

Return values
self —

setSeedAddresses()

Sets seed_addresses

public setSeedAddresses(array<string|int, string> $seed_addresses) : self
Parameters
$seed_addresses : array<string|int, string>

seed_addresses

Return values
self —

setSeedAddressFormats()

Sets seed_address_formats

public setSeedAddressFormats(array<string, string> $seed_address_formats) : self
Parameters
$seed_address_formats : array<string, string>

seed_address_formats

Return values
self —

setSeedlistProfile()

Sets seedlist_profile

public setSeedlistProfile(string|null $seedlist_profile) : self
Parameters
$seedlist_profile : string|null

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 —

setSpamTargets()

Sets spam_targets

public setSpamTargets(int $spam_targets) : self
Parameters
$spam_targets : int

spam_targets

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|null $status) : self
Parameters
$status : string|null

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> —

setTotalTargets()

Sets total_targets

public setTotalTargets(int $total_targets) : self
Parameters
$total_targets : int

total_targets

Return values
self —

setTrackingToken()

Sets tracking_token

public setTrackingToken(string|null $tracking_token) : self
Parameters
$tracking_token : string|null

tracking_token

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>
Return values
void —

Search results