WebhookDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
WebhookDto 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_AI_TRANSFORM_RESULT = 'NEW_AI_TRANSFORM_RESULT'
- EVENT_NAME_NEW_ATTACHMENT = 'NEW_ATTACHMENT'
- EVENT_NAME_NEW_CONTACT = 'NEW_CONTACT'
- EVENT_NAME_NEW_EMAIL = 'NEW_EMAIL'
- EVENT_NAME_NEW_GUEST_USER = 'NEW_GUEST_USER'
- EVENT_NAME_NEW_SMS = 'NEW_SMS'
- HEALTH_STATUS_HEALTHY = 'HEALTHY'
- HEALTH_STATUS_UNHEALTHY = 'UNHEALTHY'
- METHOD_DELETE = 'DELETE'
- METHOD_GET = 'GET'
- METHOD_HEAD = 'HEAD'
- METHOD_OPTIONS = 'OPTIONS'
- METHOD_PATCH = 'PATCH'
- METHOD_POST = 'POST'
- METHOD_PUT = 'PUT'
- METHOD_TRACE = 'TRACE'
- $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
- getAiTransformId() : string|null
- Gets ai_transform_id
- getBasicAuth() : bool
- Gets basic_auth
- getCreatedAt() : DateTime
- Gets created_at
- getEventName() : string|null
- Gets event_name
- getEventNameAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getHealthStatus() : string|null
- Gets health_status
- getHealthStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getId() : string
- Gets id
- getIgnoreInsecureSslCertificates() : bool|null
- Gets ignore_insecure_ssl_certificates
- getInboxId() : string|null
- Gets inbox_id
- getMethod() : string
- Gets method
- getMethodAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getPayloadJsonSchema() : string
- Gets payload_json_schema
- getPhoneId() : string|null
- Gets phone_id
- getRequestBodyTemplate() : string|null
- Gets request_body_template
- getRequestHeaders() : WebhookHeaders|null
- Gets request_headers
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUpdatedAt() : DateTime
- Gets updated_at
- getUrl() : string
- Gets url
- getUserId() : string
- Gets user_id
- getUseStaticIpRange() : bool|null
- Gets use_static_ip_range
- 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
- setAiTransformId() : self
- Sets ai_transform_id
- setBasicAuth() : self
- Sets basic_auth
- setCreatedAt() : self
- Sets created_at
- setEventName() : self
- Sets event_name
- setHealthStatus() : self
- Sets health_status
- setId() : self
- Sets id
- setIgnoreInsecureSslCertificates() : self
- Sets ignore_insecure_ssl_certificates
- setInboxId() : self
- Sets inbox_id
- setMethod() : self
- Sets method
- setName() : self
- Sets name
- setPayloadJsonSchema() : self
- Sets payload_json_schema
- setPhoneId() : self
- Sets phone_id
- setRequestBodyTemplate() : self
- Sets request_body_template
- setRequestHeaders() : self
- Sets request_headers
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUpdatedAt() : self
- Sets updated_at
- setUrl() : self
- Sets url
- setUserId() : self
- Sets user_id
- setUseStaticIpRange() : self
- Sets use_static_ip_range
- 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_AI_TRANSFORM_RESULT
public
mixed
EVENT_NAME_NEW_AI_TRANSFORM_RESULT
= 'NEW_AI_TRANSFORM_RESULT'
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_GUEST_USER
public
mixed
EVENT_NAME_NEW_GUEST_USER
= 'NEW_GUEST_USER'
EVENT_NAME_NEW_SMS
public
mixed
EVENT_NAME_NEW_SMS
= 'NEW_SMS'
HEALTH_STATUS_HEALTHY
public
mixed
HEALTH_STATUS_HEALTHY
= 'HEALTHY'
HEALTH_STATUS_UNHEALTHY
public
mixed
HEALTH_STATUS_UNHEALTHY
= 'UNHEALTHY'
METHOD_DELETE
public
mixed
METHOD_DELETE
= 'DELETE'
METHOD_GET
public
mixed
METHOD_GET
= 'GET'
METHOD_HEAD
public
mixed
METHOD_HEAD
= 'HEAD'
METHOD_OPTIONS
public
mixed
METHOD_OPTIONS
= 'OPTIONS'
METHOD_PATCH
public
mixed
METHOD_PATCH
= 'PATCH'
METHOD_POST
public
mixed
METHOD_POST
= 'POST'
METHOD_PUT
public
mixed
METHOD_PUT
= 'PUT'
METHOD_TRACE
public
mixed
METHOD_TRACE
= 'TRACE'
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', 'basic_auth' => 'basicAuth', 'name' => 'name', 'phone_id' => 'phoneId', 'inbox_id' => 'inboxId', 'request_body_template' => 'requestBodyTemplate', 'url' => 'url', 'method' => 'method', 'payload_json_schema' => 'payloadJsonSchema', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt', 'event_name' => 'eventName', 'request_headers' => 'requestHeaders', 'ai_transform_id' => 'aiTransformId', 'ignore_insecure_ssl_certificates' => 'ignoreInsecureSslCertificates', 'use_static_ip_range' => 'useStaticIpRange', 'health_status' => 'healthStatus']
$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', 'basic_auth' => 'getBasicAuth', 'name' => 'getName', 'phone_id' => 'getPhoneId', 'inbox_id' => 'getInboxId', 'request_body_template' => 'getRequestBodyTemplate', 'url' => 'getUrl', 'method' => 'getMethod', 'payload_json_schema' => 'getPayloadJsonSchema', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt', 'event_name' => 'getEventName', 'request_headers' => 'getRequestHeaders', 'ai_transform_id' => 'getAiTransformId', 'ignore_insecure_ssl_certificates' => 'getIgnoreInsecureSslCertificates', 'use_static_ip_range' => 'getUseStaticIpRange', 'health_status' => 'getHealthStatus']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'user_id' => 'uuid', 'basic_auth' => null, 'name' => null, 'phone_id' => 'uuid', 'inbox_id' => 'uuid', 'request_body_template' => null, 'url' => null, 'method' => null, 'payload_json_schema' => null, 'created_at' => 'date-time', 'updated_at' => 'date-time', 'event_name' => null, 'request_headers' => null, 'ai_transform_id' => 'uuid', 'ignore_insecure_ssl_certificates' => null, 'use_static_ip_range' => null, 'health_status' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'WebhookDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'user_id' => false, 'basic_auth' => false, 'name' => true, 'phone_id' => true, 'inbox_id' => true, 'request_body_template' => true, 'url' => false, 'method' => false, 'payload_json_schema' => false, 'created_at' => true, 'updated_at' => false, 'event_name' => true, 'request_headers' => false, 'ai_transform_id' => true, 'ignore_insecure_ssl_certificates' => true, 'use_static_ip_range' => true, 'health_status' => 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', 'basic_auth' => 'bool', 'name' => 'string', 'phone_id' => 'string', 'inbox_id' => 'string', 'request_body_template' => 'string', 'url' => 'string', 'method' => 'string', 'payload_json_schema' => 'string', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime', 'event_name' => 'string', 'request_headers' => '\\MailSlurp\\Models\\WebhookHeaders', 'ai_transform_id' => 'string', 'ignore_insecure_ssl_certificates' => 'bool', 'use_static_ip_range' => 'bool', 'health_status' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'user_id' => 'setUserId', 'basic_auth' => 'setBasicAuth', 'name' => 'setName', 'phone_id' => 'setPhoneId', 'inbox_id' => 'setInboxId', 'request_body_template' => 'setRequestBodyTemplate', 'url' => 'setUrl', 'method' => 'setMethod', 'payload_json_schema' => 'setPayloadJsonSchema', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt', 'event_name' => 'setEventName', 'request_headers' => 'setRequestHeaders', 'ai_transform_id' => 'setAiTransformId', 'ignore_insecure_ssl_certificates' => 'setIgnoreInsecureSslCertificates', 'use_static_ip_range' => 'setUseStaticIpRange', 'health_status' => 'setHealthStatus']
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> —getAiTransformId()
Gets ai_transform_id
public
getAiTransformId() : string|null
Return values
string|null —getBasicAuth()
Gets basic_auth
public
getBasicAuth() : bool
Return values
bool —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getEventName()
Gets event_name
public
getEventName() : string|null
Return values
string|null —getEventNameAllowableValues()
Gets allowable values of the enum
public
getEventNameAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getHealthStatus()
Gets health_status
public
getHealthStatus() : string|null
Return values
string|null —getHealthStatusAllowableValues()
Gets allowable values of the enum
public
getHealthStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getId()
Gets id
public
getId() : string
Return values
string —getIgnoreInsecureSslCertificates()
Gets ignore_insecure_ssl_certificates
public
getIgnoreInsecureSslCertificates() : bool|null
Return values
bool|null —getInboxId()
Gets inbox_id
public
getInboxId() : string|null
Return values
string|null —getMethod()
Gets method
public
getMethod() : string
Return values
string —getMethodAllowableValues()
Gets allowable values of the enum
public
getMethodAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getPayloadJsonSchema()
Gets payload_json_schema
public
getPayloadJsonSchema() : string
Return values
string —getPhoneId()
Gets phone_id
public
getPhoneId() : string|null
Return values
string|null —getRequestBodyTemplate()
Gets request_body_template
public
getRequestBodyTemplate() : string|null
Return values
string|null —getRequestHeaders()
Gets request_headers
public
getRequestHeaders() : WebhookHeaders|null
Return values
WebhookHeaders|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 —getUrl()
Gets url
public
getUrl() : string
Return values
string —getUserId()
Gets user_id
public
getUserId() : string
Return values
string —getUseStaticIpRange()
Gets use_static_ip_range
public
getUseStaticIpRange() : bool|null
Return values
bool|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> —setAiTransformId()
Sets ai_transform_id
public
setAiTransformId(string|null $ai_transform_id) : self
Parameters
- $ai_transform_id : string|null
-
ID of AI transformer for payload
Return values
self —setBasicAuth()
Sets basic_auth
public
setBasicAuth(bool $basic_auth) : self
Parameters
- $basic_auth : bool
-
Does webhook expect basic authentication? If true it means you created this webhook with a username and password. MailSlurp will use these in the URL to authenticate itself.
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
When the webhook was created
Return values
self —setEventName()
Sets event_name
public
setEventName(string|null $event_name) : self
Parameters
- $event_name : string|null
-
Webhook trigger event name
Return values
self —setHealthStatus()
Sets health_status
public
setHealthStatus(string|null $health_status) : self
Parameters
- $health_status : string|null
-
Webhook health
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
ID of the Webhook
Return values
self —setIgnoreInsecureSslCertificates()
Sets ignore_insecure_ssl_certificates
public
setIgnoreInsecureSslCertificates(bool|null $ignore_insecure_ssl_certificates) : self
Parameters
- $ignore_insecure_ssl_certificates : bool|null
-
Should notifier ignore insecure SSL certificates
Return values
self —setInboxId()
Sets inbox_id
public
setInboxId(string|null $inbox_id) : self
Parameters
- $inbox_id : string|null
-
The inbox that the Webhook will be triggered by. If null then webhook triggered at account level or phone level if phoneId set
Return values
self —setMethod()
Sets method
public
setMethod(string $method) : self
Parameters
- $method : string
-
HTTP method that your server endpoint must listen for
Return values
self —setName()
Sets name
public
setName(string|null $name) : self
Parameters
- $name : string|null
-
Name of the webhook
Return values
self —setPayloadJsonSchema()
Sets payload_json_schema
public
setPayloadJsonSchema(string $payload_json_schema) : self
Parameters
- $payload_json_schema : string
-
Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method
Return values
self —setPhoneId()
Sets phone_id
public
setPhoneId(string|null $phone_id) : self
Parameters
- $phone_id : string|null
-
The phoneNumberId that the Webhook will be triggered by. If null then webhook triggered at account level or inbox level if inboxId set
Return values
self —setRequestBodyTemplate()
Sets request_body_template
public
setRequestBodyTemplate(string|null $request_body_template) : self
Parameters
- $request_body_template : string|null
-
Request body template for HTTP request that will be sent for the webhook. Use Moustache style template variables to insert values from the original event payload.
Return values
self —setRequestHeaders()
Sets request_headers
public
setRequestHeaders(WebhookHeaders|null $request_headers) : self
Parameters
- $request_headers : WebhookHeaders|null
-
request_headers
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 —setUrl()
Sets url
public
setUrl(string $url) : self
Parameters
- $url : string
-
URL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema.
Return values
self —setUserId()
Sets user_id
public
setUserId(string $user_id) : self
Parameters
- $user_id : string
-
User ID of the Webhook
Return values
self —setUseStaticIpRange()
Sets use_static_ip_range
public
setUseStaticIpRange(bool|null $use_static_ip_range) : self
Parameters
- $use_static_ip_range : bool|null
-
Should notifier use static IP range when sending webhook payload
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>