InboxPlacementAnalyticsSeriesDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
InboxPlacementAnalyticsSeriesDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- BUCKET_DAY = 'DAY'
- BUCKET_HOUR = 'HOUR'
- DISCRIMINATOR = null
- GROUP_BY_FROM_EMAIL = 'FROM_EMAIL'
- GROUP_BY_NONE = 'NONE'
- GROUP_BY_SENDER_DOMAIN = 'SENDER_DOMAIN'
- $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
- getBefore() : DateTime
- Gets before
- getBucket() : string
- Gets bucket
- getBucketAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getFromEmail() : string|null
- Gets from_email
- getGroupBy() : string
- Gets group_by
- getGroupByAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getGroups() : array<string|int, InboxPlacementAnalyticsGroupSeriesDto>
- Gets groups
- getModelName() : string
- The original name of the model.
- getPoints() : array<string|int, InboxPlacementAnalyticsSeriesPointDto>
- Gets points
- getRuns() : array<string|int, InboxPlacementAnalyticsRunDto>
- Gets runs
- getSenderDomain() : string|null
- Gets sender_domain
- getSince() : DateTime
- Gets since
- getSummary() : InboxPlacementAnalyticsSummaryDto
- Gets summary
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- 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
- setBefore() : self
- Sets before
- setBucket() : self
- Sets bucket
- setFromEmail() : self
- Sets from_email
- setGroupBy() : self
- Sets group_by
- setGroups() : self
- Sets groups
- setPoints() : self
- Sets points
- setRuns() : self
- Sets runs
- setSenderDomain() : self
- Sets sender_domain
- setSince() : self
- Sets since
- setSummary() : self
- Sets summary
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- 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
BUCKET_DAY
public
mixed
BUCKET_DAY
= 'DAY'
BUCKET_HOUR
public
mixed
BUCKET_HOUR
= 'HOUR'
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
GROUP_BY_FROM_EMAIL
public
mixed
GROUP_BY_FROM_EMAIL
= 'FROM_EMAIL'
GROUP_BY_NONE
public
mixed
GROUP_BY_NONE
= 'NONE'
GROUP_BY_SENDER_DOMAIN
public
mixed
GROUP_BY_SENDER_DOMAIN
= 'SENDER_DOMAIN'
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
= ['since' => 'since', 'before' => 'before', 'bucket' => 'bucket', 'group_by' => 'groupBy', 'sender_domain' => 'senderDomain', 'from_email' => 'fromEmail', 'summary' => 'summary', 'runs' => 'runs', 'points' => 'points', 'groups' => 'groups']
$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
= ['since' => 'getSince', 'before' => 'getBefore', 'bucket' => 'getBucket', 'group_by' => 'getGroupBy', 'sender_domain' => 'getSenderDomain', 'from_email' => 'getFromEmail', 'summary' => 'getSummary', 'runs' => 'getRuns', 'points' => 'getPoints', 'groups' => 'getGroups']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['since' => 'date-time', 'before' => 'date-time', 'bucket' => null, 'group_by' => null, 'sender_domain' => null, 'from_email' => null, 'summary' => null, 'runs' => null, 'points' => null, 'groups' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'InboxPlacementAnalyticsSeriesDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['since' => false, 'before' => false, 'bucket' => false, 'group_by' => false, 'sender_domain' => true, 'from_email' => true, 'summary' => false, 'runs' => false, 'points' => false, 'groups' => 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
= ['since' => '\\DateTime', 'before' => '\\DateTime', 'bucket' => 'string', 'group_by' => 'string', 'sender_domain' => 'string', 'from_email' => 'string', 'summary' => '\\MailSlurp\\Models\\InboxPlacementAnalyticsSummaryDto', 'runs' => '\\MailSlurp\\Models\\InboxPlacementAnalyticsRunDto[]', 'points' => '\\MailSlurp\\Models\\InboxPlacementAnalyticsSeriesPointDto[]', 'groups' => '\\MailSlurp\\Models\\InboxPlacementAnalyticsGroupSeriesDto[]']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['since' => 'setSince', 'before' => 'setBefore', 'bucket' => 'setBucket', 'group_by' => 'setGroupBy', 'sender_domain' => 'setSenderDomain', 'from_email' => 'setFromEmail', 'summary' => 'setSummary', 'runs' => 'setRuns', 'points' => 'setPoints', 'groups' => 'setGroups']
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> —getBefore()
Gets before
public
getBefore() : DateTime
Return values
DateTime —getBucket()
Gets bucket
public
getBucket() : string
Return values
string —getBucketAllowableValues()
Gets allowable values of the enum
public
getBucketAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getFromEmail()
Gets from_email
public
getFromEmail() : string|null
Return values
string|null —getGroupBy()
Gets group_by
public
getGroupBy() : string
Return values
string —getGroupByAllowableValues()
Gets allowable values of the enum
public
getGroupByAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getGroups()
Gets groups
public
getGroups() : array<string|int, InboxPlacementAnalyticsGroupSeriesDto>
Return values
array<string|int, InboxPlacementAnalyticsGroupSeriesDto> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPoints()
Gets points
public
getPoints() : array<string|int, InboxPlacementAnalyticsSeriesPointDto>
Return values
array<string|int, InboxPlacementAnalyticsSeriesPointDto> —getRuns()
Gets runs
public
getRuns() : array<string|int, InboxPlacementAnalyticsRunDto>
Return values
array<string|int, InboxPlacementAnalyticsRunDto> —getSenderDomain()
Gets sender_domain
public
getSenderDomain() : string|null
Return values
string|null —getSince()
Gets since
public
getSince() : DateTime
Return values
DateTime —getSummary()
Gets summary
public
getSummary() : InboxPlacementAnalyticsSummaryDto
Return values
InboxPlacementAnalyticsSummaryDto —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —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> —setBefore()
Sets before
public
setBefore(DateTime $before) : self
Parameters
- $before : DateTime
-
before
Return values
self —setBucket()
Sets bucket
public
setBucket(string $bucket) : self
Parameters
- $bucket : string
-
bucket
Return values
self —setFromEmail()
Sets from_email
public
setFromEmail(string|null $from_email) : self
Parameters
- $from_email : string|null
-
from_email
Return values
self —setGroupBy()
Sets group_by
public
setGroupBy(string $group_by) : self
Parameters
- $group_by : string
-
group_by
Return values
self —setGroups()
Sets groups
public
setGroups(array<string|int, InboxPlacementAnalyticsGroupSeriesDto> $groups) : self
Parameters
- $groups : array<string|int, InboxPlacementAnalyticsGroupSeriesDto>
-
groups
Return values
self —setPoints()
Sets points
public
setPoints(array<string|int, InboxPlacementAnalyticsSeriesPointDto> $points) : self
Parameters
- $points : array<string|int, InboxPlacementAnalyticsSeriesPointDto>
-
points
Return values
self —setRuns()
Sets runs
public
setRuns(array<string|int, InboxPlacementAnalyticsRunDto> $runs) : self
Parameters
- $runs : array<string|int, InboxPlacementAnalyticsRunDto>
-
runs
Return values
self —setSenderDomain()
Sets sender_domain
public
setSenderDomain(string|null $sender_domain) : self
Parameters
- $sender_domain : string|null
-
sender_domain
Return values
self —setSince()
Sets since
public
setSince(DateTime $since) : self
Parameters
- $since : DateTime
-
since
Return values
self —setSummary()
Sets summary
public
setSummary(InboxPlacementAnalyticsSummaryDto $summary) : self
Parameters
- $summary : InboxPlacementAnalyticsSummaryDto
-
summary
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> —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>