WebhookBounceRecipientPayload
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
WebhookBounceRecipientPayload Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- EVENT_NAME_BOUNCE = 'BOUNCE'
- EVENT_NAME_BOUNCE_RECIPIENT = 'BOUNCE_RECIPIENT'
- EVENT_NAME_DELIVERY_STATUS = 'DELIVERY_STATUS'
- EVENT_NAME_EMAIL_OPENED = 'EMAIL_OPENED'
- EVENT_NAME_EMAIL_READ = 'EMAIL_READ'
- EVENT_NAME_EMAIL_RECEIVED = 'EMAIL_RECEIVED'
- EVENT_NAME_NEW_ATTACHMENT = 'NEW_ATTACHMENT'
- EVENT_NAME_NEW_CONTACT = 'NEW_CONTACT'
- EVENT_NAME_NEW_EMAIL = 'NEW_EMAIL'
- EVENT_NAME_NEW_SMS = 'NEW_SMS'
- $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
- getEventName() : string
- Gets event_name
- getEventNameAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getMessageId() : string
- Gets message_id
- getModelName() : string
- The original name of the model.
- getRecipient() : string
- Gets recipient
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getWebhookId() : string
- Gets webhook_id
- getWebhookName() : string|null
- Gets webhook_name
- 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
- setEventName() : self
- Sets event_name
- setMessageId() : self
- Sets message_id
- setRecipient() : self
- Sets recipient
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setWebhookId() : self
- Sets webhook_id
- setWebhookName() : self
- Sets webhook_name
- 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
EVENT_NAME_BOUNCE
public
mixed
EVENT_NAME_BOUNCE
= 'BOUNCE'
EVENT_NAME_BOUNCE_RECIPIENT
public
mixed
EVENT_NAME_BOUNCE_RECIPIENT
= 'BOUNCE_RECIPIENT'
EVENT_NAME_DELIVERY_STATUS
public
mixed
EVENT_NAME_DELIVERY_STATUS
= 'DELIVERY_STATUS'
EVENT_NAME_EMAIL_OPENED
public
mixed
EVENT_NAME_EMAIL_OPENED
= 'EMAIL_OPENED'
EVENT_NAME_EMAIL_READ
public
mixed
EVENT_NAME_EMAIL_READ
= 'EMAIL_READ'
EVENT_NAME_EMAIL_RECEIVED
public
mixed
EVENT_NAME_EMAIL_RECEIVED
= 'EMAIL_RECEIVED'
EVENT_NAME_NEW_ATTACHMENT
public
mixed
EVENT_NAME_NEW_ATTACHMENT
= 'NEW_ATTACHMENT'
EVENT_NAME_NEW_CONTACT
public
mixed
EVENT_NAME_NEW_CONTACT
= 'NEW_CONTACT'
EVENT_NAME_NEW_EMAIL
public
mixed
EVENT_NAME_NEW_EMAIL
= 'NEW_EMAIL'
EVENT_NAME_NEW_SMS
public
mixed
EVENT_NAME_NEW_SMS
= 'NEW_SMS'
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
= ['message_id' => 'messageId', 'webhook_id' => 'webhookId', 'event_name' => 'eventName', 'webhook_name' => 'webhookName', 'recipient' => 'recipient']
$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
= ['message_id' => 'getMessageId', 'webhook_id' => 'getWebhookId', 'event_name' => 'getEventName', 'webhook_name' => 'getWebhookName', 'recipient' => 'getRecipient']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['message_id' => null, 'webhook_id' => 'uuid', 'event_name' => null, 'webhook_name' => null, 'recipient' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'WebhookBounceRecipientPayload'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['message_id' => false, 'webhook_id' => false, 'event_name' => false, 'webhook_name' => true, 'recipient' => 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
= ['message_id' => 'string', 'webhook_id' => 'string', 'event_name' => 'string', 'webhook_name' => 'string', 'recipient' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['message_id' => 'setMessageId', 'webhook_id' => 'setWebhookId', 'event_name' => 'setEventName', 'webhook_name' => 'setWebhookName', 'recipient' => 'setRecipient']
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> —getEventName()
Gets event_name
public
getEventName() : string
Return values
string —getEventNameAllowableValues()
Gets allowable values of the enum
public
getEventNameAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getMessageId()
Gets message_id
public
getMessageId() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRecipient()
Gets recipient
public
getRecipient() : 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> —getWebhookId()
Gets webhook_id
public
getWebhookId() : string
Return values
string —getWebhookName()
Gets webhook_name
public
getWebhookName() : 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> —setEventName()
Sets event_name
public
setEventName(string $event_name) : self
Parameters
- $event_name : string
-
Name of the event type webhook is being triggered for.
Return values
self —setMessageId()
Sets message_id
public
setMessageId(string $message_id) : self
Parameters
- $message_id : string
-
Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
Return values
self —setRecipient()
Sets recipient
public
setRecipient(string $recipient) : self
Parameters
- $recipient : string
-
Email address that caused a bounce. Make note of the address and try not to message it again to preserve your reputation.
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> —setWebhookId()
Sets webhook_id
public
setWebhookId(string $webhook_id) : self
Parameters
- $webhook_id : string
-
ID of webhook entity being triggered
Return values
self —setWebhookName()
Sets webhook_name
public
setWebhookName(string|null $webhook_name) : self
Parameters
- $webhook_name : string|null
-
Name of the webhook being triggered
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>