EmailWarmupUsageSummaryDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
EmailWarmupUsageSummaryDto 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
- getAcceptedCredits() : int
- Gets accepted_credits
- getActiveSenderAssignments() : int
- Gets active_sender_assignments
- getAmbiguousCredits() : int
- Gets ambiguous_credits
- getBillableAcceptedCredits() : int
- Gets billable_accepted_credits
- getBillablePendingCredits() : int
- Gets billable_pending_credits
- getBillingMonth() : DateTime
- Gets billing_month
- getBillingMonthEndExclusive() : DateTime
- Gets billing_month_end_exclusive
- getControlledRecipientCreditWeight() : int
- Gets controlled_recipient_credit_weight
- getIncludedCreditsConsumed() : int
- Gets included_credits_consumed
- getIncludedCreditsPerSender() : int
- Gets included_credits_per_sender
- getIncludedCreditsRemaining() : int
- Gets included_credits_remaining
- getIncludedCreditsTotal() : int
- Gets included_credits_total
- getIncludedSenderSeats() : int
- Gets included_sender_seats
- getModelName() : string
- The original name of the model.
- getPremiumRecipientCreditWeight() : int
- Gets premium_recipient_credit_weight
- getPurchasedSenderSeats() : int
- Gets purchased_sender_seats
- getReservedCredits() : int
- Gets reserved_credits
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTotalSenderCapacity() : int
- Gets total_sender_capacity
- 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
- setAcceptedCredits() : self
- Sets accepted_credits
- setActiveSenderAssignments() : self
- Sets active_sender_assignments
- setAmbiguousCredits() : self
- Sets ambiguous_credits
- setBillableAcceptedCredits() : self
- Sets billable_accepted_credits
- setBillablePendingCredits() : self
- Sets billable_pending_credits
- setBillingMonth() : self
- Sets billing_month
- setBillingMonthEndExclusive() : self
- Sets billing_month_end_exclusive
- setControlledRecipientCreditWeight() : self
- Sets controlled_recipient_credit_weight
- setIncludedCreditsConsumed() : self
- Sets included_credits_consumed
- setIncludedCreditsPerSender() : self
- Sets included_credits_per_sender
- setIncludedCreditsRemaining() : self
- Sets included_credits_remaining
- setIncludedCreditsTotal() : self
- Sets included_credits_total
- setIncludedSenderSeats() : self
- Sets included_sender_seats
- setPremiumRecipientCreditWeight() : self
- Sets premium_recipient_credit_weight
- setPurchasedSenderSeats() : self
- Sets purchased_sender_seats
- setReservedCredits() : self
- Sets reserved_credits
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTotalSenderCapacity() : self
- Sets total_sender_capacity
- 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
= ['billing_month' => 'billingMonth', 'billing_month_end_exclusive' => 'billingMonthEndExclusive', 'included_sender_seats' => 'includedSenderSeats', 'purchased_sender_seats' => 'purchasedSenderSeats', 'total_sender_capacity' => 'totalSenderCapacity', 'active_sender_assignments' => 'activeSenderAssignments', 'included_credits_per_sender' => 'includedCreditsPerSender', 'included_credits_total' => 'includedCreditsTotal', 'included_credits_consumed' => 'includedCreditsConsumed', 'included_credits_remaining' => 'includedCreditsRemaining', 'reserved_credits' => 'reservedCredits', 'accepted_credits' => 'acceptedCredits', 'ambiguous_credits' => 'ambiguousCredits', 'billable_accepted_credits' => 'billableAcceptedCredits', 'billable_pending_credits' => 'billablePendingCredits', 'controlled_recipient_credit_weight' => 'controlledRecipientCreditWeight', 'premium_recipient_credit_weight' => 'premiumRecipientCreditWeight']
$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
= ['billing_month' => 'getBillingMonth', 'billing_month_end_exclusive' => 'getBillingMonthEndExclusive', 'included_sender_seats' => 'getIncludedSenderSeats', 'purchased_sender_seats' => 'getPurchasedSenderSeats', 'total_sender_capacity' => 'getTotalSenderCapacity', 'active_sender_assignments' => 'getActiveSenderAssignments', 'included_credits_per_sender' => 'getIncludedCreditsPerSender', 'included_credits_total' => 'getIncludedCreditsTotal', 'included_credits_consumed' => 'getIncludedCreditsConsumed', 'included_credits_remaining' => 'getIncludedCreditsRemaining', 'reserved_credits' => 'getReservedCredits', 'accepted_credits' => 'getAcceptedCredits', 'ambiguous_credits' => 'getAmbiguousCredits', 'billable_accepted_credits' => 'getBillableAcceptedCredits', 'billable_pending_credits' => 'getBillablePendingCredits', 'controlled_recipient_credit_weight' => 'getControlledRecipientCreditWeight', 'premium_recipient_credit_weight' => 'getPremiumRecipientCreditWeight']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['billing_month' => 'date', 'billing_month_end_exclusive' => 'date', 'included_sender_seats' => 'int32', 'purchased_sender_seats' => 'int32', 'total_sender_capacity' => 'int32', 'active_sender_assignments' => 'int64', 'included_credits_per_sender' => 'int32', 'included_credits_total' => 'int64', 'included_credits_consumed' => 'int64', 'included_credits_remaining' => 'int64', 'reserved_credits' => 'int64', 'accepted_credits' => 'int64', 'ambiguous_credits' => 'int64', 'billable_accepted_credits' => 'int64', 'billable_pending_credits' => 'int64', 'controlled_recipient_credit_weight' => 'int32', 'premium_recipient_credit_weight' => 'int32']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'EmailWarmupUsageSummaryDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['billing_month' => false, 'billing_month_end_exclusive' => false, 'included_sender_seats' => false, 'purchased_sender_seats' => false, 'total_sender_capacity' => false, 'active_sender_assignments' => false, 'included_credits_per_sender' => false, 'included_credits_total' => false, 'included_credits_consumed' => false, 'included_credits_remaining' => false, 'reserved_credits' => false, 'accepted_credits' => false, 'ambiguous_credits' => false, 'billable_accepted_credits' => false, 'billable_pending_credits' => false, 'controlled_recipient_credit_weight' => false, 'premium_recipient_credit_weight' => 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
= ['billing_month' => '\\DateTime', 'billing_month_end_exclusive' => '\\DateTime', 'included_sender_seats' => 'int', 'purchased_sender_seats' => 'int', 'total_sender_capacity' => 'int', 'active_sender_assignments' => 'int', 'included_credits_per_sender' => 'int', 'included_credits_total' => 'int', 'included_credits_consumed' => 'int', 'included_credits_remaining' => 'int', 'reserved_credits' => 'int', 'accepted_credits' => 'int', 'ambiguous_credits' => 'int', 'billable_accepted_credits' => 'int', 'billable_pending_credits' => 'int', 'controlled_recipient_credit_weight' => 'int', 'premium_recipient_credit_weight' => 'int']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['billing_month' => 'setBillingMonth', 'billing_month_end_exclusive' => 'setBillingMonthEndExclusive', 'included_sender_seats' => 'setIncludedSenderSeats', 'purchased_sender_seats' => 'setPurchasedSenderSeats', 'total_sender_capacity' => 'setTotalSenderCapacity', 'active_sender_assignments' => 'setActiveSenderAssignments', 'included_credits_per_sender' => 'setIncludedCreditsPerSender', 'included_credits_total' => 'setIncludedCreditsTotal', 'included_credits_consumed' => 'setIncludedCreditsConsumed', 'included_credits_remaining' => 'setIncludedCreditsRemaining', 'reserved_credits' => 'setReservedCredits', 'accepted_credits' => 'setAcceptedCredits', 'ambiguous_credits' => 'setAmbiguousCredits', 'billable_accepted_credits' => 'setBillableAcceptedCredits', 'billable_pending_credits' => 'setBillablePendingCredits', 'controlled_recipient_credit_weight' => 'setControlledRecipientCreditWeight', 'premium_recipient_credit_weight' => 'setPremiumRecipientCreditWeight']
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> —getAcceptedCredits()
Gets accepted_credits
public
getAcceptedCredits() : int
Return values
int —getActiveSenderAssignments()
Gets active_sender_assignments
public
getActiveSenderAssignments() : int
Return values
int —getAmbiguousCredits()
Gets ambiguous_credits
public
getAmbiguousCredits() : int
Return values
int —getBillableAcceptedCredits()
Gets billable_accepted_credits
public
getBillableAcceptedCredits() : int
Return values
int —getBillablePendingCredits()
Gets billable_pending_credits
public
getBillablePendingCredits() : int
Return values
int —getBillingMonth()
Gets billing_month
public
getBillingMonth() : DateTime
Return values
DateTime —getBillingMonthEndExclusive()
Gets billing_month_end_exclusive
public
getBillingMonthEndExclusive() : DateTime
Return values
DateTime —getControlledRecipientCreditWeight()
Gets controlled_recipient_credit_weight
public
getControlledRecipientCreditWeight() : int
Return values
int —getIncludedCreditsConsumed()
Gets included_credits_consumed
public
getIncludedCreditsConsumed() : int
Return values
int —getIncludedCreditsPerSender()
Gets included_credits_per_sender
public
getIncludedCreditsPerSender() : int
Return values
int —getIncludedCreditsRemaining()
Gets included_credits_remaining
public
getIncludedCreditsRemaining() : int
Return values
int —getIncludedCreditsTotal()
Gets included_credits_total
public
getIncludedCreditsTotal() : int
Return values
int —getIncludedSenderSeats()
Gets included_sender_seats
public
getIncludedSenderSeats() : int
Return values
int —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPremiumRecipientCreditWeight()
Gets premium_recipient_credit_weight
public
getPremiumRecipientCreditWeight() : int
Return values
int —getPurchasedSenderSeats()
Gets purchased_sender_seats
public
getPurchasedSenderSeats() : int
Return values
int —getReservedCredits()
Gets reserved_credits
public
getReservedCredits() : 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> —getTotalSenderCapacity()
Gets total_sender_capacity
public
getTotalSenderCapacity() : int
Return values
int —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> —setAcceptedCredits()
Sets accepted_credits
public
setAcceptedCredits(int $accepted_credits) : self
Parameters
- $accepted_credits : int
-
accepted_credits
Return values
self —setActiveSenderAssignments()
Sets active_sender_assignments
public
setActiveSenderAssignments(int $active_sender_assignments) : self
Parameters
- $active_sender_assignments : int
-
active_sender_assignments
Return values
self —setAmbiguousCredits()
Sets ambiguous_credits
public
setAmbiguousCredits(int $ambiguous_credits) : self
Parameters
- $ambiguous_credits : int
-
ambiguous_credits
Return values
self —setBillableAcceptedCredits()
Sets billable_accepted_credits
public
setBillableAcceptedCredits(int $billable_accepted_credits) : self
Parameters
- $billable_accepted_credits : int
-
billable_accepted_credits
Return values
self —setBillablePendingCredits()
Sets billable_pending_credits
public
setBillablePendingCredits(int $billable_pending_credits) : self
Parameters
- $billable_pending_credits : int
-
billable_pending_credits
Return values
self —setBillingMonth()
Sets billing_month
public
setBillingMonth(DateTime $billing_month) : self
Parameters
- $billing_month : DateTime
-
billing_month
Return values
self —setBillingMonthEndExclusive()
Sets billing_month_end_exclusive
public
setBillingMonthEndExclusive(DateTime $billing_month_end_exclusive) : self
Parameters
- $billing_month_end_exclusive : DateTime
-
billing_month_end_exclusive
Return values
self —setControlledRecipientCreditWeight()
Sets controlled_recipient_credit_weight
public
setControlledRecipientCreditWeight(int $controlled_recipient_credit_weight) : self
Parameters
- $controlled_recipient_credit_weight : int
-
controlled_recipient_credit_weight
Return values
self —setIncludedCreditsConsumed()
Sets included_credits_consumed
public
setIncludedCreditsConsumed(int $included_credits_consumed) : self
Parameters
- $included_credits_consumed : int
-
included_credits_consumed
Return values
self —setIncludedCreditsPerSender()
Sets included_credits_per_sender
public
setIncludedCreditsPerSender(int $included_credits_per_sender) : self
Parameters
- $included_credits_per_sender : int
-
included_credits_per_sender
Return values
self —setIncludedCreditsRemaining()
Sets included_credits_remaining
public
setIncludedCreditsRemaining(int $included_credits_remaining) : self
Parameters
- $included_credits_remaining : int
-
included_credits_remaining
Return values
self —setIncludedCreditsTotal()
Sets included_credits_total
public
setIncludedCreditsTotal(int $included_credits_total) : self
Parameters
- $included_credits_total : int
-
included_credits_total
Return values
self —setIncludedSenderSeats()
Sets included_sender_seats
public
setIncludedSenderSeats(int $included_sender_seats) : self
Parameters
- $included_sender_seats : int
-
included_sender_seats
Return values
self —setPremiumRecipientCreditWeight()
Sets premium_recipient_credit_weight
public
setPremiumRecipientCreditWeight(int $premium_recipient_credit_weight) : self
Parameters
- $premium_recipient_credit_weight : int
-
premium_recipient_credit_weight
Return values
self —setPurchasedSenderSeats()
Sets purchased_sender_seats
public
setPurchasedSenderSeats(int $purchased_sender_seats) : self
Parameters
- $purchased_sender_seats : int
-
purchased_sender_seats
Return values
self —setReservedCredits()
Sets reserved_credits
public
setReservedCredits(int $reserved_credits) : self
Parameters
- $reserved_credits : int
-
reserved_credits
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> —setTotalSenderCapacity()
Sets total_sender_capacity
public
setTotalSenderCapacity(int $total_sender_capacity) : self
Parameters
- $total_sender_capacity : int
-
total_sender_capacity
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>