InboxReplierDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
InboxReplierDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- FIELD_ATTACHMENTS = 'ATTACHMENTS'
- FIELD_RECIPIENTS = 'RECIPIENTS'
- FIELD_SENDER = 'SENDER'
- FIELD_SUBJECT = 'SUBJECT'
- $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
- getCharset() : string|null
- Gets charset
- getCreatedAt() : DateTime
- Gets created_at
- getField() : string
- Gets field
- getFieldAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getFrom() : string|null
- Gets from
- getId() : string
- Gets id
- getIgnoreReplyTo() : bool
- Gets ignore_reply_to
- getInboxId() : string|null
- Gets inbox_id
- getIsHtml() : bool
- Gets is_html
- getMatch() : string
- Gets match
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getReplyTo() : string|null
- Gets reply_to
- getSubject() : string|null
- Gets subject
- getTemplateId() : string|null
- Gets template_id
- getTemplateVariables() : array<string, object>|null
- Gets template_variables
- 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
- setCharset() : self
- Sets charset
- setCreatedAt() : self
- Sets created_at
- setField() : self
- Sets field
- setFrom() : self
- Sets from
- setId() : self
- Sets id
- setIgnoreReplyTo() : self
- Sets ignore_reply_to
- setInboxId() : self
- Sets inbox_id
- setIsHtml() : self
- Sets is_html
- setMatch() : self
- Sets match
- setName() : self
- Sets name
- setReplyTo() : self
- Sets reply_to
- setSubject() : self
- Sets subject
- setTemplateId() : self
- Sets template_id
- setTemplateVariables() : self
- Sets template_variables
- 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
FIELD_ATTACHMENTS
public
mixed
FIELD_ATTACHMENTS
= 'ATTACHMENTS'
FIELD_RECIPIENTS
public
mixed
FIELD_RECIPIENTS
= 'RECIPIENTS'
FIELD_SENDER
public
mixed
FIELD_SENDER
= 'SENDER'
FIELD_SUBJECT
public
mixed
FIELD_SUBJECT
= 'SUBJECT'
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', 'inbox_id' => 'inboxId', 'name' => 'name', 'field' => 'field', 'match' => 'match', 'reply_to' => 'replyTo', 'subject' => 'subject', 'from' => 'from', 'charset' => 'charset', 'is_html' => 'isHTML', 'template_id' => 'templateId', 'template_variables' => 'templateVariables', 'ignore_reply_to' => 'ignoreReplyTo', 'created_at' => 'createdAt']
$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', 'inbox_id' => 'getInboxId', 'name' => 'getName', 'field' => 'getField', 'match' => 'getMatch', 'reply_to' => 'getReplyTo', 'subject' => 'getSubject', 'from' => 'getFrom', 'charset' => 'getCharset', 'is_html' => 'getIsHtml', 'template_id' => 'getTemplateId', 'template_variables' => 'getTemplateVariables', 'ignore_reply_to' => 'getIgnoreReplyTo', 'created_at' => 'getCreatedAt']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'inbox_id' => 'uuid', 'name' => null, 'field' => null, 'match' => null, 'reply_to' => null, 'subject' => null, 'from' => null, 'charset' => null, 'is_html' => null, 'template_id' => 'uuid', 'template_variables' => null, 'ignore_reply_to' => null, 'created_at' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'InboxReplierDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'inbox_id' => true, 'name' => true, 'field' => false, 'match' => false, 'reply_to' => true, 'subject' => true, 'from' => true, 'charset' => true, 'is_html' => false, 'template_id' => true, 'template_variables' => true, 'ignore_reply_to' => false, 'created_at' => 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', 'inbox_id' => 'string', 'name' => 'string', 'field' => 'string', 'match' => 'string', 'reply_to' => 'string', 'subject' => 'string', 'from' => 'string', 'charset' => 'string', 'is_html' => 'bool', 'template_id' => 'string', 'template_variables' => 'array<string,object>', 'ignore_reply_to' => 'bool', 'created_at' => '\\DateTime']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'inbox_id' => 'setInboxId', 'name' => 'setName', 'field' => 'setField', 'match' => 'setMatch', 'reply_to' => 'setReplyTo', 'subject' => 'setSubject', 'from' => 'setFrom', 'charset' => 'setCharset', 'is_html' => 'setIsHtml', 'template_id' => 'setTemplateId', 'template_variables' => 'setTemplateVariables', 'ignore_reply_to' => 'setIgnoreReplyTo', 'created_at' => 'setCreatedAt']
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> —getCharset()
Gets charset
public
getCharset() : string|null
Return values
string|null —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getField()
Gets field
public
getField() : string
Return values
string —getFieldAllowableValues()
Gets allowable values of the enum
public
getFieldAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getFrom()
Gets from
public
getFrom() : string|null
Return values
string|null —getId()
Gets id
public
getId() : string
Return values
string —getIgnoreReplyTo()
Gets ignore_reply_to
public
getIgnoreReplyTo() : bool
Return values
bool —getInboxId()
Gets inbox_id
public
getInboxId() : string|null
Return values
string|null —getIsHtml()
Gets is_html
public
getIsHtml() : bool
Return values
bool —getMatch()
Gets match
public
getMatch() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getReplyTo()
Gets reply_to
public
getReplyTo() : string|null
Return values
string|null —getSubject()
Gets subject
public
getSubject() : string|null
Return values
string|null —getTemplateId()
Gets template_id
public
getTemplateId() : string|null
Return values
string|null —getTemplateVariables()
Gets template_variables
public
getTemplateVariables() : array<string, object>|null
Return values
array<string, object>|null —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> —setCharset()
Sets charset
public
setCharset(string|null $charset) : self
Parameters
- $charset : string|null
-
charset
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setField()
Sets field
public
setField(string $field) : self
Parameters
- $field : string
-
field
Return values
self —setFrom()
Sets from
public
setFrom(string|null $from) : self
Parameters
- $from : string|null
-
from
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setIgnoreReplyTo()
Sets ignore_reply_to
public
setIgnoreReplyTo(bool $ignore_reply_to) : self
Parameters
- $ignore_reply_to : bool
-
ignore_reply_to
Return values
self —setInboxId()
Sets inbox_id
public
setInboxId(string|null $inbox_id) : self
Parameters
- $inbox_id : string|null
-
inbox_id
Return values
self —setIsHtml()
Sets is_html
public
setIsHtml(bool $is_html) : self
Parameters
- $is_html : bool
-
is_html
Return values
self —setMatch()
Sets match
public
setMatch(string $match) : self
Parameters
- $match : string
-
match
Return values
self —setName()
Sets name
public
setName(string|null $name) : self
Parameters
- $name : string|null
-
name
Return values
self —setReplyTo()
Sets reply_to
public
setReplyTo(string|null $reply_to) : self
Parameters
- $reply_to : string|null
-
reply_to
Return values
self —setSubject()
Sets subject
public
setSubject(string|null $subject) : self
Parameters
- $subject : string|null
-
subject
Return values
self —setTemplateId()
Sets template_id
public
setTemplateId(string|null $template_id) : self
Parameters
- $template_id : string|null
-
template_id
Return values
self —setTemplateVariables()
Sets template_variables
public
setTemplateVariables(array<string, object>|null $template_variables) : self
Parameters
- $template_variables : array<string, object>|null
-
template_variables
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>