Documentation

WaitForSingleSmsOptions
in package
implements ModelInterface, ArrayAccess, JsonSerializable

WaitForSingleSmsOptions Class Doc Comment

Tags
category

Class

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

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
getDelay()  : int|null
Gets delay
getModelName()  : string
The original name of the model.
getPhoneNumberId()  : string
Gets phone_number_id
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
setDelay()  : self
Sets delay
setPhoneNumberId()  : self
Sets phone_number_id
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 = ['phone_number_id' => 'phoneNumberId', 'timeout' => 'timeout', 'unread_only' => 'unreadOnly', 'before' => 'before', 'since' => 'since', 'sort_direction' => 'sortDirection', 'delay' => 'delay']

$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 = ['phone_number_id' => 'getPhoneNumberId', 'timeout' => 'getTimeout', 'unread_only' => 'getUnreadOnly', 'before' => 'getBefore', 'since' => 'getSince', 'sort_direction' => 'getSortDirection', 'delay' => 'getDelay']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['phone_number_id' => 'uuid', 'timeout' => 'int64', 'unread_only' => null, 'before' => 'date-time', 'since' => 'date-time', 'sort_direction' => null, 'delay' => 'int64']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'WaitForSingleSmsOptions'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['phone_number_id' => false, 'timeout' => false, 'unread_only' => false, 'before' => false, 'since' => false, 'sort_direction' => false, 'delay' => 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 = ['phone_number_id' => 'string', 'timeout' => 'int', 'unread_only' => 'bool', 'before' => '\\DateTime', 'since' => '\\DateTime', 'sort_direction' => 'string', 'delay' => 'int']

$setters

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

protected static array<string|int, string> $setters = ['phone_number_id' => 'setPhoneNumberId', 'timeout' => 'setTimeout', 'unread_only' => 'setUnreadOnly', 'before' => 'setBefore', 'since' => 'setSince', 'sort_direction' => 'setSortDirection', 'delay' => 'setDelay']

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>

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getPhoneNumberId()

Gets phone_number_id

public getPhoneNumberId() : string
Return values
string

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>

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

before

Return values
self

setDelay()

Sets delay

public setDelay(int|null $delay) : self
Parameters
$delay : int|null

delay

Return values
self

setPhoneNumberId()

Sets phone_number_id

public setPhoneNumberId(string $phone_number_id) : self
Parameters
$phone_number_id : string

phone_number_id

Return values
self

setSince()

Sets since

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

since

Return values
self

setSortDirection()

Sets sort_direction

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

sort_direction

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

timeout

Return values
self

setUnreadOnly()

Sets unread_only

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

unread_only

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