EmailBlacklistListingResult
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
EmailBlacklistListingResult Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- STATUS_ERROR = 'ERROR'
- STATUS_LISTED = 'LISTED'
- STATUS_NOT_CHECKED = 'NOT_CHECKED'
- STATUS_NOT_LISTED = 'NOT_LISTED'
- $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
- getErrorMessage() : string|null
- Gets error_message
- getListed() : bool
- Gets listed
- getModelName() : string
- The original name of the model.
- getProvider() : string
- Gets provider
- getResponseCodes() : array<string|int, string>
- Gets response_codes
- getResponseMessages() : array<string|int, string>
- Gets response_messages
- getStatus() : string
- Gets status
- getStatusAllowableValues() : 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)
- getZone() : string
- Gets zone
- 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
- setErrorMessage() : self
- Sets error_message
- setListed() : self
- Sets listed
- setProvider() : self
- Sets provider
- setResponseCodes() : self
- Sets response_codes
- setResponseMessages() : self
- Sets response_messages
- setStatus() : self
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setZone() : self
- Sets zone
- 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
STATUS_ERROR
public
mixed
STATUS_ERROR
= 'ERROR'
STATUS_LISTED
public
mixed
STATUS_LISTED
= 'LISTED'
STATUS_NOT_CHECKED
public
mixed
STATUS_NOT_CHECKED
= 'NOT_CHECKED'
STATUS_NOT_LISTED
public
mixed
STATUS_NOT_LISTED
= 'NOT_LISTED'
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
= ['zone' => 'zone', 'listed' => 'listed', 'response_codes' => 'responseCodes', 'response_messages' => 'responseMessages', 'status' => 'status', 'error_message' => 'errorMessage', 'provider' => 'provider']
$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
= ['zone' => 'getZone', 'listed' => 'getListed', 'response_codes' => 'getResponseCodes', 'response_messages' => 'getResponseMessages', 'status' => 'getStatus', 'error_message' => 'getErrorMessage', 'provider' => 'getProvider']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['zone' => null, 'listed' => null, 'response_codes' => null, 'response_messages' => null, 'status' => null, 'error_message' => null, 'provider' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'EmailBlacklistListingResult'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['zone' => false, 'listed' => false, 'response_codes' => false, 'response_messages' => false, 'status' => false, 'error_message' => true, 'provider' => 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
= ['zone' => 'string', 'listed' => 'bool', 'response_codes' => 'string[]', 'response_messages' => 'string[]', 'status' => 'string', 'error_message' => 'string', 'provider' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['zone' => 'setZone', 'listed' => 'setListed', 'response_codes' => 'setResponseCodes', 'response_messages' => 'setResponseMessages', 'status' => 'setStatus', 'error_message' => 'setErrorMessage', 'provider' => 'setProvider']
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> —getErrorMessage()
Gets error_message
public
getErrorMessage() : string|null
Return values
string|null —getListed()
Gets listed
public
getListed() : bool
Return values
bool —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getProvider()
Gets provider
public
getProvider() : string
Return values
string —getResponseCodes()
Gets response_codes
public
getResponseCodes() : array<string|int, string>
Return values
array<string|int, string> —getResponseMessages()
Gets response_messages
public
getResponseMessages() : array<string|int, string>
Return values
array<string|int, string> —getStatus()
Gets status
public
getStatus() : string
Return values
string —getStatusAllowableValues()
Gets allowable values of the enum
public
getStatusAllowableValues() : 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> —getZone()
Gets zone
public
getZone() : string
Return values
string —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> —setErrorMessage()
Sets error_message
public
setErrorMessage(string|null $error_message) : self
Parameters
- $error_message : string|null
-
error_message
Return values
self —setListed()
Sets listed
public
setListed(bool $listed) : self
Parameters
- $listed : bool
-
listed
Return values
self —setProvider()
Sets provider
public
setProvider(string $provider) : self
Parameters
- $provider : string
-
provider
Return values
self —setResponseCodes()
Sets response_codes
public
setResponseCodes(array<string|int, string> $response_codes) : self
Parameters
- $response_codes : array<string|int, string>
-
response_codes
Return values
self —setResponseMessages()
Sets response_messages
public
setResponseMessages(array<string|int, string> $response_messages) : self
Parameters
- $response_messages : array<string|int, string>
-
response_messages
Return values
self —setStatus()
Sets status
public
setStatus(string $status) : self
Parameters
- $status : string
-
status
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> —setZone()
Sets zone
public
setZone(string $zone) : self
Parameters
- $zone : string
-
zone
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>