CreateInboxRetentionPolicyOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
CreateInboxRetentionPolicyOptions Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- SCOPE_ACCOUNT = 'ACCOUNT'
- SCOPE_DOMAIN = 'DOMAIN'
- SCOPE_INBOX = 'INBOX'
- $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
- getDomainId() : string|null
- Gets domain_id
- getEnabled() : bool
- Gets enabled
- getExcludedDomainIds() : array<string|int, string>
- Gets excluded_domain_ids
- getExcludedDomainNamePatterns() : array<string|int, string>
- Gets excluded_domain_name_patterns
- getExcludedInboxEmailAddressPatterns() : array<string|int, string>
- Gets excluded_inbox_email_address_patterns
- getExcludedInboxIds() : array<string|int, string>
- Gets excluded_inbox_ids
- getInboxId() : string|null
- Gets inbox_id
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getRetentionDays() : int
- Gets retention_days
- getScope() : string
- Gets scope
- getScopeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- 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
- setDomainId() : self
- Sets domain_id
- setEnabled() : self
- Sets enabled
- setExcludedDomainIds() : self
- Sets excluded_domain_ids
- setExcludedDomainNamePatterns() : self
- Sets excluded_domain_name_patterns
- setExcludedInboxEmailAddressPatterns() : self
- Sets excluded_inbox_email_address_patterns
- setExcludedInboxIds() : self
- Sets excluded_inbox_ids
- setInboxId() : self
- Sets inbox_id
- setName() : self
- Sets name
- setRetentionDays() : self
- Sets retention_days
- setScope() : self
- Sets scope
- 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
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
SCOPE_ACCOUNT
public
mixed
SCOPE_ACCOUNT
= 'ACCOUNT'
SCOPE_DOMAIN
public
mixed
SCOPE_DOMAIN
= 'DOMAIN'
SCOPE_INBOX
public
mixed
SCOPE_INBOX
= 'INBOX'
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
= ['name' => 'name', 'scope' => 'scope', 'retention_days' => 'retentionDays', 'inbox_id' => 'inboxId', 'domain_id' => 'domainId', 'enabled' => 'enabled', 'excluded_inbox_ids' => 'excludedInboxIds', 'excluded_domain_ids' => 'excludedDomainIds', 'excluded_inbox_email_address_patterns' => 'excludedInboxEmailAddressPatterns', 'excluded_domain_name_patterns' => 'excludedDomainNamePatterns']
$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
= ['name' => 'getName', 'scope' => 'getScope', 'retention_days' => 'getRetentionDays', 'inbox_id' => 'getInboxId', 'domain_id' => 'getDomainId', 'enabled' => 'getEnabled', 'excluded_inbox_ids' => 'getExcludedInboxIds', 'excluded_domain_ids' => 'getExcludedDomainIds', 'excluded_inbox_email_address_patterns' => 'getExcludedInboxEmailAddressPatterns', 'excluded_domain_name_patterns' => 'getExcludedDomainNamePatterns']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['name' => null, 'scope' => null, 'retention_days' => 'int32', 'inbox_id' => 'uuid', 'domain_id' => 'uuid', 'enabled' => null, 'excluded_inbox_ids' => 'uuid', 'excluded_domain_ids' => 'uuid', 'excluded_inbox_email_address_patterns' => null, 'excluded_domain_name_patterns' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'CreateInboxRetentionPolicyOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['name' => true, 'scope' => false, 'retention_days' => false, 'inbox_id' => true, 'domain_id' => true, 'enabled' => false, 'excluded_inbox_ids' => false, 'excluded_domain_ids' => false, 'excluded_inbox_email_address_patterns' => false, 'excluded_domain_name_patterns' => 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
= ['name' => 'string', 'scope' => 'string', 'retention_days' => 'int', 'inbox_id' => 'string', 'domain_id' => 'string', 'enabled' => 'bool', 'excluded_inbox_ids' => 'string[]', 'excluded_domain_ids' => 'string[]', 'excluded_inbox_email_address_patterns' => 'string[]', 'excluded_domain_name_patterns' => 'string[]']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['name' => 'setName', 'scope' => 'setScope', 'retention_days' => 'setRetentionDays', 'inbox_id' => 'setInboxId', 'domain_id' => 'setDomainId', 'enabled' => 'setEnabled', 'excluded_inbox_ids' => 'setExcludedInboxIds', 'excluded_domain_ids' => 'setExcludedDomainIds', 'excluded_inbox_email_address_patterns' => 'setExcludedInboxEmailAddressPatterns', 'excluded_domain_name_patterns' => 'setExcludedDomainNamePatterns']
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> —getDomainId()
Gets domain_id
public
getDomainId() : string|null
Return values
string|null —getEnabled()
Gets enabled
public
getEnabled() : bool
Return values
bool —getExcludedDomainIds()
Gets excluded_domain_ids
public
getExcludedDomainIds() : array<string|int, string>
Return values
array<string|int, string> —getExcludedDomainNamePatterns()
Gets excluded_domain_name_patterns
public
getExcludedDomainNamePatterns() : array<string|int, string>
Return values
array<string|int, string> —getExcludedInboxEmailAddressPatterns()
Gets excluded_inbox_email_address_patterns
public
getExcludedInboxEmailAddressPatterns() : array<string|int, string>
Return values
array<string|int, string> —getExcludedInboxIds()
Gets excluded_inbox_ids
public
getExcludedInboxIds() : array<string|int, string>
Return values
array<string|int, string> —getInboxId()
Gets inbox_id
public
getInboxId() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getRetentionDays()
Gets retention_days
public
getRetentionDays() : int
Return values
int —getScope()
Gets scope
public
getScope() : string
Return values
string —getScopeAllowableValues()
Gets allowable values of the enum
public
getScopeAllowableValues() : array<string|int, string>
Return values
array<string|int, 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> —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> —setDomainId()
Sets domain_id
public
setDomainId(string|null $domain_id) : self
Parameters
- $domain_id : string|null
-
domain_id
Return values
self —setEnabled()
Sets enabled
public
setEnabled(bool $enabled) : self
Parameters
- $enabled : bool
-
enabled
Return values
self —setExcludedDomainIds()
Sets excluded_domain_ids
public
setExcludedDomainIds(array<string|int, string> $excluded_domain_ids) : self
Parameters
- $excluded_domain_ids : array<string|int, string>
-
excluded_domain_ids
Return values
self —setExcludedDomainNamePatterns()
Sets excluded_domain_name_patterns
public
setExcludedDomainNamePatterns(array<string|int, string> $excluded_domain_name_patterns) : self
Parameters
- $excluded_domain_name_patterns : array<string|int, string>
-
excluded_domain_name_patterns
Return values
self —setExcludedInboxEmailAddressPatterns()
Sets excluded_inbox_email_address_patterns
public
setExcludedInboxEmailAddressPatterns(array<string|int, string> $excluded_inbox_email_address_patterns) : self
Parameters
- $excluded_inbox_email_address_patterns : array<string|int, string>
-
excluded_inbox_email_address_patterns
Return values
self —setExcludedInboxIds()
Sets excluded_inbox_ids
public
setExcludedInboxIds(array<string|int, string> $excluded_inbox_ids) : self
Parameters
- $excluded_inbox_ids : array<string|int, string>
-
excluded_inbox_ids
Return values
self —setInboxId()
Sets inbox_id
public
setInboxId(string|null $inbox_id) : self
Parameters
- $inbox_id : string|null
-
inbox_id
Return values
self —setName()
Sets name
public
setName(string|null $name) : self
Parameters
- $name : string|null
-
name
Return values
self —setRetentionDays()
Sets retention_days
public
setRetentionDays(int $retention_days) : self
Parameters
- $retention_days : int
-
retention_days
Return values
self —setScope()
Sets scope
public
setScope(string $scope) : self
Parameters
- $scope : string
-
scope
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>