CreateDeliverabilityTestOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
CreateDeliverabilityTestOptions Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- SCOPE_INBOX = 'INBOX'
- SCOPE_PHONE = 'PHONE'
- $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
- getDescription() : string|null
- Gets description
- getExpectations() : array<string|int, DeliverabilityExpectation>
- Gets expectations
- getMaxDurationSeconds() : int|null
- Gets max_duration_seconds
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getScope() : string
- Gets scope
- getScopeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getSelector() : DeliverabilitySelectorOptions
- Gets selector
- getStartAt() : DateTime|null
- Gets start_at
- getSuccessThresholdPercent() : float|null
- Gets success_threshold_percent
- 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
- setDescription() : self
- Sets description
- setExpectations() : self
- Sets expectations
- setMaxDurationSeconds() : self
- Sets max_duration_seconds
- setName() : self
- Sets name
- setScope() : self
- Sets scope
- setSelector() : self
- Sets selector
- setStartAt() : self
- Sets start_at
- setSuccessThresholdPercent() : self
- Sets success_threshold_percent
- 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
SCOPE_INBOX
public
mixed
SCOPE_INBOX
= 'INBOX'
SCOPE_PHONE
public
mixed
SCOPE_PHONE
= 'PHONE'
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
= ['name' => 'name', 'description' => 'description', 'scope' => 'scope', 'start_at' => 'startAt', 'max_duration_seconds' => 'maxDurationSeconds', 'success_threshold_percent' => 'successThresholdPercent', 'selector' => 'selector', 'expectations' => 'expectations']
$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
= ['name' => 'getName', 'description' => 'getDescription', 'scope' => 'getScope', 'start_at' => 'getStartAt', 'max_duration_seconds' => 'getMaxDurationSeconds', 'success_threshold_percent' => 'getSuccessThresholdPercent', 'selector' => 'getSelector', 'expectations' => 'getExpectations']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['name' => null, 'description' => null, 'scope' => null, 'start_at' => 'date-time', 'max_duration_seconds' => 'int64', 'success_threshold_percent' => 'double', 'selector' => null, 'expectations' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'CreateDeliverabilityTestOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['name' => true, 'description' => true, 'scope' => false, 'start_at' => true, 'max_duration_seconds' => true, 'success_threshold_percent' => true, 'selector' => false, 'expectations' => 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
= ['name' => 'string', 'description' => 'string', 'scope' => 'string', 'start_at' => '\\DateTime', 'max_duration_seconds' => 'int', 'success_threshold_percent' => 'float', 'selector' => '\\MailSlurp\\Models\\DeliverabilitySelectorOptions', 'expectations' => '\\MailSlurp\\Models\\DeliverabilityExpectation[]']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['name' => 'setName', 'description' => 'setDescription', 'scope' => 'setScope', 'start_at' => 'setStartAt', 'max_duration_seconds' => 'setMaxDurationSeconds', 'success_threshold_percent' => 'setSuccessThresholdPercent', 'selector' => 'setSelector', 'expectations' => 'setExpectations']
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> —getDescription()
Gets description
public
getDescription() : string|null
Return values
string|null —getExpectations()
Gets expectations
public
getExpectations() : array<string|int, DeliverabilityExpectation>
Return values
array<string|int, DeliverabilityExpectation> —getMaxDurationSeconds()
Gets max_duration_seconds
public
getMaxDurationSeconds() : int|null
Return values
int|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getScope()
Gets scope
public
getScope() : string
Return values
string —getScopeAllowableValues()
Gets allowable values of the enum
public
getScopeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getSelector()
Gets selector
public
getSelector() : DeliverabilitySelectorOptions
Return values
DeliverabilitySelectorOptions —getStartAt()
Gets start_at
public
getStartAt() : DateTime|null
Return values
DateTime|null —getSuccessThresholdPercent()
Gets success_threshold_percent
public
getSuccessThresholdPercent() : float|null
Return values
float|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> —setDescription()
Sets description
public
setDescription(string|null $description) : self
Parameters
- $description : string|null
-
Optional description
Return values
self —setExpectations()
Sets expectations
public
setExpectations(array<string|int, DeliverabilityExpectation> $expectations) : self
Parameters
- $expectations : array<string|int, DeliverabilityExpectation>
-
One or more expectations to evaluate for each entity
Return values
self —setMaxDurationSeconds()
Sets max_duration_seconds
public
setMaxDurationSeconds(int|null $max_duration_seconds) : self
Parameters
- $max_duration_seconds : int|null
-
Optional timeout in seconds after startAt. If not all entities match before timeout the test transitions to FAILED.
Return values
self —setName()
Sets name
public
setName(string|null $name) : self
Parameters
- $name : string|null
-
Optional name for the test
Return values
self —setScope()
Sets scope
public
setScope(string $scope) : self
Parameters
- $scope : string
-
Entity scope to evaluate
Return values
self —setSelector()
Sets selector
public
setSelector(DeliverabilitySelectorOptions $selector) : self
Parameters
- $selector : DeliverabilitySelectorOptions
-
selector
Return values
self —setStartAt()
Sets start_at
public
setStartAt(DateTime|null $start_at) : self
Parameters
- $start_at : DateTime|null
-
UTC instant when the receive window starts. Defaults to now if omitted.
Return values
self —setSuccessThresholdPercent()
Sets success_threshold_percent
public
setSuccessThresholdPercent(float|null $success_threshold_percent) : self
Parameters
- $success_threshold_percent : float|null
-
Optional acceptable success threshold percentage (0,100]. If set, a timed-out test can complete successfully when matchedEntities/totalEntities reaches this percentage.
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>