com.mailslurp.models

Class WebhookEmailOpenedPayload

java.lang.Object

com.mailslurp.models.WebhookEmailOpenedPayload

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

EMAIL_OPENED webhook payload. Sent to your webhook url endpoint via HTTP POST when an email containing a tracking pixel is opened and the pixel image is loaded by a reader.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebhookEmailOpenedPayload.CustomTypeAdapterFactory
static class	WebhookEmailOpenedPayload.EventNameEnum Name of the event type webhook is being triggered for.

Field Summary

Fields

Modifier and Type	Field and Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_CREATED_AT
static String	SERIALIZED_NAME_EVENT_NAME
static String	SERIALIZED_NAME_INBOX_ID
static String	SERIALIZED_NAME_MESSAGE_ID
static String	SERIALIZED_NAME_PIXEL_ID
static String	SERIALIZED_NAME_RECIPIENT
static String	SERIALIZED_NAME_SENT_EMAIL_ID
static String	SERIALIZED_NAME_WEBHOOK_ID
static String	SERIALIZED_NAME_WEBHOOK_NAME

Constructor Summary

Constructors

Constructor and Description
WebhookEmailOpenedPayload()

Method Summary

Modifier and Type	Method and Description
WebhookEmailOpenedPayload	createdAt(OffsetDateTime createdAt)
boolean	equals(Object o)
WebhookEmailOpenedPayload	eventName(WebhookEmailOpenedPayload.EventNameEnum eventName)
static WebhookEmailOpenedPayload	fromJson(String jsonString) Create an instance of WebhookEmailOpenedPayload given an JSON string
OffsetDateTime	getCreatedAt() Date time of event creation
WebhookEmailOpenedPayload.EventNameEnum	getEventName() Name of the event type webhook is being triggered for.
UUID	getInboxId() Id of the inbox
String	getMessageId() Idempotent message ID.
UUID	getPixelId() ID of the tracking pixel
String	getRecipient() Email address for the recipient of the tracking pixel
UUID	getSentEmailId() ID of sent email
UUID	getWebhookId() ID of webhook entity being triggered
String	getWebhookName() Name of the webhook being triggered
int	hashCode()
WebhookEmailOpenedPayload	inboxId(UUID inboxId)
WebhookEmailOpenedPayload	messageId(String messageId)
WebhookEmailOpenedPayload	pixelId(UUID pixelId)
WebhookEmailOpenedPayload	recipient(String recipient)
WebhookEmailOpenedPayload	sentEmailId(UUID sentEmailId)
void	setCreatedAt(OffsetDateTime createdAt)
void	setEventName(WebhookEmailOpenedPayload.EventNameEnum eventName)
void	setInboxId(UUID inboxId)
void	setMessageId(String messageId)
void	setPixelId(UUID pixelId)
void	setRecipient(String recipient)
void	setSentEmailId(UUID sentEmailId)
void	setWebhookId(UUID webhookId)
void	setWebhookName(String webhookName)
String	toJson() Convert an instance of WebhookEmailOpenedPayload 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
WebhookEmailOpenedPayload	webhookId(UUID webhookId)
WebhookEmailOpenedPayload	webhookName(String webhookName)

Methods inherited from class java.lang.Object

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

Field Detail

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_EVENT_NAME

public static final String SERIALIZED_NAME_EVENT_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_WEBHOOK_NAME

public static final String SERIALIZED_NAME_WEBHOOK_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_INBOX_ID

public static final String SERIALIZED_NAME_INBOX_ID

See Also:

Constant Field Values

SERIALIZED_NAME_PIXEL_ID

public static final String SERIALIZED_NAME_PIXEL_ID

See Also:

Constant Field Values

SERIALIZED_NAME_SENT_EMAIL_ID

public static final String SERIALIZED_NAME_SENT_EMAIL_ID

See Also:

Constant Field Values

SERIALIZED_NAME_RECIPIENT

public static final String SERIALIZED_NAME_RECIPIENT

See Also:

Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

WebhookEmailOpenedPayload

public WebhookEmailOpenedPayload()

Method Detail

messageId

public WebhookEmailOpenedPayload messageId(String messageId)

getMessageId

@Nonnull
public String getMessageId()

Idempotent message ID. Store this ID locally or in a database to prevent message duplication.

Returns:

messageId

setMessageId

public void setMessageId(String messageId)

webhookId

public WebhookEmailOpenedPayload webhookId(UUID webhookId)

getWebhookId

@Nonnull
public UUID getWebhookId()

ID of webhook entity being triggered

Returns:

webhookId

setWebhookId

public void setWebhookId(UUID webhookId)

eventName

public WebhookEmailOpenedPayload eventName(WebhookEmailOpenedPayload.EventNameEnum eventName)

getEventName

@Nonnull
public WebhookEmailOpenedPayload.EventNameEnum getEventName()

Name of the event type webhook is being triggered for.

Returns:

eventName

setEventName

public void setEventName(WebhookEmailOpenedPayload.EventNameEnum eventName)

webhookName

public WebhookEmailOpenedPayload webhookName(String webhookName)

getWebhookName

@Nullable
public String getWebhookName()

Name of the webhook being triggered

Returns:

webhookName

setWebhookName

public void setWebhookName(String webhookName)

inboxId

public WebhookEmailOpenedPayload inboxId(UUID inboxId)

getInboxId

@Nonnull
public UUID getInboxId()

Id of the inbox

Returns:

inboxId

setInboxId

public void setInboxId(UUID inboxId)

pixelId

public WebhookEmailOpenedPayload pixelId(UUID pixelId)

getPixelId

@Nonnull
public UUID getPixelId()

ID of the tracking pixel

Returns:

pixelId

setPixelId

public void setPixelId(UUID pixelId)

sentEmailId

public WebhookEmailOpenedPayload sentEmailId(UUID sentEmailId)

getSentEmailId

@Nonnull
public UUID getSentEmailId()

ID of sent email

Returns:

sentEmailId

setSentEmailId

public void setSentEmailId(UUID sentEmailId)

recipient

public WebhookEmailOpenedPayload recipient(String recipient)

getRecipient

@Nonnull
public String getRecipient()

Email address for the recipient of the tracking pixel

Returns:

recipient

setRecipient

public void setRecipient(String recipient)

createdAt

public WebhookEmailOpenedPayload createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nonnull
public OffsetDateTime getCreatedAt()

Date time of event creation

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

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 WebhookEmailOpenedPayload

fromJson

public static WebhookEmailOpenedPayload fromJson(String jsonString)
                                          throws IOException

Create an instance of WebhookEmailOpenedPayload given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of WebhookEmailOpenedPayload

Throws:

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

toJson

public String toJson()

Convert an instance of WebhookEmailOpenedPayload to an JSON string

Returns:

JSON string