DomainPreview
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
DomainPreview Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- DOMAIN_TYPE_HTTP_INBOX = 'HTTP_INBOX'
- DOMAIN_TYPE_SMTP_DOMAIN = 'SMTP_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
- getCatchAllInboxId() : string|null
- Gets catch_all_inbox_id
- getCreatedAt() : DateTime
- Gets created_at
- getDomain() : string
- Gets domain
- getDomainType() : string
- Gets domain_type
- getDomainTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getHasMissingRecords() : bool
- Gets has_missing_records
- getId() : string
- Gets id
- getIsVerified() : bool
- Gets is_verified
- getModelName() : string
- The original name of the model.
- 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
- setCatchAllInboxId() : self
- Sets catch_all_inbox_id
- setCreatedAt() : self
- Sets created_at
- setDomain() : self
- Sets domain
- setDomainType() : self
- Sets domain_type
- setHasMissingRecords() : self
- Sets has_missing_records
- setId() : self
- Sets id
- setIsVerified() : self
- Sets is_verified
- 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
DOMAIN_TYPE_HTTP_INBOX
public
mixed
DOMAIN_TYPE_HTTP_INBOX
= 'HTTP_INBOX'
DOMAIN_TYPE_SMTP_DOMAIN
public
mixed
DOMAIN_TYPE_SMTP_DOMAIN
= 'SMTP_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
= ['id' => 'id', 'domain' => 'domain', 'catch_all_inbox_id' => 'catchAllInboxId', 'created_at' => 'createdAt', 'domain_type' => 'domainType', 'is_verified' => 'isVerified', 'has_missing_records' => 'hasMissingRecords']
$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', 'domain' => 'getDomain', 'catch_all_inbox_id' => 'getCatchAllInboxId', 'created_at' => 'getCreatedAt', 'domain_type' => 'getDomainType', 'is_verified' => 'getIsVerified', 'has_missing_records' => 'getHasMissingRecords']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'domain' => null, 'catch_all_inbox_id' => 'uuid', 'created_at' => 'date-time', 'domain_type' => null, 'is_verified' => null, 'has_missing_records' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'DomainPreview'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'domain' => false, 'catch_all_inbox_id' => true, 'created_at' => false, 'domain_type' => false, 'is_verified' => false, 'has_missing_records' => 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', 'domain' => 'string', 'catch_all_inbox_id' => 'string', 'created_at' => '\\DateTime', 'domain_type' => 'string', 'is_verified' => 'bool', 'has_missing_records' => 'bool']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'domain' => 'setDomain', 'catch_all_inbox_id' => 'setCatchAllInboxId', 'created_at' => 'setCreatedAt', 'domain_type' => 'setDomainType', 'is_verified' => 'setIsVerified', 'has_missing_records' => 'setHasMissingRecords']
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> —getCatchAllInboxId()
Gets catch_all_inbox_id
public
getCatchAllInboxId() : string|null
Return values
string|null —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getDomain()
Gets domain
public
getDomain() : string
Return values
string —getDomainType()
Gets domain_type
public
getDomainType() : string
Return values
string —getDomainTypeAllowableValues()
Gets allowable values of the enum
public
getDomainTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getHasMissingRecords()
Gets has_missing_records
public
getHasMissingRecords() : bool
Return values
bool —getId()
Gets id
public
getId() : string
Return values
string —getIsVerified()
Gets is_verified
public
getIsVerified() : bool
Return values
bool —getModelName()
The original name of the model.
public
getModelName() : string
Return values
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> —setCatchAllInboxId()
Sets catch_all_inbox_id
public
setCatchAllInboxId(string|null $catch_all_inbox_id) : self
Parameters
- $catch_all_inbox_id : string|null
-
catch_all_inbox_id
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setDomain()
Sets domain
public
setDomain(string $domain) : self
Parameters
- $domain : string
-
domain
Return values
self —setDomainType()
Sets domain_type
public
setDomainType(string $domain_type) : self
Parameters
- $domain_type : string
-
Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.
Return values
self —setHasMissingRecords()
Sets has_missing_records
public
setHasMissingRecords(bool $has_missing_records) : self
Parameters
- $has_missing_records : bool
-
has_missing_records
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setIsVerified()
Sets is_verified
public
setIsVerified(bool $is_verified) : self
Parameters
- $is_verified : bool
-
is_verified
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>