Documentation

AIMessageExpectation
in package
implements ModelInterface, ArrayAccess, JsonSerializable

AIMessageExpectation Class Doc Comment

Tags
category

Class

description

One independently tracked delivery expectation. By default, each expectation must select a distinct message.

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
EXTRACTION_PRESET_OTP_CODE  = 'OTP_CODE'
$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
getAssertions()  : array<string|int, AIMessageAssertion>
Gets assertions
getEmailMatchOptions()  : AIMessageExpectationEmailMatchOptions|null
Gets email_match_options
getExtractionPreset()  : string|null
Gets extraction_preset
getExtractionPresetAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getId()  : string
Gets id
getInstructions()  : string|null
Gets instructions
getMatch()  : WaitForConditionsAi|null
Gets match
getModelName()  : string
The original name of the model.
getOutputSchema()  : AIMessageExpectationOutputSchema|null
Gets output_schema
getScope()  : AIMessageScope
Gets scope
getSmsMatchOptions()  : AIMessageExpectationSmsMatchOptions|null
Gets sms_match_options
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTransformId()  : string|null
Gets transform_id
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
setAssertions()  : self
Sets assertions
setEmailMatchOptions()  : self
Sets email_match_options
setExtractionPreset()  : self
Sets extraction_preset
setId()  : self
Sets id
setInstructions()  : self
Sets instructions
setMatch()  : self
Sets match
setOutputSchema()  : self
Sets output_schema
setScope()  : self
Sets scope
setSmsMatchOptions()  : self
Sets sms_match_options
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTransformId()  : self
Sets transform_id
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 = ['id' => 'id', 'scope' => 'scope', 'match' => 'match', 'email_match_options' => 'emailMatchOptions', 'sms_match_options' => 'smsMatchOptions', 'assertions' => 'assertions', 'output_schema' => 'outputSchema', 'transform_id' => 'transformId', 'instructions' => 'instructions', 'extraction_preset' => 'extractionPreset']

$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', 'scope' => 'getScope', 'match' => 'getMatch', 'email_match_options' => 'getEmailMatchOptions', 'sms_match_options' => 'getSmsMatchOptions', 'assertions' => 'getAssertions', 'output_schema' => 'getOutputSchema', 'transform_id' => 'getTransformId', 'instructions' => 'getInstructions', 'extraction_preset' => 'getExtractionPreset']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['id' => null, 'scope' => null, 'match' => null, 'email_match_options' => null, 'sms_match_options' => null, 'assertions' => null, 'output_schema' => null, 'transform_id' => 'uuid', 'instructions' => null, 'extraction_preset' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'AIMessageExpectation'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['id' => false, 'scope' => false, 'match' => true, 'email_match_options' => true, 'sms_match_options' => true, 'assertions' => false, 'output_schema' => true, 'transform_id' => true, 'instructions' => true, 'extraction_preset' => 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 = ['id' => 'string', 'scope' => '\\MailSlurp\\Models\\AIMessageScope', 'match' => '\\MailSlurp\\Models\\WaitForConditionsAi', 'email_match_options' => '\\MailSlurp\\Models\\AIMessageExpectationEmailMatchOptions', 'sms_match_options' => '\\MailSlurp\\Models\\AIMessageExpectationSmsMatchOptions', 'assertions' => '\\MailSlurp\\Models\\AIMessageAssertion[]', 'output_schema' => '\\MailSlurp\\Models\\AIMessageExpectationOutputSchema', 'transform_id' => 'string', 'instructions' => 'string', 'extraction_preset' => 'string']

$setters

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

protected static array<string|int, string> $setters = ['id' => 'setId', 'scope' => 'setScope', 'match' => 'setMatch', 'email_match_options' => 'setEmailMatchOptions', 'sms_match_options' => 'setSmsMatchOptions', 'assertions' => 'setAssertions', 'output_schema' => 'setOutputSchema', 'transform_id' => 'setTransformId', 'instructions' => 'setInstructions', 'extraction_preset' => 'setExtractionPreset']

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

getExtractionPreset()

Gets extraction_preset

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

getExtractionPresetAllowableValues()

Gets allowable values of the enum

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

getInstructions()

Gets instructions

public getInstructions() : 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> —

getTransformId()

Gets transform_id

public getTransformId() : string|null
Return values
string|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> —

setExtractionPreset()

Sets extraction_preset

public setExtractionPreset(string|null $extraction_preset) : self
Parameters
$extraction_preset : string|null

Built-in extraction schema. OTP_CODE returns data.code as a verbatim string, preserving leading zeros and letter case. Missing or equally eligible codes are INCONCLUSIVE.

Return values
self —

setId()

Sets id

public setId(string $id) : self
Parameters
$id : string

id

Return values
self —

setInstructions()

Sets instructions

public setInstructions(string|null $instructions) : self
Parameters
$instructions : string|null

instructions

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

setTransformId()

Sets transform_id

public setTransformId(string|null $transform_id) : self
Parameters
$transform_id : string|null

transform_id

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