com.mailslurp.models

Class AbstractWebhookPayload

java.lang.Object

com.mailslurp.models.AbstractWebhookPayload

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

Abstract webhook payload. Use the correct payload type for your webhook event type in order to access all the specific properties for that event. See the `NEW_EMAIL`,`NEW_CONTACT`, `NEW_ATTACHMENT` and `EMAIL_OPENED` payloads for the properties available for those events.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractWebhookPayload.CustomTypeAdapterFactory
static class	AbstractWebhookPayload.EventNameEnum Gets or Sets eventName

Field Summary

Fields

Modifier and Type	Field and Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_EVENT_NAME
static String	SERIALIZED_NAME_MESSAGE_ID
static String	SERIALIZED_NAME_WEBHOOK_ID
static String	SERIALIZED_NAME_WEBHOOK_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractWebhookPayload()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
AbstractWebhookPayload	eventName(AbstractWebhookPayload.EventNameEnum eventName)
static AbstractWebhookPayload	fromJson(String jsonString) Create an instance of AbstractWebhookPayload given an JSON string
AbstractWebhookPayload.EventNameEnum	getEventName() Get eventName
String	getMessageId() Get messageId
UUID	getWebhookId() Get webhookId
String	getWebhookName() Get webhookName
int	hashCode()
AbstractWebhookPayload	messageId(String messageId)
void	setEventName(AbstractWebhookPayload.EventNameEnum eventName)
void	setMessageId(String messageId)
void	setWebhookId(UUID webhookId)
void	setWebhookName(String webhookName)
String	toJson() Convert an instance of AbstractWebhookPayload to an JSON string
String	toString()
static void	validateJsonObject(com.google.gson.JsonObject jsonObj) Validates the JSON Object and throws an exception if issues found
AbstractWebhookPayload	webhookId(UUID webhookId)
AbstractWebhookPayload	webhookName(String webhookName)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_EVENT_NAME

public static final String SERIALIZED_NAME_EVENT_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_MESSAGE_ID

public static final String SERIALIZED_NAME_MESSAGE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_WEBHOOK_ID

public static final String SERIALIZED_NAME_WEBHOOK_ID

See Also:

Constant Field Values

SERIALIZED_NAME_WEBHOOK_NAME

public static final String SERIALIZED_NAME_WEBHOOK_NAME

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

AbstractWebhookPayload

public AbstractWebhookPayload()

Method Detail

eventName

public AbstractWebhookPayload eventName(AbstractWebhookPayload.EventNameEnum eventName)

getEventName

@Nonnull
public AbstractWebhookPayload.EventNameEnum getEventName()

Get eventName

Returns:

eventName

setEventName

public void setEventName(AbstractWebhookPayload.EventNameEnum eventName)

messageId

public AbstractWebhookPayload messageId(String messageId)

getMessageId

@Nonnull
public String getMessageId()

Get messageId

Returns:

messageId

setMessageId

public void setMessageId(String messageId)

webhookId

public AbstractWebhookPayload webhookId(UUID webhookId)

getWebhookId

@Nonnull
public UUID getWebhookId()

Get webhookId

Returns:

webhookId

setWebhookId

public void setWebhookId(UUID webhookId)

webhookName

public AbstractWebhookPayload webhookName(String webhookName)

getWebhookName

@Nullable
public String getWebhookName()

Get webhookName

Returns:

webhookName

setWebhookName

public void setWebhookName(String webhookName)

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 AbstractWebhookPayload

fromJson

public static AbstractWebhookPayload fromJson(String jsonString)
                                       throws IOException

Create an instance of AbstractWebhookPayload given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of AbstractWebhookPayload

Throws:

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

toJson

public String toJson()

Convert an instance of AbstractWebhookPayload to an JSON string

Returns:

JSON string