CheckCampaignProbeOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
CheckCampaignProbeOptions 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
- getCaptchaToken() : string|null
- Gets captcha_token
- getFromAddress() : string|null
- Gets from_address
- getHtmlBody() : string|null
- Gets html_body
- getMessageId() : string|null
- Gets message_id
- getModelName() : string
- The original name of the model.
- getRecipient() : string|null
- Gets recipient
- getSubject() : string|null
- Gets subject
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTextBody() : string|null
- Gets text_body
- 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
- setCaptchaToken() : self
- Sets captcha_token
- setFromAddress() : self
- Sets from_address
- setHtmlBody() : self
- Sets html_body
- setMessageId() : self
- Sets message_id
- setRecipient() : self
- Sets recipient
- setSubject() : self
- Sets subject
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTextBody() : self
- Sets text_body
- 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
= ['from_address' => 'fromAddress', 'subject' => 'subject', 'recipient' => 'recipient', 'message_id' => 'messageId', 'html_body' => 'htmlBody', 'text_body' => 'textBody', 'captcha_token' => 'captchaToken']
$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
= ['from_address' => 'getFromAddress', 'subject' => 'getSubject', 'recipient' => 'getRecipient', 'message_id' => 'getMessageId', 'html_body' => 'getHtmlBody', 'text_body' => 'getTextBody', 'captcha_token' => 'getCaptchaToken']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['from_address' => null, 'subject' => null, 'recipient' => null, 'message_id' => null, 'html_body' => null, 'text_body' => null, 'captcha_token' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'CheckCampaignProbeOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['from_address' => true, 'subject' => true, 'recipient' => true, 'message_id' => true, 'html_body' => true, 'text_body' => true, 'captcha_token' => 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
= ['from_address' => 'string', 'subject' => 'string', 'recipient' => 'string', 'message_id' => 'string', 'html_body' => 'string', 'text_body' => 'string', 'captcha_token' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['from_address' => 'setFromAddress', 'subject' => 'setSubject', 'recipient' => 'setRecipient', 'message_id' => 'setMessageId', 'html_body' => 'setHtmlBody', 'text_body' => 'setTextBody', 'captcha_token' => 'setCaptchaToken']
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> —getCaptchaToken()
Gets captcha_token
public
getCaptchaToken() : string|null
Return values
string|null —getFromAddress()
Gets from_address
public
getFromAddress() : string|null
Return values
string|null —getHtmlBody()
Gets html_body
public
getHtmlBody() : string|null
Return values
string|null —getMessageId()
Gets message_id
public
getMessageId() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRecipient()
Gets recipient
public
getRecipient() : string|null
Return values
string|null —getSubject()
Gets subject
public
getSubject() : string|null
Return values
string|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> —getTextBody()
Gets text_body
public
getTextBody() : 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 —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> —setCaptchaToken()
Sets captcha_token
public
setCaptchaToken(string|null $captcha_token) : self
Parameters
- $captcha_token : string|null
-
Optional captcha token when captcha protection is enabled
Return values
self —setFromAddress()
Sets from_address
public
setFromAddress(string|null $from_address) : self
Parameters
- $from_address : string|null
-
Optional sender email address
Return values
self —setHtmlBody()
Sets html_body
public
setHtmlBody(string|null $html_body) : self
Parameters
- $html_body : string|null
-
HTML body content to analyze
Return values
self —setMessageId()
Sets message_id
public
setMessageId(string|null $message_id) : self
Parameters
- $message_id : string|null
-
Optional caller supplied message id
Return values
self —setRecipient()
Sets recipient
public
setRecipient(string|null $recipient) : self
Parameters
- $recipient : string|null
-
Optional recipient email address for context
Return values
self —setSubject()
Sets subject
public
setSubject(string|null $subject) : self
Parameters
- $subject : string|null
-
Optional message subject
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> —setTextBody()
Sets text_body
public
setTextBody(string|null $text_body) : self
Parameters
- $text_body : string|null
-
Text body content to analyze when HTML is absent
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>