com.mailslurp.models

Class WebhookNewSmsPayload

java.lang.Object

com.mailslurp.models.WebhookNewSmsPayload

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

NEW_SMS webhook payload. Sent to your webhook url endpoint via HTTP POST when an sms is received by the phone number that your webhook is attached to. Use the SMS ID to fetch the full SMS details.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebhookNewSmsPayload.CustomTypeAdapterFactory
static class	WebhookNewSmsPayload.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_BODY
static String	SERIALIZED_NAME_EVENT_NAME
static String	SERIALIZED_NAME_FROM_NUMBER
static String	SERIALIZED_NAME_MESSAGE_ID
static String	SERIALIZED_NAME_PHONE_NUMBER
static String	SERIALIZED_NAME_READ
static String	SERIALIZED_NAME_SMS_ID
static String	SERIALIZED_NAME_TO_NUMBER
static String	SERIALIZED_NAME_USER_ID
static String	SERIALIZED_NAME_WEBHOOK_ID
static String	SERIALIZED_NAME_WEBHOOK_NAME

Constructor Summary

Constructors

Constructor and Description
WebhookNewSmsPayload()

Method Summary

Modifier and Type	Method and Description
WebhookNewSmsPayload	body(String body)
boolean	equals(Object o)
WebhookNewSmsPayload	eventName(WebhookNewSmsPayload.EventNameEnum eventName)
static WebhookNewSmsPayload	fromJson(String jsonString) Create an instance of WebhookNewSmsPayload given an JSON string
WebhookNewSmsPayload	fromNumber(String fromNumber)
String	getBody() SMS message body
WebhookNewSmsPayload.EventNameEnum	getEventName() Name of the event type webhook is being triggered for.
String	getFromNumber() Sender phone number
String	getMessageId() Idempotent message ID.
UUID	getPhoneNumber() ID of phone number receiving SMS
Boolean	getRead() SMS has been read
UUID	getSmsId() ID of SMS message
String	getToNumber() Recipient phone number
UUID	getUserId() User ID of event
UUID	getWebhookId() ID of webhook entity being triggered
String	getWebhookName() Name of the webhook being triggered
int	hashCode()
WebhookNewSmsPayload	messageId(String messageId)
WebhookNewSmsPayload	phoneNumber(UUID phoneNumber)
WebhookNewSmsPayload	read(Boolean read)
void	setBody(String body)
void	setEventName(WebhookNewSmsPayload.EventNameEnum eventName)
void	setFromNumber(String fromNumber)
void	setMessageId(String messageId)
void	setPhoneNumber(UUID phoneNumber)
void	setRead(Boolean read)
void	setSmsId(UUID smsId)
void	setToNumber(String toNumber)
void	setUserId(UUID userId)
void	setWebhookId(UUID webhookId)
void	setWebhookName(String webhookName)
WebhookNewSmsPayload	smsId(UUID smsId)
String	toJson() Convert an instance of WebhookNewSmsPayload to an JSON string
WebhookNewSmsPayload	toNumber(String toNumber)
String	toString()
WebhookNewSmsPayload	userId(UUID userId)
static void	validateJsonObject(com.google.gson.JsonObject jsonObj) Validates the JSON Object and throws an exception if issues found
WebhookNewSmsPayload	webhookId(UUID webhookId)
WebhookNewSmsPayload	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_SMS_ID

public static final String SERIALIZED_NAME_SMS_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_PHONE_NUMBER

public static final String SERIALIZED_NAME_PHONE_NUMBER

See Also:

Constant Field Values

SERIALIZED_NAME_TO_NUMBER

public static final String SERIALIZED_NAME_TO_NUMBER

See Also:

Constant Field Values

SERIALIZED_NAME_FROM_NUMBER

public static final String SERIALIZED_NAME_FROM_NUMBER

See Also:

Constant Field Values

SERIALIZED_NAME_BODY

public static final String SERIALIZED_NAME_BODY

See Also:

Constant Field Values

SERIALIZED_NAME_READ

public static final String SERIALIZED_NAME_READ

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

WebhookNewSmsPayload

public WebhookNewSmsPayload()

Method Detail

messageId

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

getWebhookId

@Nonnull
public UUID getWebhookId()

ID of webhook entity being triggered

Returns:

webhookId

setWebhookId

public void setWebhookId(UUID webhookId)

eventName

public WebhookNewSmsPayload eventName(WebhookNewSmsPayload.EventNameEnum eventName)

getEventName

@Nonnull
public WebhookNewSmsPayload.EventNameEnum getEventName()

Name of the event type webhook is being triggered for.

Returns:

eventName

setEventName

public void setEventName(WebhookNewSmsPayload.EventNameEnum eventName)

webhookName

public WebhookNewSmsPayload webhookName(String webhookName)

getWebhookName

@Nullable
public String getWebhookName()

Name of the webhook being triggered

Returns:

webhookName

setWebhookName

public void setWebhookName(String webhookName)

smsId

public WebhookNewSmsPayload smsId(UUID smsId)

getSmsId

@Nonnull
public UUID getSmsId()

ID of SMS message

Returns:

smsId

setSmsId

public void setSmsId(UUID smsId)

userId

public WebhookNewSmsPayload userId(UUID userId)

getUserId

@Nonnull
public UUID getUserId()

User ID of event

Returns:

userId

setUserId

public void setUserId(UUID userId)

phoneNumber

public WebhookNewSmsPayload phoneNumber(UUID phoneNumber)

getPhoneNumber

@Nonnull
public UUID getPhoneNumber()

ID of phone number receiving SMS

Returns:

phoneNumber

setPhoneNumber

public void setPhoneNumber(UUID phoneNumber)

toNumber

public WebhookNewSmsPayload toNumber(String toNumber)

getToNumber

@Nonnull
public String getToNumber()

Recipient phone number

Returns:

toNumber

setToNumber

public void setToNumber(String toNumber)

fromNumber

public WebhookNewSmsPayload fromNumber(String fromNumber)

getFromNumber

@Nonnull
public String getFromNumber()

Sender phone number

Returns:

fromNumber

setFromNumber

public void setFromNumber(String fromNumber)

body

public WebhookNewSmsPayload body(String body)

getBody

@Nonnull
public String getBody()

SMS message body

Returns:

body

setBody

public void setBody(String body)

read

public WebhookNewSmsPayload read(Boolean read)

getRead

@Nonnull
public Boolean getRead()

SMS has been read

Returns:

read

setRead

public void setRead(Boolean read)

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 WebhookNewSmsPayload

fromJson

public static WebhookNewSmsPayload fromJson(String jsonString)
                                     throws IOException

Create an instance of WebhookNewSmsPayload given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of WebhookNewSmsPayload

Throws:

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

toJson

public String toJson()

Convert an instance of WebhookNewSmsPayload to an JSON string

Returns:

JSON string