Documentation

CreateWebhookOptions
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CreateWebhookOptions Class Doc Comment

Tags
category

Class

description

Options for creating a webhook. Webhooks can be attached to inboxes and MailSlurp will POST a webhook payload to the URL specified whenever the webhook's event is triggered. Webhooks are great for processing many inbound emails and responding to other events at scale. Customize the payload sent to your endpoint by setting the `requestBodyTemplate` property to a string with moustache style variables. Property names from the standard payload model for the given event are available as variables.

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
getBasicAuth()  : BasicAuthOptions|null
Gets basic_auth
getEventName()  : string|null
Gets event_name
getEventNameAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getIgnoreInsecureSslCertificates()  : bool|null
Gets ignore_insecure_ssl_certificates
getIncludeHeaders()  : WebhookHeaders|null
Gets include_headers
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getRequestBodyTemplate()  : string|null
Gets request_body_template
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUrl()  : string
Gets url
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
setBasicAuth()  : self
Sets basic_auth
setEventName()  : self
Sets event_name
setIgnoreInsecureSslCertificates()  : self
Sets ignore_insecure_ssl_certificates
setIncludeHeaders()  : self
Sets include_headers
setName()  : self
Sets name
setRequestBodyTemplate()  : self
Sets request_body_template
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUrl()  : self
Sets url
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

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 = ['url' => 'url', 'basic_auth' => 'basicAuth', 'name' => 'name', 'event_name' => 'eventName', 'include_headers' => 'includeHeaders', 'request_body_template' => 'requestBodyTemplate', 'use_static_ip_range' => 'useStaticIpRange', 'ignore_insecure_ssl_certificates' => 'ignoreInsecureSslCertificates']

$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 = ['url' => 'getUrl', 'basic_auth' => 'getBasicAuth', 'name' => 'getName', 'event_name' => 'getEventName', 'include_headers' => 'getIncludeHeaders', 'request_body_template' => 'getRequestBodyTemplate', 'use_static_ip_range' => 'getUseStaticIpRange', 'ignore_insecure_ssl_certificates' => 'getIgnoreInsecureSslCertificates']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $openAPIFormats = ['url' => null, 'basic_auth' => null, 'name' => null, 'event_name' => null, 'include_headers' => null, 'request_body_template' => null, 'use_static_ip_range' => null, 'ignore_insecure_ssl_certificates' => 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 = 'CreateWebhookOptions'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['url' => false, 'basic_auth' => true, 'name' => true, 'event_name' => true, 'include_headers' => false, 'request_body_template' => true, 'use_static_ip_range' => true, 'ignore_insecure_ssl_certificates' => 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 = ['url' => 'string', 'basic_auth' => '\\MailSlurp\\Models\\BasicAuthOptions', 'name' => 'string', 'event_name' => 'string', 'include_headers' => '\\MailSlurp\\Models\\WebhookHeaders', 'request_body_template' => 'string', 'use_static_ip_range' => 'bool', 'ignore_insecure_ssl_certificates' => 'bool']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['url' => 'setUrl', 'basic_auth' => 'setBasicAuth', 'name' => 'setName', 'event_name' => 'setEventName', 'include_headers' => 'setIncludeHeaders', 'request_body_template' => 'setRequestBodyTemplate', 'use_static_ip_range' => 'setUseStaticIpRange', 'ignore_insecure_ssl_certificates' => 'setIgnoreInsecureSslCertificates']

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|null
Return values
string|null —

getEventNameAllowableValues()

Gets allowable values of the enum

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

getIgnoreInsecureSslCertificates()

Gets ignore_insecure_ssl_certificates

public getIgnoreInsecureSslCertificates() : bool|null
Return values
bool|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getRequestBodyTemplate()

Gets request_body_template

public getRequestBodyTemplate() : 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> —

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 —

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|null $event_name) : self
Parameters
$event_name : string|null

Optional webhook event name. Default is EMAIL_RECEIVED and is triggered when an email is received by the inbox associated with the webhook. Payload differ according to the webhook event name.

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

Ignore insecure SSL certificates when sending request. Useful for self-signed certs.

Return values
self —

setName()

Sets name

public setName(string|null $name) : self
Parameters
$name : string|null

Optional name for the webhook

Return values
self —

setRequestBodyTemplate()

Sets request_body_template

public setRequestBodyTemplate(string|null $request_body_template) : self
Parameters
$request_body_template : string|null

Template for the JSON body of the webhook request that will be sent to your server. Use Moustache style {{variableName}} templating to use parts of the standard webhook payload for the given event.

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

setUrl()

Sets url

public setUrl(string $url) : self
Parameters
$url : string

Public URL on your server that MailSlurp can post WebhookNotification payload to when an email is received or an event is trigger. The payload of the submitted JSON is dependent on the webhook event type. See docs.mailslurp.com/webhooks for event payload documentation.

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

Use static IP range when calling webhook endpoint

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