CreateDeliverabilitySimulationJobOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
CreateDeliverabilitySimulationJobOptions Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- $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
- getBatchSize() : int|null
- Gets batch_size
- getDelayMs() : int|null
- Gets delay_ms
- getEmail() : CreateDeliverabilitySimulationJobOptionsEmail|null
- Gets email
- getModelName() : string
- The original name of the model.
- getSenderInboxId() : string|null
- Gets sender_inbox_id
- getSenderPhoneId() : string|null
- Gets sender_phone_id
- getSendsPerTarget() : int|null
- Gets sends_per_target
- getSms() : CreateDeliverabilitySimulationJobOptionsSms|null
- Gets sms
- 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
- setBatchSize() : self
- Sets batch_size
- setDelayMs() : self
- Sets delay_ms
- setEmail() : self
- Sets email
- setSenderInboxId() : self
- Sets sender_inbox_id
- setSenderPhoneId() : self
- Sets sender_phone_id
- setSendsPerTarget() : self
- Sets sends_per_target
- setSms() : self
- Sets sms
- 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
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
= ['sender_inbox_id' => 'senderInboxId', 'sender_phone_id' => 'senderPhoneId', 'email' => 'email', 'sms' => 'sms', 'delay_ms' => 'delayMs', 'batch_size' => 'batchSize', 'sends_per_target' => 'sendsPerTarget']
$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
= ['sender_inbox_id' => 'getSenderInboxId', 'sender_phone_id' => 'getSenderPhoneId', 'email' => 'getEmail', 'sms' => 'getSms', 'delay_ms' => 'getDelayMs', 'batch_size' => 'getBatchSize', 'sends_per_target' => 'getSendsPerTarget']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['sender_inbox_id' => 'uuid', 'sender_phone_id' => 'uuid', 'email' => null, 'sms' => null, 'delay_ms' => 'int64', 'batch_size' => 'int32', 'sends_per_target' => 'int64']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'CreateDeliverabilitySimulationJobOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['sender_inbox_id' => true, 'sender_phone_id' => true, 'email' => true, 'sms' => true, 'delay_ms' => true, 'batch_size' => true, 'sends_per_target' => 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
= ['sender_inbox_id' => 'string', 'sender_phone_id' => 'string', 'email' => '\\MailSlurp\\Models\\CreateDeliverabilitySimulationJobOptionsEmail', 'sms' => '\\MailSlurp\\Models\\CreateDeliverabilitySimulationJobOptionsSms', 'delay_ms' => 'int', 'batch_size' => 'int', 'sends_per_target' => 'int']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['sender_inbox_id' => 'setSenderInboxId', 'sender_phone_id' => 'setSenderPhoneId', 'email' => 'setEmail', 'sms' => 'setSms', 'delay_ms' => 'setDelayMs', 'batch_size' => 'setBatchSize', 'sends_per_target' => 'setSendsPerTarget']
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> —getBatchSize()
Gets batch_size
public
getBatchSize() : int|null
Return values
int|null —getDelayMs()
Gets delay_ms
public
getDelayMs() : int|null
Return values
int|null —getEmail()
Gets email
public
getEmail() : CreateDeliverabilitySimulationJobOptionsEmail|null
Return values
CreateDeliverabilitySimulationJobOptionsEmail|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getSenderInboxId()
Gets sender_inbox_id
public
getSenderInboxId() : string|null
Return values
string|null —getSenderPhoneId()
Gets sender_phone_id
public
getSenderPhoneId() : string|null
Return values
string|null —getSendsPerTarget()
Gets sends_per_target
public
getSendsPerTarget() : int|null
Return values
int|null —getSms()
Gets sms
public
getSms() : CreateDeliverabilitySimulationJobOptionsSms|null
Return values
CreateDeliverabilitySimulationJobOptionsSms|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> —setBatchSize()
Sets batch_size
public
setBatchSize(int|null $batch_size) : self
Parameters
- $batch_size : int|null
-
Maximum sends processed per scheduler batch
Return values
self —setDelayMs()
Sets delay_ms
public
setDelayMs(int|null $delay_ms) : self
Parameters
- $delay_ms : int|null
-
Delay between individual sends in milliseconds
Return values
self —setEmail()
Sets email
public
setEmail(CreateDeliverabilitySimulationJobOptionsEmail|null $email) : self
Parameters
- $email : CreateDeliverabilitySimulationJobOptionsEmail|null
-
email
Return values
self —setSenderInboxId()
Sets sender_inbox_id
public
setSenderInboxId(string|null $sender_inbox_id) : self
Parameters
- $sender_inbox_id : string|null
-
Sender inbox ID for INBOX scope tests
Return values
self —setSenderPhoneId()
Sets sender_phone_id
public
setSenderPhoneId(string|null $sender_phone_id) : self
Parameters
- $sender_phone_id : string|null
-
Sender phone ID for PHONE scope tests
Return values
self —setSendsPerTarget()
Sets sends_per_target
public
setSendsPerTarget(int|null $sends_per_target) : self
Parameters
- $sends_per_target : int|null
-
Optional fixed sends per target. If omitted this is derived from test expectations.
Return values
self —setSms()
Sets sms
public
setSms(CreateDeliverabilitySimulationJobOptionsSms|null $sms) : self
Parameters
- $sms : CreateDeliverabilitySimulationJobOptionsSms|null
-
sms
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>