Documentation

WebhookBouncePayload
in package
implements ModelInterface, ArrayAccess, JsonSerializable

WebhookBouncePayload Class Doc Comment

Tags
category

Class

description

BOUNCE webhook payload. Sent to your webhook url endpoint via HTTP POST when an email bounced or was rejected by a recipient. Save the recipients to a ban list on your server and avoid emailing them again. It is recommended you also listen to the BOUNCE_RECIPIENT payload.

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

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
getBounceId()  : string
Gets bounce_id
getBounceRecipients()  : array<string|int, string>|null
Gets bounce_recipients
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.
getSender()  : string
Gets sender
getSentToRecipients()  : array<string|int, string>|null
Gets sent_to_recipients
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
setBounceId()  : self
Sets bounce_id
setBounceRecipients()  : self
Sets bounce_recipients
setEventName()  : self
Sets event_name
setMessageId()  : self
Sets message_id
setSender()  : self
Sets sender
setSentToRecipients()  : self
Sets sent_to_recipients
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

EVENT_NAME_BOUNCE_RECIPIENT

public mixed EVENT_NAME_BOUNCE_RECIPIENT = 'BOUNCE_RECIPIENT'

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', 'bounce_id' => 'bounceId', 'sent_to_recipients' => 'sentToRecipients', 'sender' => 'sender', 'bounce_recipients' => 'bounceRecipients']

$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', 'bounce_id' => 'getBounceId', 'sent_to_recipients' => 'getSentToRecipients', 'sender' => 'getSender', 'bounce_recipients' => 'getBounceRecipients']

$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, 'bounce_id' => 'uuid', 'sent_to_recipients' => null, 'sender' => null, 'bounce_recipients' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'WebhookBouncePayload'

$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, 'bounce_id' => false, 'sent_to_recipients' => true, 'sender' => false, 'bounce_recipients' => 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 = ['message_id' => 'string', 'webhook_id' => 'string', 'event_name' => 'string', 'webhook_name' => 'string', 'bounce_id' => 'string', 'sent_to_recipients' => 'string[]', 'sender' => 'string', 'bounce_recipients' => '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', 'bounce_id' => 'setBounceId', 'sent_to_recipients' => 'setSentToRecipients', 'sender' => 'setSender', 'bounce_recipients' => 'setBounceRecipients']

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> —

getBounceRecipients()

Gets bounce_recipients

public getBounceRecipients() : array<string|int, string>|null
Return values
array<string|int, string>|null —

getEventNameAllowableValues()

Gets allowable values of the enum

public getEventNameAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getSentToRecipients()

Gets sent_to_recipients

public getSentToRecipients() : array<string|int, string>|null
Return values
array<string|int, 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> —

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 —

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> —

setBounceId()

Sets bounce_id

public setBounceId(string $bounce_id) : self
Parameters
$bounce_id : string

ID of the bounce email record. Use the ID with the bounce controller to view more information

Return values
self —

setBounceRecipients()

Sets bounce_recipients

public setBounceRecipients(array<string|int, string>|null $bounce_recipients) : self
Parameters
$bounce_recipients : array<string|int, string>|null

Email addresses that resulted in a bounce or email being rejected. Please save these recipients and avoid emailing them in the future to maintain your reputation.

Return values
self —

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 —

setSender()

Sets sender

public setSender(string $sender) : self
Parameters
$sender : string

Sender causing bounce

Return values
self —

setSentToRecipients()

Sets sent_to_recipients

public setSentToRecipients(array<string|int, string>|null $sent_to_recipients) : self
Parameters
$sent_to_recipients : array<string|int, string>|null

Email sent to recipients

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>
Return values
void —

Search results