DomainDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
DomainDto 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
- getDkimTokens() : array<string|int, string>
- Gets dkim_tokens
- getDomain() : string
- Gets domain
- getDomainNameRecords() : array<string|int, DomainNameRecord>
- Gets domain_name_records
- 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
- getMissingRecordsMessage() : string|null
- Gets missing_records_message
- getModelName() : string
- The original name of the model.
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUpdatedAt() : DateTime
- Gets updated_at
- getUserId() : string
- Gets user_id
- getVerificationToken() : string
- Gets verification_token
- 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
- setDkimTokens() : self
- Sets dkim_tokens
- setDomain() : self
- Sets domain
- setDomainNameRecords() : self
- Sets domain_name_records
- setDomainType() : self
- Sets domain_type
- setHasMissingRecords() : self
- Sets has_missing_records
- setId() : self
- Sets id
- setIsVerified() : self
- Sets is_verified
- setMissingRecordsMessage() : self
- Sets missing_records_message
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUpdatedAt() : self
- Sets updated_at
- setUserId() : self
- Sets user_id
- setVerificationToken() : self
- Sets verification_token
- 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', 'user_id' => 'userId', 'domain' => 'domain', 'verification_token' => 'verificationToken', 'dkim_tokens' => 'dkimTokens', 'missing_records_message' => 'missingRecordsMessage', 'has_missing_records' => 'hasMissingRecords', 'is_verified' => 'isVerified', 'domain_name_records' => 'domainNameRecords', 'catch_all_inbox_id' => 'catchAllInboxId', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt', 'domain_type' => 'domainType']
$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', 'user_id' => 'getUserId', 'domain' => 'getDomain', 'verification_token' => 'getVerificationToken', 'dkim_tokens' => 'getDkimTokens', 'missing_records_message' => 'getMissingRecordsMessage', 'has_missing_records' => 'getHasMissingRecords', 'is_verified' => 'getIsVerified', 'domain_name_records' => 'getDomainNameRecords', 'catch_all_inbox_id' => 'getCatchAllInboxId', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt', 'domain_type' => 'getDomainType']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'user_id' => 'uuid', 'domain' => null, 'verification_token' => null, 'dkim_tokens' => null, 'missing_records_message' => null, 'has_missing_records' => null, 'is_verified' => null, 'domain_name_records' => null, 'catch_all_inbox_id' => 'uuid', 'created_at' => 'date-time', 'updated_at' => 'date-time', 'domain_type' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'DomainDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'user_id' => false, 'domain' => false, 'verification_token' => false, 'dkim_tokens' => false, 'missing_records_message' => true, 'has_missing_records' => false, 'is_verified' => false, 'domain_name_records' => false, 'catch_all_inbox_id' => true, 'created_at' => false, 'updated_at' => false, 'domain_type' => 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', 'user_id' => 'string', 'domain' => 'string', 'verification_token' => 'string', 'dkim_tokens' => 'string[]', 'missing_records_message' => 'string', 'has_missing_records' => 'bool', 'is_verified' => 'bool', 'domain_name_records' => '\\MailSlurp\\Models\\DomainNameRecord[]', 'catch_all_inbox_id' => 'string', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime', 'domain_type' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'user_id' => 'setUserId', 'domain' => 'setDomain', 'verification_token' => 'setVerificationToken', 'dkim_tokens' => 'setDkimTokens', 'missing_records_message' => 'setMissingRecordsMessage', 'has_missing_records' => 'setHasMissingRecords', 'is_verified' => 'setIsVerified', 'domain_name_records' => 'setDomainNameRecords', 'catch_all_inbox_id' => 'setCatchAllInboxId', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt', 'domain_type' => 'setDomainType']
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 —getDkimTokens()
Gets dkim_tokens
public
getDkimTokens() : array<string|int, string>
Return values
array<string|int, string> —getDomain()
Gets domain
public
getDomain() : string
Return values
string —getDomainNameRecords()
Gets domain_name_records
public
getDomainNameRecords() : array<string|int, DomainNameRecord>
Return values
array<string|int, DomainNameRecord> —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 —getMissingRecordsMessage()
Gets missing_records_message
public
getMissingRecordsMessage() : string|null
Return values
string|null —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> —getUpdatedAt()
Gets updated_at
public
getUpdatedAt() : DateTime
Return values
DateTime —getUserId()
Gets user_id
public
getUserId() : string
Return values
string —getVerificationToken()
Gets verification_token
public
getVerificationToken() : string
Return values
string —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
-
The optional catch all inbox that will receive emails sent to the domain that cannot be matched.
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setDkimTokens()
Sets dkim_tokens
public
setDkimTokens(array<string|int, string> $dkim_tokens) : self
Parameters
- $dkim_tokens : array<string|int, string>
-
Unique token DKIM tokens
Return values
self —setDomain()
Sets domain
public
setDomain(string $domain) : self
Parameters
- $domain : string
-
Custom domain name
Return values
self —setDomainNameRecords()
Sets domain_name_records
public
setDomainNameRecords(array<string|int, DomainNameRecord> $domain_name_records) : self
Parameters
- $domain_name_records : array<string|int, DomainNameRecord>
-
List of DNS domain name records (C, MX, TXT) etc that you must add to the DNS server associated with your domain provider.
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
-
Whether the domain has missing required records. If true then see the domain in the dashboard app.
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
-
Whether domain has been verified or not. If the domain is not verified after 72 hours there is most likely an issue with the domains DNS records.
Return values
self —setMissingRecordsMessage()
Sets missing_records_message
public
setMissingRecordsMessage(string|null $missing_records_message) : self
Parameters
- $missing_records_message : string|null
-
If the domain is missing records then show which pairs are missing.
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> —setUpdatedAt()
Sets updated_at
public
setUpdatedAt(DateTime $updated_at) : self
Parameters
- $updated_at : DateTime
-
updated_at
Return values
self —setUserId()
Sets user_id
public
setUserId(string $user_id) : self
Parameters
- $user_id : string
-
user_id
Return values
self —setVerificationToken()
Sets verification_token
public
setVerificationToken(string $verification_token) : self
Parameters
- $verification_token : string
-
Verification tokens
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>