WebhookDeliveryStatusPayload (mailslurp-client-java 15.17.17 API)

java.lang.Object
- com.mailslurp.models.WebhookDeliveryStatusPayload

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

DELIVERY_STATUS webhook payload. Sent to your webhook url endpoint via HTTP POST when an email delivery status is created. This could be a successful delivery or a delivery failure.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`WebhookDeliveryStatusPayload.CustomTypeAdapterFactory`
`static class`	`WebhookDeliveryStatusPayload.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_EVENT_NAME`
`static String`	`SERIALIZED_NAME_ID`
`static String`	`SERIALIZED_NAME_INBOX_ID`
`static String`	`SERIALIZED_NAME_MESSAGE_ID`
`static String`	`SERIALIZED_NAME_PROCESSING_TIME_MILLIS`
`static String`	`SERIALIZED_NAME_RECEIVED`
`static String`	`SERIALIZED_NAME_RECIPIENTS`
`static String`	`SERIALIZED_NAME_REMOTE_MTA_IP`
`static String`	`SERIALIZED_NAME_REPORTING_MTA`
`static String`	`SERIALIZED_NAME_SENT_ID`
`static String`	`SERIALIZED_NAME_SMTP_RESPONSE`
`static String`	`SERIALIZED_NAME_SMTP_STATUS_CODE`
`static String`	`SERIALIZED_NAME_SUBJECT`
`static String`	`SERIALIZED_NAME_USER_ID`
`static String`	`SERIALIZED_NAME_WEBHOOK_ID`
`static String`	`SERIALIZED_NAME_WEBHOOK_NAME`

Constructor Summary

Constructors
Constructor and Description

WebhookDeliveryStatusPayload()

Constructors
Constructor and Description
`WebhookDeliveryStatusPayload()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WebhookDeliveryStatusPayload`	`addRecipientsItem(String recipientsItem)`
`boolean`	`equals(Object o)`
`WebhookDeliveryStatusPayload`	`eventName(WebhookDeliveryStatusPayload.EventNameEnum eventName)`
`static WebhookDeliveryStatusPayload`	`fromJson(String jsonString)` Create an instance of WebhookDeliveryStatusPayload given an JSON string
`WebhookDeliveryStatusPayload.EventNameEnum`	`getEventName()` Name of the event type webhook is being triggered for.
`UUID`	`getId()` ID of delivery status
`UUID`	`getInboxId()` Id of the inbox
`String`	`getMessageId()` Idempotent message ID.
`Long`	`getProcessingTimeMillis()` Time in milliseconds for delivery processing
`OffsetDateTime`	`getReceived()` Time event was received
`List<String>`	`getRecipients()` Recipients for delivery
`String`	`getRemoteMtaIp()` IP address of the remote Mail Transfer Agent
`String`	`getReportingMta()` Mail Transfer Agent reporting delivery status
`UUID`	`getSentId()` ID of sent email
`String`	`getSmtpResponse()` SMTP server response message
`Integer`	`getSmtpStatusCode()` SMTP server status
`String`	`getSubject()` Email subject
`UUID`	`getUserId()` User ID of event
`UUID`	`getWebhookId()` ID of webhook entity being triggered
`String`	`getWebhookName()` Name of the webhook being triggered
`int`	`hashCode()`
`WebhookDeliveryStatusPayload`	`id(UUID id)`
`WebhookDeliveryStatusPayload`	`inboxId(UUID inboxId)`
`WebhookDeliveryStatusPayload`	`messageId(String messageId)`
`WebhookDeliveryStatusPayload`	`processingTimeMillis(Long processingTimeMillis)`
`WebhookDeliveryStatusPayload`	`received(OffsetDateTime received)`
`WebhookDeliveryStatusPayload`	`recipients(List<String> recipients)`
`WebhookDeliveryStatusPayload`	`remoteMtaIp(String remoteMtaIp)`
`WebhookDeliveryStatusPayload`	`reportingMta(String reportingMta)`
`WebhookDeliveryStatusPayload`	`sentId(UUID sentId)`
`void`	`setEventName(WebhookDeliveryStatusPayload.EventNameEnum eventName)`
`void`	`setId(UUID id)`
`void`	`setInboxId(UUID inboxId)`
`void`	`setMessageId(String messageId)`
`void`	`setProcessingTimeMillis(Long processingTimeMillis)`
`void`	`setReceived(OffsetDateTime received)`
`void`	`setRecipients(List<String> recipients)`
`void`	`setRemoteMtaIp(String remoteMtaIp)`
`void`	`setReportingMta(String reportingMta)`
`void`	`setSentId(UUID sentId)`
`void`	`setSmtpResponse(String smtpResponse)`
`void`	`setSmtpStatusCode(Integer smtpStatusCode)`
`void`	`setSubject(String subject)`
`void`	`setUserId(UUID userId)`
`void`	`setWebhookId(UUID webhookId)`
`void`	`setWebhookName(String webhookName)`
`WebhookDeliveryStatusPayload`	`smtpResponse(String smtpResponse)`
`WebhookDeliveryStatusPayload`	`smtpStatusCode(Integer smtpStatusCode)`
`WebhookDeliveryStatusPayload`	`subject(String subject)`
`String`	`toJson()` Convert an instance of WebhookDeliveryStatusPayload to an JSON string
`String`	`toString()`
`WebhookDeliveryStatusPayload`	`userId(UUID userId)`
`static void`	`validateJsonObject(com.google.gson.JsonObject jsonObj)` Validates the JSON Object and throws an exception if issues found
`WebhookDeliveryStatusPayload`	`webhookId(UUID webhookId)`
`WebhookDeliveryStatusPayload`	`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_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_SENT_ID

public static final String SERIALIZED_NAME_SENT_ID

See Also:: Constant Field Values

SERIALIZED_NAME_REMOTE_MTA_IP

public static final String SERIALIZED_NAME_REMOTE_MTA_IP

See Also:: Constant Field Values

SERIALIZED_NAME_INBOX_ID

public static final String SERIALIZED_NAME_INBOX_ID

See Also:: Constant Field Values

SERIALIZED_NAME_REPORTING_MTA

public static final String SERIALIZED_NAME_REPORTING_MTA

See Also:: Constant Field Values

SERIALIZED_NAME_RECIPIENTS

public static final String SERIALIZED_NAME_RECIPIENTS

See Also:: Constant Field Values

SERIALIZED_NAME_SMTP_RESPONSE

public static final String SERIALIZED_NAME_SMTP_RESPONSE

See Also:: Constant Field Values

SERIALIZED_NAME_SMTP_STATUS_CODE

public static final String SERIALIZED_NAME_SMTP_STATUS_CODE

See Also:: Constant Field Values

SERIALIZED_NAME_PROCESSING_TIME_MILLIS

public static final String SERIALIZED_NAME_PROCESSING_TIME_MILLIS

See Also:: Constant Field Values

SERIALIZED_NAME_RECEIVED

public static final String SERIALIZED_NAME_RECEIVED

See Also:: Constant Field Values

SERIALIZED_NAME_SUBJECT

public static final String SERIALIZED_NAME_SUBJECT

See Also:: Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail
- WebhookDeliveryStatusPayload
```
public WebhookDeliveryStatusPayload()
```

Method Detail

messageId

public WebhookDeliveryStatusPayload 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 WebhookDeliveryStatusPayload webhookId(UUID webhookId)

getWebhookId
```
@Nonnull
public UUID getWebhookId()
```
ID of webhook entity being triggered

Returns:

webhookId

setWebhookId

public void setWebhookId(UUID webhookId)

eventName

public WebhookDeliveryStatusPayload eventName(WebhookDeliveryStatusPayload.EventNameEnum eventName)

getEventName
```
@Nonnull
public WebhookDeliveryStatusPayload.EventNameEnum getEventName()
```
Name of the event type webhook is being triggered for.

Returns:

eventName

setEventName

public void setEventName(WebhookDeliveryStatusPayload.EventNameEnum eventName)

webhookName

public WebhookDeliveryStatusPayload webhookName(String webhookName)

getWebhookName
```
@Nullable
public String getWebhookName()
```
Name of the webhook being triggered

Returns:

webhookName

setWebhookName

public void setWebhookName(String webhookName)

id

public WebhookDeliveryStatusPayload id(UUID id)

getId
```
@Nonnull
public UUID getId()
```
ID of delivery status

Returns:

id

setId
```
public void setId(UUID id)
```

userId

public WebhookDeliveryStatusPayload userId(UUID userId)

getUserId
```
@Nonnull
public UUID getUserId()
```
User ID of event

Returns:

userId

setUserId
```
public void setUserId(UUID userId)
```

sentId

public WebhookDeliveryStatusPayload sentId(UUID sentId)

getSentId
```
@Nullable
public UUID getSentId()
```
ID of sent email

Returns:

sentId

setSentId
```
public void setSentId(UUID sentId)
```

remoteMtaIp

public WebhookDeliveryStatusPayload remoteMtaIp(String remoteMtaIp)

getRemoteMtaIp
```
@Nullable
public String getRemoteMtaIp()
```
IP address of the remote Mail Transfer Agent

Returns:

remoteMtaIp

setRemoteMtaIp

public void setRemoteMtaIp(String remoteMtaIp)

inboxId

public WebhookDeliveryStatusPayload inboxId(UUID inboxId)

getInboxId
```
@Nullable
public UUID getInboxId()
```
Id of the inbox

Returns:

inboxId

setInboxId
```
public void setInboxId(UUID inboxId)
```

reportingMta

public WebhookDeliveryStatusPayload reportingMta(String reportingMta)

getReportingMta
```
@Nullable
public String getReportingMta()
```
Mail Transfer Agent reporting delivery status

Returns:

reportingMta

setReportingMta

public void setReportingMta(String reportingMta)

recipients

public WebhookDeliveryStatusPayload recipients(List<String> recipients)

addRecipientsItem

public WebhookDeliveryStatusPayload addRecipientsItem(String recipientsItem)

getRecipients
```
@Nullable
public List<String> getRecipients()
```
Recipients for delivery

Returns:

recipients

setRecipients

public void setRecipients(List<String> recipients)

smtpResponse

public WebhookDeliveryStatusPayload smtpResponse(String smtpResponse)

getSmtpResponse
```
@Nullable
public String getSmtpResponse()
```
SMTP server response message

Returns:

smtpResponse

setSmtpResponse

public void setSmtpResponse(String smtpResponse)

smtpStatusCode

public WebhookDeliveryStatusPayload smtpStatusCode(Integer smtpStatusCode)

getSmtpStatusCode
```
@Nullable
public Integer getSmtpStatusCode()
```
SMTP server status

Returns:

smtpStatusCode

setSmtpStatusCode

public void setSmtpStatusCode(Integer smtpStatusCode)

processingTimeMillis

public WebhookDeliveryStatusPayload processingTimeMillis(Long processingTimeMillis)

getProcessingTimeMillis
```
@Nullable
public Long getProcessingTimeMillis()
```
Time in milliseconds for delivery processing

Returns:

processingTimeMillis

setProcessingTimeMillis

public void setProcessingTimeMillis(Long processingTimeMillis)

received

public WebhookDeliveryStatusPayload received(OffsetDateTime received)

getReceived

@Nullable
public OffsetDateTime getReceived()

Time event was received

Returns:: received

setReceived

public void setReceived(OffsetDateTime received)

subject

public WebhookDeliveryStatusPayload subject(String subject)

getSubject
```
@Nullable
public String getSubject()
```
Email subject

Returns:

subject

setSubject

public void setSubject(String subject)

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 WebhookDeliveryStatusPayload

fromJson
```
public static WebhookDeliveryStatusPayload fromJson(String jsonString)
                                             throws IOException
```
Create an instance of WebhookDeliveryStatusPayload given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of WebhookDeliveryStatusPayload

Throws:

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

toJson
```
public String toJson()
```
Convert an instance of WebhookDeliveryStatusPayload to an JSON string

Returns:

JSON string

Class WebhookDeliveryStatusPayload

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_MESSAGE_ID

SERIALIZED_NAME_WEBHOOK_ID

SERIALIZED_NAME_EVENT_NAME

SERIALIZED_NAME_WEBHOOK_NAME

SERIALIZED_NAME_ID

SERIALIZED_NAME_USER_ID

SERIALIZED_NAME_SENT_ID

SERIALIZED_NAME_REMOTE_MTA_IP

SERIALIZED_NAME_INBOX_ID

SERIALIZED_NAME_REPORTING_MTA

SERIALIZED_NAME_RECIPIENTS

SERIALIZED_NAME_SMTP_RESPONSE

SERIALIZED_NAME_SMTP_STATUS_CODE

SERIALIZED_NAME_PROCESSING_TIME_MILLIS

SERIALIZED_NAME_RECEIVED

SERIALIZED_NAME_SUBJECT

openapiFields

openapiRequiredFields

Constructor Detail

WebhookDeliveryStatusPayload

Method Detail

messageId

getMessageId

setMessageId

webhookId

getWebhookId

setWebhookId

eventName

getEventName

setEventName

webhookName

getWebhookName

setWebhookName

id

getId

setId

userId

getUserId

setUserId

sentId

getSentId

setSentId

remoteMtaIp

getRemoteMtaIp

setRemoteMtaIp

inboxId

getInboxId

setInboxId

reportingMta

getReportingMta

setReportingMta

recipients

addRecipientsItem

getRecipients

setRecipients

smtpResponse

getSmtpResponse

setSmtpResponse

smtpStatusCode

getSmtpStatusCode

setSmtpStatusCode

processingTimeMillis

getProcessingTimeMillis

setProcessingTimeMillis

received

getReceived

setReceived

subject

getSubject

setSubject

equals

hashCode

toString