com.mailslurp.models

Class WebhookDto

java.lang.Object

com.mailslurp.models.WebhookDto

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-06-12T23:33:57.654989Z[Etc/UTC]")
public class WebhookDto
extends Object

Representation of a webhook for an inbox. The URL specified will be using by MailSlurp whenever an email is received by the attached inbox. A webhook entity should have a URL that points to your server. Your server should accept HTTP/S POST requests and return a success 200. MailSlurp will retry your webhooks if they fail. See https://java.api.mailslurp.com/schemas/webhook-payload for the payload schema.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebhookDto.CustomTypeAdapterFactory
static class	WebhookDto.EventNameEnum Webhook trigger event name
static class	WebhookDto.MethodEnum HTTP method that your server endpoint must listen for

Field Summary

Fields

Modifier and Type	Field and Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_BASIC_AUTH
static String	SERIALIZED_NAME_CREATED_AT
static String	SERIALIZED_NAME_EVENT_NAME
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_IGNORE_INSECURE_SSL_CERTIFICATES
static String	SERIALIZED_NAME_INBOX_ID
static String	SERIALIZED_NAME_METHOD
static String	SERIALIZED_NAME_NAME
static String	SERIALIZED_NAME_PAYLOAD_JSON_SCHEMA
static String	SERIALIZED_NAME_PHONE_ID
static String	SERIALIZED_NAME_REQUEST_BODY_TEMPLATE
static String	SERIALIZED_NAME_REQUEST_HEADERS
static String	SERIALIZED_NAME_UPDATED_AT
static String	SERIALIZED_NAME_URL
static String	SERIALIZED_NAME_USE_STATIC_IP_RANGE
static String	SERIALIZED_NAME_USER_ID

Constructor Summary

Constructors

Constructor and Description
WebhookDto()

Method Summary

Modifier and Type	Method and Description
WebhookDto	basicAuth(Boolean basicAuth)
WebhookDto	createdAt(OffsetDateTime createdAt)
boolean	equals(Object o)
WebhookDto	eventName(WebhookDto.EventNameEnum eventName)
static WebhookDto	fromJson(String jsonString) Create an instance of WebhookDto given an JSON string
Boolean	getBasicAuth() Does webhook expect basic authentication? If true it means you created this webhook with a username and password.
OffsetDateTime	getCreatedAt() When the webhook was created
WebhookDto.EventNameEnum	getEventName() Webhook trigger event name
UUID	getId() ID of the Webhook
Boolean	getIgnoreInsecureSslCertificates() Should notifier ignore insecure SSL certificates
UUID	getInboxId() The inbox that the Webhook will be triggered by.
WebhookDto.MethodEnum	getMethod() HTTP method that your server endpoint must listen for
String	getName() Name of the webhook
String	getPayloadJsonSchema() Deprecated.
UUID	getPhoneId() The phoneNumberId that the Webhook will be triggered by.
String	getRequestBodyTemplate() Request body template for HTTP request that will be sent for the webhook.
WebhookHeaders	getRequestHeaders() Get requestHeaders
OffsetDateTime	getUpdatedAt() Get updatedAt
String	getUrl() URL of your server that the webhook will be sent to.
UUID	getUserId() User ID of the Webhook
Boolean	getUseStaticIpRange() Should notifier use static IP range when sending webhook payload
int	hashCode()
WebhookDto	id(UUID id)
WebhookDto	ignoreInsecureSslCertificates(Boolean ignoreInsecureSslCertificates)
WebhookDto	inboxId(UUID inboxId)
WebhookDto	method(WebhookDto.MethodEnum method)
WebhookDto	name(String name)
WebhookDto	payloadJsonSchema(String payloadJsonSchema)
WebhookDto	phoneId(UUID phoneId)
WebhookDto	requestBodyTemplate(String requestBodyTemplate)
WebhookDto	requestHeaders(WebhookHeaders requestHeaders)
void	setBasicAuth(Boolean basicAuth)
void	setCreatedAt(OffsetDateTime createdAt)
void	setEventName(WebhookDto.EventNameEnum eventName)
void	setId(UUID id)
void	setIgnoreInsecureSslCertificates(Boolean ignoreInsecureSslCertificates)
void	setInboxId(UUID inboxId)
void	setMethod(WebhookDto.MethodEnum method)
void	setName(String name)
void	setPayloadJsonSchema(String payloadJsonSchema)
void	setPhoneId(UUID phoneId)
void	setRequestBodyTemplate(String requestBodyTemplate)
void	setRequestHeaders(WebhookHeaders requestHeaders)
void	setUpdatedAt(OffsetDateTime updatedAt)
void	setUrl(String url)
void	setUserId(UUID userId)
void	setUseStaticIpRange(Boolean useStaticIpRange)
String	toJson() Convert an instance of WebhookDto to an JSON string
String	toString()
WebhookDto	updatedAt(OffsetDateTime updatedAt)
WebhookDto	url(String url)
WebhookDto	userId(UUID userId)
WebhookDto	useStaticIpRange(Boolean useStaticIpRange)
static void	validateJsonObject(com.google.gson.JsonObject jsonObj) Validates the JSON Object and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

Constant Field Values

SERIALIZED_NAME_USER_ID

public static final String SERIALIZED_NAME_USER_ID

See Also:

Constant Field Values

SERIALIZED_NAME_BASIC_AUTH

public static final String SERIALIZED_NAME_BASIC_AUTH

See Also:

Constant Field Values

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_PHONE_ID

public static final String SERIALIZED_NAME_PHONE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_INBOX_ID

public static final String SERIALIZED_NAME_INBOX_ID

See Also:

Constant Field Values

SERIALIZED_NAME_REQUEST_BODY_TEMPLATE

public static final String SERIALIZED_NAME_REQUEST_BODY_TEMPLATE

See Also:

Constant Field Values

SERIALIZED_NAME_URL

public static final String SERIALIZED_NAME_URL

See Also:

Constant Field Values

SERIALIZED_NAME_METHOD

public static final String SERIALIZED_NAME_METHOD

See Also:

Constant Field Values

SERIALIZED_NAME_PAYLOAD_JSON_SCHEMA

public static final String SERIALIZED_NAME_PAYLOAD_JSON_SCHEMA

See Also:

Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_EVENT_NAME

public static final String SERIALIZED_NAME_EVENT_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_REQUEST_HEADERS

public static final String SERIALIZED_NAME_REQUEST_HEADERS

See Also:

Constant Field Values

SERIALIZED_NAME_IGNORE_INSECURE_SSL_CERTIFICATES

public static final String SERIALIZED_NAME_IGNORE_INSECURE_SSL_CERTIFICATES

See Also:

Constant Field Values

SERIALIZED_NAME_USE_STATIC_IP_RANGE

public static final String SERIALIZED_NAME_USE_STATIC_IP_RANGE

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

WebhookDto

public WebhookDto()

Method Detail

id

public WebhookDto id(UUID id)

getId

@Nonnull
public UUID getId()

ID of the Webhook

Returns:

id

setId

public void setId(UUID id)

userId

public WebhookDto userId(UUID userId)

getUserId

@Nonnull
public UUID getUserId()

User ID of the Webhook

Returns:

userId

setUserId

public void setUserId(UUID userId)

basicAuth

public WebhookDto basicAuth(Boolean basicAuth)

getBasicAuth

@Nonnull
public Boolean getBasicAuth()

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.

Returns:

basicAuth

setBasicAuth

public void setBasicAuth(Boolean basicAuth)

name

public WebhookDto name(String name)

getName

@Nullable
public String getName()

Name of the webhook

Returns:

name

setName

public void setName(String name)

phoneId

public WebhookDto phoneId(UUID phoneId)

getPhoneId

@Nullable
public UUID getPhoneId()

The phoneNumberId that the Webhook will be triggered by. If null then webhook triggered at account level or inbox level if inboxId set

Returns:

phoneId

setPhoneId

public void setPhoneId(UUID phoneId)

inboxId

public WebhookDto inboxId(UUID inboxId)

getInboxId

@Nullable
public UUID getInboxId()

The inbox that the Webhook will be triggered by. If null then webhook triggered at account level or phone level if phoneId set

Returns:

inboxId

setInboxId

public void setInboxId(UUID inboxId)

requestBodyTemplate

public WebhookDto requestBodyTemplate(String requestBodyTemplate)

getRequestBodyTemplate

@Nullable
public String getRequestBodyTemplate()

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.

Returns:

requestBodyTemplate

setRequestBodyTemplate

public void setRequestBodyTemplate(String requestBodyTemplate)

url

public WebhookDto url(String url)

getUrl

@Nonnull
public String getUrl()

URL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema.

Returns:

url

setUrl

public void setUrl(String url)

method

public WebhookDto method(WebhookDto.MethodEnum method)

getMethod

@Nonnull
public WebhookDto.MethodEnum getMethod()

HTTP method that your server endpoint must listen for

Returns:

method

setMethod

public void setMethod(WebhookDto.MethodEnum method)

payloadJsonSchema

public WebhookDto payloadJsonSchema(String payloadJsonSchema)

getPayloadJsonSchema

@Nonnull
public String getPayloadJsonSchema()

Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method

Returns:

payloadJsonSchema

setPayloadJsonSchema

public void setPayloadJsonSchema(String payloadJsonSchema)

createdAt

public WebhookDto createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

When the webhook was created

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public WebhookDto updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nonnull
public OffsetDateTime getUpdatedAt()

Get updatedAt

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

eventName

public WebhookDto eventName(WebhookDto.EventNameEnum eventName)

getEventName

@Nullable
public WebhookDto.EventNameEnum getEventName()

Webhook trigger event name

Returns:

eventName

setEventName

public void setEventName(WebhookDto.EventNameEnum eventName)

requestHeaders

public WebhookDto requestHeaders(WebhookHeaders requestHeaders)

getRequestHeaders

@Nullable
public WebhookHeaders getRequestHeaders()

Get requestHeaders

Returns:

requestHeaders

setRequestHeaders

public void setRequestHeaders(WebhookHeaders requestHeaders)

ignoreInsecureSslCertificates

public WebhookDto ignoreInsecureSslCertificates(Boolean ignoreInsecureSslCertificates)

getIgnoreInsecureSslCertificates

@Nullable
public Boolean getIgnoreInsecureSslCertificates()

Should notifier ignore insecure SSL certificates

Returns:

ignoreInsecureSslCertificates

setIgnoreInsecureSslCertificates

public void setIgnoreInsecureSslCertificates(Boolean ignoreInsecureSslCertificates)

useStaticIpRange

public WebhookDto useStaticIpRange(Boolean useStaticIpRange)

getUseStaticIpRange

@Nullable
public Boolean getUseStaticIpRange()

Should notifier use static IP range when sending webhook payload

Returns:

useStaticIpRange

setUseStaticIpRange

public void setUseStaticIpRange(Boolean useStaticIpRange)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonObject

public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException

Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

IOException - if the JSON Object is invalid with respect to WebhookDto

fromJson

public static WebhookDto fromJson(String jsonString)
                           throws IOException

Create an instance of WebhookDto given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of WebhookDto

Throws:

IOException - if the JSON string is invalid with respect to WebhookDto

toJson

public String toJson()

Convert an instance of WebhookDto to an JSON string

Returns:

JSON string