WebhookResultDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
WebhookResultDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- HTTP_METHOD_DELETE = 'DELETE'
- HTTP_METHOD_GET = 'GET'
- HTTP_METHOD_HEAD = 'HEAD'
- HTTP_METHOD_OPTIONS = 'OPTIONS'
- HTTP_METHOD_PATCH = 'PATCH'
- HTTP_METHOD_POST = 'POST'
- HTTP_METHOD_PUT = 'PUT'
- HTTP_METHOD_TRACE = 'TRACE'
- RESULT_TYPE_BAD_RESPONSE = 'BAD_RESPONSE'
- RESULT_TYPE_EXCEPTION = 'EXCEPTION'
- RESULT_TYPE_REDRIVEN = 'REDRIVEN'
- RESULT_TYPE_SUCCESS = 'SUCCESS'
- WEBHOOK_EVENT_BOUNCE = 'BOUNCE'
- WEBHOOK_EVENT_BOUNCE_RECIPIENT = 'BOUNCE_RECIPIENT'
- WEBHOOK_EVENT_DELIVERY_STATUS = 'DELIVERY_STATUS'
- WEBHOOK_EVENT_EMAIL_OPENED = 'EMAIL_OPENED'
- WEBHOOK_EVENT_EMAIL_READ = 'EMAIL_READ'
- WEBHOOK_EVENT_EMAIL_RECEIVED = 'EMAIL_RECEIVED'
- WEBHOOK_EVENT_NEW_ATTACHMENT = 'NEW_ATTACHMENT'
- WEBHOOK_EVENT_NEW_CONTACT = 'NEW_CONTACT'
- WEBHOOK_EVENT_NEW_EMAIL = 'NEW_EMAIL'
- WEBHOOK_EVENT_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
- getAttachmentId() : string|null
- Gets attachment_id
- getCreatedAt() : DateTime
- Gets created_at
- getEmailId() : string|null
- Gets email_id
- getHttpMethod() : string
- Gets http_method
- getHttpMethodAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getId() : string|null
- Gets id
- getInboxId() : string|null
- Gets inbox_id
- getMessageId() : string
- Gets message_id
- getModelName() : string
- The original name of the model.
- getPhoneId() : string|null
- Gets phone_id
- getRedriveId() : string|null
- Gets redrive_id
- getResponseBodyExtract() : string|null
- Gets response_body_extract
- getResponseStatus() : int|null
- Gets response_status
- getResponseTimeMillis() : int
- Gets response_time_millis
- getResultType() : string|null
- Gets result_type
- getResultTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getSeen() : bool
- Gets seen
- getSmsId() : string|null
- Gets sms_id
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUpdatedAt() : DateTime
- Gets updated_at
- getUserId() : string
- Gets user_id
- getWebhookEvent() : string
- Gets webhook_event
- getWebhookEventAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getWebhookId() : string
- Gets webhook_id
- getWebhookUrl() : string
- Gets webhook_url
- 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
- setAttachmentId() : self
- Sets attachment_id
- setCreatedAt() : self
- Sets created_at
- setEmailId() : self
- Sets email_id
- setHttpMethod() : self
- Sets http_method
- setId() : self
- Sets id
- setInboxId() : self
- Sets inbox_id
- setMessageId() : self
- Sets message_id
- setPhoneId() : self
- Sets phone_id
- setRedriveId() : self
- Sets redrive_id
- setResponseBodyExtract() : self
- Sets response_body_extract
- setResponseStatus() : self
- Sets response_status
- setResponseTimeMillis() : self
- Sets response_time_millis
- setResultType() : self
- Sets result_type
- setSeen() : self
- Sets seen
- setSmsId() : self
- Sets sms_id
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUpdatedAt() : self
- Sets updated_at
- setUserId() : self
- Sets user_id
- setWebhookEvent() : self
- Sets webhook_event
- setWebhookId() : self
- Sets webhook_id
- setWebhookUrl() : self
- Sets webhook_url
- 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
HTTP_METHOD_DELETE
public
mixed
HTTP_METHOD_DELETE
= 'DELETE'
HTTP_METHOD_GET
public
mixed
HTTP_METHOD_GET
= 'GET'
HTTP_METHOD_HEAD
public
mixed
HTTP_METHOD_HEAD
= 'HEAD'
HTTP_METHOD_OPTIONS
public
mixed
HTTP_METHOD_OPTIONS
= 'OPTIONS'
HTTP_METHOD_PATCH
public
mixed
HTTP_METHOD_PATCH
= 'PATCH'
HTTP_METHOD_POST
public
mixed
HTTP_METHOD_POST
= 'POST'
HTTP_METHOD_PUT
public
mixed
HTTP_METHOD_PUT
= 'PUT'
HTTP_METHOD_TRACE
public
mixed
HTTP_METHOD_TRACE
= 'TRACE'
RESULT_TYPE_BAD_RESPONSE
public
mixed
RESULT_TYPE_BAD_RESPONSE
= 'BAD_RESPONSE'
RESULT_TYPE_EXCEPTION
public
mixed
RESULT_TYPE_EXCEPTION
= 'EXCEPTION'
RESULT_TYPE_REDRIVEN
public
mixed
RESULT_TYPE_REDRIVEN
= 'REDRIVEN'
RESULT_TYPE_SUCCESS
public
mixed
RESULT_TYPE_SUCCESS
= 'SUCCESS'
WEBHOOK_EVENT_BOUNCE
public
mixed
WEBHOOK_EVENT_BOUNCE
= 'BOUNCE'
WEBHOOK_EVENT_BOUNCE_RECIPIENT
public
mixed
WEBHOOK_EVENT_BOUNCE_RECIPIENT
= 'BOUNCE_RECIPIENT'
WEBHOOK_EVENT_DELIVERY_STATUS
public
mixed
WEBHOOK_EVENT_DELIVERY_STATUS
= 'DELIVERY_STATUS'
WEBHOOK_EVENT_EMAIL_OPENED
public
mixed
WEBHOOK_EVENT_EMAIL_OPENED
= 'EMAIL_OPENED'
WEBHOOK_EVENT_EMAIL_READ
public
mixed
WEBHOOK_EVENT_EMAIL_READ
= 'EMAIL_READ'
WEBHOOK_EVENT_EMAIL_RECEIVED
public
mixed
WEBHOOK_EVENT_EMAIL_RECEIVED
= 'EMAIL_RECEIVED'
WEBHOOK_EVENT_NEW_ATTACHMENT
public
mixed
WEBHOOK_EVENT_NEW_ATTACHMENT
= 'NEW_ATTACHMENT'
WEBHOOK_EVENT_NEW_CONTACT
public
mixed
WEBHOOK_EVENT_NEW_CONTACT
= 'NEW_CONTACT'
WEBHOOK_EVENT_NEW_EMAIL
public
mixed
WEBHOOK_EVENT_NEW_EMAIL
= 'NEW_EMAIL'
WEBHOOK_EVENT_NEW_SMS
public
mixed
WEBHOOK_EVENT_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
= ['id' => 'id', 'user_id' => 'userId', 'webhook_id' => 'webhookId', 'webhook_url' => 'webhookUrl', 'message_id' => 'messageId', 'redrive_id' => 'redriveId', 'http_method' => 'httpMethod', 'webhook_event' => 'webhookEvent', 'response_status' => 'responseStatus', 'response_time_millis' => 'responseTimeMillis', 'response_body_extract' => 'responseBodyExtract', 'result_type' => 'resultType', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt', 'seen' => 'seen', 'inbox_id' => 'inboxId', 'email_id' => 'emailId', 'attachment_id' => 'attachmentId', 'phone_id' => 'phoneId', 'sms_id' => 'smsId']
$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
= ['id' => 'getId', 'user_id' => 'getUserId', 'webhook_id' => 'getWebhookId', 'webhook_url' => 'getWebhookUrl', 'message_id' => 'getMessageId', 'redrive_id' => 'getRedriveId', 'http_method' => 'getHttpMethod', 'webhook_event' => 'getWebhookEvent', 'response_status' => 'getResponseStatus', 'response_time_millis' => 'getResponseTimeMillis', 'response_body_extract' => 'getResponseBodyExtract', 'result_type' => 'getResultType', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt', 'seen' => 'getSeen', 'inbox_id' => 'getInboxId', 'email_id' => 'getEmailId', 'attachment_id' => 'getAttachmentId', 'phone_id' => 'getPhoneId', 'sms_id' => 'getSmsId']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'user_id' => 'uuid', 'webhook_id' => 'uuid', 'webhook_url' => null, 'message_id' => null, 'redrive_id' => 'uuid', 'http_method' => null, 'webhook_event' => null, 'response_status' => 'int32', 'response_time_millis' => 'int64', 'response_body_extract' => null, 'result_type' => null, 'created_at' => 'date-time', 'updated_at' => 'date-time', 'seen' => null, 'inbox_id' => 'uuid', 'email_id' => 'uuid', 'attachment_id' => 'uuid', 'phone_id' => 'uuid', 'sms_id' => 'uuid']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'WebhookResultDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => true, 'user_id' => false, 'webhook_id' => false, 'webhook_url' => false, 'message_id' => false, 'redrive_id' => true, 'http_method' => false, 'webhook_event' => false, 'response_status' => true, 'response_time_millis' => false, 'response_body_extract' => true, 'result_type' => true, 'created_at' => false, 'updated_at' => false, 'seen' => false, 'inbox_id' => true, 'email_id' => true, 'attachment_id' => true, 'phone_id' => true, 'sms_id' => 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
= ['id' => 'string', 'user_id' => 'string', 'webhook_id' => 'string', 'webhook_url' => 'string', 'message_id' => 'string', 'redrive_id' => 'string', 'http_method' => 'string', 'webhook_event' => 'string', 'response_status' => 'int', 'response_time_millis' => 'int', 'response_body_extract' => 'string', 'result_type' => 'string', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime', 'seen' => 'bool', 'inbox_id' => 'string', 'email_id' => 'string', 'attachment_id' => 'string', 'phone_id' => 'string', 'sms_id' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'user_id' => 'setUserId', 'webhook_id' => 'setWebhookId', 'webhook_url' => 'setWebhookUrl', 'message_id' => 'setMessageId', 'redrive_id' => 'setRedriveId', 'http_method' => 'setHttpMethod', 'webhook_event' => 'setWebhookEvent', 'response_status' => 'setResponseStatus', 'response_time_millis' => 'setResponseTimeMillis', 'response_body_extract' => 'setResponseBodyExtract', 'result_type' => 'setResultType', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt', 'seen' => 'setSeen', 'inbox_id' => 'setInboxId', 'email_id' => 'setEmailId', 'attachment_id' => 'setAttachmentId', 'phone_id' => 'setPhoneId', 'sms_id' => 'setSmsId']
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> —getAttachmentId()
Gets attachment_id
public
getAttachmentId() : string|null
Return values
string|null —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getEmailId()
Gets email_id
public
getEmailId() : string|null
Return values
string|null —getHttpMethod()
Gets http_method
public
getHttpMethod() : string
Return values
string —getHttpMethodAllowableValues()
Gets allowable values of the enum
public
getHttpMethodAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getId()
Gets id
public
getId() : string|null
Return values
string|null —getInboxId()
Gets inbox_id
public
getInboxId() : string|null
Return values
string|null —getMessageId()
Gets message_id
public
getMessageId() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPhoneId()
Gets phone_id
public
getPhoneId() : string|null
Return values
string|null —getRedriveId()
Gets redrive_id
public
getRedriveId() : string|null
Return values
string|null —getResponseBodyExtract()
Gets response_body_extract
public
getResponseBodyExtract() : string|null
Return values
string|null —getResponseStatus()
Gets response_status
public
getResponseStatus() : int|null
Return values
int|null —getResponseTimeMillis()
Gets response_time_millis
public
getResponseTimeMillis() : int
Return values
int —getResultType()
Gets result_type
public
getResultType() : string|null
Return values
string|null —getResultTypeAllowableValues()
Gets allowable values of the enum
public
getResultTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getSeen()
Gets seen
public
getSeen() : bool
Return values
bool —getSmsId()
Gets sms_id
public
getSmsId() : 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> —getUpdatedAt()
Gets updated_at
public
getUpdatedAt() : DateTime
Return values
DateTime —getUserId()
Gets user_id
public
getUserId() : string
Return values
string —getWebhookEvent()
Gets webhook_event
public
getWebhookEvent() : string
Return values
string —getWebhookEventAllowableValues()
Gets allowable values of the enum
public
getWebhookEventAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getWebhookId()
Gets webhook_id
public
getWebhookId() : string
Return values
string —getWebhookUrl()
Gets webhook_url
public
getWebhookUrl() : 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> —setAttachmentId()
Sets attachment_id
public
setAttachmentId(string|null $attachment_id) : self
Parameters
- $attachment_id : string|null
-
attachment_id
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setEmailId()
Sets email_id
public
setEmailId(string|null $email_id) : self
Parameters
- $email_id : string|null
-
email_id
Return values
self —setHttpMethod()
Sets http_method
public
setHttpMethod(string $http_method) : self
Parameters
- $http_method : string
-
http_method
Return values
self —setId()
Sets id
public
setId(string|null $id) : self
Parameters
- $id : string|null
-
id
Return values
self —setInboxId()
Sets inbox_id
public
setInboxId(string|null $inbox_id) : self
Parameters
- $inbox_id : string|null
-
inbox_id
Return values
self —setMessageId()
Sets message_id
public
setMessageId(string $message_id) : self
Parameters
- $message_id : string
-
message_id
Return values
self —setPhoneId()
Sets phone_id
public
setPhoneId(string|null $phone_id) : self
Parameters
- $phone_id : string|null
-
phone_id
Return values
self —setRedriveId()
Sets redrive_id
public
setRedriveId(string|null $redrive_id) : self
Parameters
- $redrive_id : string|null
-
redrive_id
Return values
self —setResponseBodyExtract()
Sets response_body_extract
public
setResponseBodyExtract(string|null $response_body_extract) : self
Parameters
- $response_body_extract : string|null
-
response_body_extract
Return values
self —setResponseStatus()
Sets response_status
public
setResponseStatus(int|null $response_status) : self
Parameters
- $response_status : int|null
-
response_status
Return values
self —setResponseTimeMillis()
Sets response_time_millis
public
setResponseTimeMillis(int $response_time_millis) : self
Parameters
- $response_time_millis : int
-
response_time_millis
Return values
self —setResultType()
Sets result_type
public
setResultType(string|null $result_type) : self
Parameters
- $result_type : string|null
-
result_type
Return values
self —setSeen()
Sets seen
public
setSeen(bool $seen) : self
Parameters
- $seen : bool
-
seen
Return values
self —setSmsId()
Sets sms_id
public
setSmsId(string|null $sms_id) : self
Parameters
- $sms_id : string|null
-
sms_id
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> —setUpdatedAt()
Sets updated_at
public
setUpdatedAt(DateTime $updated_at) : self
Parameters
- $updated_at : DateTime
-
updated_at
Return values
self —setUserId()
Sets user_id
public
setUserId(string $user_id) : self
Parameters
- $user_id : string
-
user_id
Return values
self —setWebhookEvent()
Sets webhook_event
public
setWebhookEvent(string $webhook_event) : self
Parameters
- $webhook_event : string
-
webhook_event
Return values
self —setWebhookId()
Sets webhook_id
public
setWebhookId(string $webhook_id) : self
Parameters
- $webhook_id : string
-
webhook_id
Return values
self —setWebhookUrl()
Sets webhook_url
public
setWebhookUrl(string $webhook_url) : self
Parameters
- $webhook_url : string
-
webhook_url
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>