Documentation

WaitForConditions
in package
implements ModelInterface, ArrayAccess, JsonSerializable

WaitForConditions Class Doc Comment

Tags
category

Class

description

Conditions to apply to emails that you are waiting for

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Table of Contents

COUNT_TYPE_ATLEAST  = 'ATLEAST'
COUNT_TYPE_EXACTLY  = 'EXACTLY'
DISCRIMINATOR  = null
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
getCount()  : int|null
Gets count
getCountType()  : string|null
Gets count_type
getCountTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getDelayTimeout()  : int|null
Gets delay_timeout
getInboxId()  : string
Gets inbox_id
getMatches()  : array<string|int, MatchOption>|null
Gets matches
getModelName()  : string
The original name of the model.
getSince()  : DateTime|null
Gets since
getSortDirection()  : string|null
Gets sort_direction
getSortDirectionAllowableValues()  : 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)
getTimeout()  : int
Gets timeout
getUnreadOnly()  : bool|null
Gets unread_only
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
setCount()  : self
Sets count
setCountType()  : self
Sets count_type
setDelayTimeout()  : self
Sets delay_timeout
setInboxId()  : self
Sets inbox_id
setMatches()  : self
Sets matches
setSince()  : self
Sets since
setSortDirection()  : self
Sets sort_direction
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTimeout()  : self
Sets timeout
setUnreadOnly()  : self
Sets unread_only
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

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 = ['inbox_id' => 'inboxId', 'count' => 'count', 'delay_timeout' => 'delayTimeout', 'timeout' => 'timeout', 'unread_only' => 'unreadOnly', 'count_type' => 'countType', 'matches' => 'matches', 'sort_direction' => 'sortDirection', 'since' => 'since', 'before' => 'before']

$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 = ['inbox_id' => 'getInboxId', 'count' => 'getCount', 'delay_timeout' => 'getDelayTimeout', 'timeout' => 'getTimeout', 'unread_only' => 'getUnreadOnly', 'count_type' => 'getCountType', 'matches' => 'getMatches', 'sort_direction' => 'getSortDirection', 'since' => 'getSince', 'before' => 'getBefore']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $openAPIFormats = ['inbox_id' => 'uuid', 'count' => 'int32', 'delay_timeout' => 'int64', 'timeout' => 'int64', 'unread_only' => null, 'count_type' => null, 'matches' => null, 'sort_direction' => null, 'since' => 'date-time', 'before' => 'date-time']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'WaitForConditions'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['inbox_id' => false, 'count' => true, 'delay_timeout' => true, 'timeout' => false, 'unread_only' => true, 'count_type' => true, 'matches' => true, 'sort_direction' => true, 'since' => true, 'before' => 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 = ['inbox_id' => 'string', 'count' => 'int', 'delay_timeout' => 'int', 'timeout' => 'int', 'unread_only' => 'bool', 'count_type' => 'string', 'matches' => '\\MailSlurp\\Models\\MatchOption[]', 'sort_direction' => 'string', 'since' => '\\DateTime', 'before' => '\\DateTime']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['inbox_id' => 'setInboxId', 'count' => 'setCount', 'delay_timeout' => 'setDelayTimeout', 'timeout' => 'setTimeout', 'unread_only' => 'setUnreadOnly', 'count_type' => 'setCountType', 'matches' => 'setMatches', 'sort_direction' => 'setSortDirection', 'since' => 'setSince', 'before' => 'setBefore']

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 —

getCount()

Gets count

public getCount() : int|null
Return values
int|null —

getCountType()

Gets count_type

public getCountType() : string|null
Return values
string|null —

getCountTypeAllowableValues()

Gets allowable values of the enum

public getCountTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getDelayTimeout()

Gets delay_timeout

public getDelayTimeout() : int|null
Return values
int|null —

getInboxId()

Gets inbox_id

public getInboxId() : string
Return values
string —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

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> —

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getUnreadOnly()

Gets unread_only

public getUnreadOnly() : bool|null
Return values
bool|null —

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 —

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

ISO Date Time latest time of email to consider. Filter for matching emails that were received before this date

Return values
self —

setCount()

Sets count

public setCount(int|null $count) : self
Parameters
$count : int|null

Number of results that should match conditions. Either exactly or at least this amount based on the countType. If count condition is not met and the timeout has not been reached the waitFor method will retry the operation.

Return values
self —

setCountType()

Sets count_type

public setCountType(string|null $count_type) : self
Parameters
$count_type : string|null

How result size should be compared with the expected size. Exactly or at-least matching result?

Return values
self —

setDelayTimeout()

Sets delay_timeout

public setDelayTimeout(int|null $delay_timeout) : self
Parameters
$delay_timeout : int|null

Max time in milliseconds to wait between retries if a timeout is specified.

Return values
self —

setInboxId()

Sets inbox_id

public setInboxId(string $inbox_id) : self
Parameters
$inbox_id : string

ID of inbox to search within and apply conditions to. Essentially filtering the emails found to give a count.

Return values
self —

setMatches()

Sets matches

public setMatches(array<string|int, MatchOption>|null $matches) : self
Parameters
$matches : array<string|int, MatchOption>|null

Conditions that should be matched for an email to qualify for results. Each condition will be applied in order to each email within an inbox to filter a result list of matching emails you are waiting for.

Return values
self —

setSince()

Sets since

public setSince(DateTime|null $since) : self
Parameters
$since : DateTime|null

ISO Date Time earliest time of email to consider. Filter for matching emails that were received after this date

Return values
self —

setSortDirection()

Sets sort_direction

public setSortDirection(string|null $sort_direction) : self
Parameters
$sort_direction : string|null

Direction to sort matching emails by created time

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> —

setTimeout()

Sets timeout

public setTimeout(int $timeout) : self
Parameters
$timeout : int

Max time in milliseconds to retry the waitFor operation until conditions are met.

Return values
self —

setUnreadOnly()

Sets unread_only

public setUnreadOnly(bool|null $unread_only) : self
Parameters
$unread_only : bool|null

Apply conditions only to unread emails. All emails begin with read=false. An email is marked read=true when an EmailDto representation of it has been returned to the user at least once. For example you have called getEmail or waitForLatestEmail etc., or you have viewed the email in the dashboard.

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>
Return values
void —

Search results