SearchInboxesOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
SearchInboxesOptions Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- INBOX_FUNCTION_ALIAS = 'ALIAS'
- INBOX_FUNCTION_CATCH_ALL = 'CATCH_ALL'
- INBOX_FUNCTION_CONNECTOR = 'CONNECTOR'
- INBOX_FUNCTION_THREAD = 'THREAD'
- INBOX_TYPE_HTTP_INBOX = 'HTTP_INBOX'
- INBOX_TYPE_SMTP_INBOX = 'SMTP_INBOX'
- SORT_DIRECTION_ASC = 'ASC'
- SORT_DIRECTION_DESC = 'DESC'
- $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
- getBefore() : DateTime|null
- Gets before
- getDomainId() : string|null
- Gets domain_id
- getFavourite() : bool|null
- Gets favourite
- getInboxFunction() : string|null
- Gets inbox_function
- getInboxFunctionAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getInboxType() : string|null
- Gets inbox_type
- getInboxTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getModelName() : string
- The original name of the model.
- getPageIndex() : int|null
- Gets page_index
- getPageSize() : int|null
- Gets page_size
- getSearch() : string|null
- Gets search
- getSince() : DateTime|null
- Gets since
- getSortDirection() : string|null
- Gets sort_direction
- getSortDirectionAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getTag() : string|null
- Gets tag
- 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
- setBefore() : self
- Sets before
- setDomainId() : self
- Sets domain_id
- setFavourite() : self
- Sets favourite
- setInboxFunction() : self
- Sets inbox_function
- setInboxType() : self
- Sets inbox_type
- setPageIndex() : self
- Sets page_index
- setPageSize() : self
- Sets page_size
- setSearch() : self
- Sets search
- setSince() : self
- Sets since
- setSortDirection() : self
- Sets sort_direction
- setTag() : self
- Sets tag
- 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
INBOX_FUNCTION_ALIAS
public
mixed
INBOX_FUNCTION_ALIAS
= 'ALIAS'
INBOX_FUNCTION_CATCH_ALL
public
mixed
INBOX_FUNCTION_CATCH_ALL
= 'CATCH_ALL'
INBOX_FUNCTION_CONNECTOR
public
mixed
INBOX_FUNCTION_CONNECTOR
= 'CONNECTOR'
INBOX_FUNCTION_THREAD
public
mixed
INBOX_FUNCTION_THREAD
= 'THREAD'
INBOX_TYPE_HTTP_INBOX
public
mixed
INBOX_TYPE_HTTP_INBOX
= 'HTTP_INBOX'
INBOX_TYPE_SMTP_INBOX
public
mixed
INBOX_TYPE_SMTP_INBOX
= 'SMTP_INBOX'
SORT_DIRECTION_ASC
public
mixed
SORT_DIRECTION_ASC
= 'ASC'
SORT_DIRECTION_DESC
public
mixed
SORT_DIRECTION_DESC
= 'DESC'
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
= ['page_index' => 'pageIndex', 'page_size' => 'pageSize', 'sort_direction' => 'sortDirection', 'favourite' => 'favourite', 'search' => 'search', 'tag' => 'tag', 'since' => 'since', 'before' => 'before', 'inbox_type' => 'inboxType', 'inbox_function' => 'inboxFunction', 'domain_id' => 'domainId']
$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
= ['page_index' => 'getPageIndex', 'page_size' => 'getPageSize', 'sort_direction' => 'getSortDirection', 'favourite' => 'getFavourite', 'search' => 'getSearch', 'tag' => 'getTag', 'since' => 'getSince', 'before' => 'getBefore', 'inbox_type' => 'getInboxType', 'inbox_function' => 'getInboxFunction', 'domain_id' => 'getDomainId']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['page_index' => 'int32', 'page_size' => 'int32', 'sort_direction' => null, 'favourite' => null, 'search' => null, 'tag' => null, 'since' => 'date-time', 'before' => 'date-time', 'inbox_type' => null, 'inbox_function' => null, 'domain_id' => 'uuid']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'SearchInboxesOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['page_index' => true, 'page_size' => true, 'sort_direction' => true, 'favourite' => true, 'search' => true, 'tag' => true, 'since' => true, 'before' => true, 'inbox_type' => true, 'inbox_function' => true, 'domain_id' => true]
$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
= ['page_index' => 'int', 'page_size' => 'int', 'sort_direction' => 'string', 'favourite' => 'bool', 'search' => 'string', 'tag' => 'string', 'since' => '\\DateTime', 'before' => '\\DateTime', 'inbox_type' => 'string', 'inbox_function' => 'string', 'domain_id' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['page_index' => 'setPageIndex', 'page_size' => 'setPageSize', 'sort_direction' => 'setSortDirection', 'favourite' => 'setFavourite', 'search' => 'setSearch', 'tag' => 'setTag', 'since' => 'setSince', 'before' => 'setBefore', 'inbox_type' => 'setInboxType', 'inbox_function' => 'setInboxFunction', 'domain_id' => 'setDomainId']
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> —getBefore()
Gets before
public
getBefore() : DateTime|null
Return values
DateTime|null —getDomainId()
Gets domain_id
public
getDomainId() : string|null
Return values
string|null —getFavourite()
Gets favourite
public
getFavourite() : bool|null
Return values
bool|null —getInboxFunction()
Gets inbox_function
public
getInboxFunction() : string|null
Return values
string|null —getInboxFunctionAllowableValues()
Gets allowable values of the enum
public
getInboxFunctionAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getInboxType()
Gets inbox_type
public
getInboxType() : string|null
Return values
string|null —getInboxTypeAllowableValues()
Gets allowable values of the enum
public
getInboxTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPageIndex()
Gets page_index
public
getPageIndex() : int|null
Return values
int|null —getPageSize()
Gets page_size
public
getPageSize() : int|null
Return values
int|null —getSearch()
Gets search
public
getSearch() : string|null
Return values
string|null —getSince()
Gets since
public
getSince() : DateTime|null
Return values
DateTime|null —getSortDirection()
Gets sort_direction
public
getSortDirection() : string|null
Return values
string|null —getSortDirectionAllowableValues()
Gets allowable values of the enum
public
getSortDirectionAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getTag()
Gets tag
public
getTag() : string|null
Return values
string|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> —setBefore()
Sets before
public
setBefore(DateTime|null $before) : self
Parameters
- $before : DateTime|null
-
Optional filter by created before given date time
Return values
self —setDomainId()
Sets domain_id
public
setDomainId(string|null $domain_id) : self
Parameters
- $domain_id : string|null
-
Optional domain ID filter
Return values
self —setFavourite()
Sets favourite
public
setFavourite(bool|null $favourite) : self
Parameters
- $favourite : bool|null
-
Optionally filter results for favourites only
Return values
self —setInboxFunction()
Sets inbox_function
public
setInboxFunction(string|null $inbox_function) : self
Parameters
- $inbox_function : string|null
-
Optional filter by inbox function
Return values
self —setInboxType()
Sets inbox_type
public
setInboxType(string|null $inbox_type) : self
Parameters
- $inbox_type : string|null
-
Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).
Return values
self —setPageIndex()
Sets page_index
public
setPageIndex(int|null $page_index) : self
Parameters
- $page_index : int|null
-
Optional page index in list pagination
Return values
self —setPageSize()
Sets page_size
public
setPageSize(int|null $page_size) : self
Parameters
- $page_size : int|null
-
Optional page size in list pagination
Return values
self —setSearch()
Sets search
public
setSearch(string|null $search) : self
Parameters
- $search : string|null
-
Optionally filter by search words partial matching ID, tags, name, and email address
Return values
self —setSince()
Sets since
public
setSince(DateTime|null $since) : self
Parameters
- $since : DateTime|null
-
Optional filter by created after given date time
Return values
self —setSortDirection()
Sets sort_direction
public
setSortDirection(string|null $sort_direction) : self
Parameters
- $sort_direction : string|null
-
Optional createdAt sort direction ASC or DESC
Return values
self —setTag()
Sets tag
public
setTag(string|null $tag) : self
Parameters
- $tag : string|null
-
Optionally filter by tags. Will return inboxes that include given tags
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>