Class TransactionalSendParams.Body
-
- All Implemented Interfaces:
public final class TransactionalSendParams.Body
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
TransactionalSendParams.Body.Builder
A builder for Body.
-
Method Summary
Modifier and Type Method Description final String
templateId()
The template identifier. final String
to()
The recipient's phone number. final Optional<String>
callbackUrl()
The callback URL. final Optional<String>
correlationId()
A user-defined identifier to correlate this transactional message with. final Optional<String>
expiresAt()
The message expiration date. final Optional<String>
from()
The Sender ID. final Optional<String>
locale()
A BCP-47 formatted locale string with the language the text message will be sent to. final Optional<TransactionalSendParams.Variables>
variables()
The variables to be replaced in the template. final JsonField<String>
_templateId()
Returns the raw JSON value of templateId. final JsonField<String>
_to()
Returns the raw JSON value of to. final JsonField<String>
_callbackUrl()
Returns the raw JSON value of callbackUrl. final JsonField<String>
_correlationId()
Returns the raw JSON value of correlationId. final JsonField<String>
_expiresAt()
Returns the raw JSON value of expiresAt. final JsonField<String>
_from()
Returns the raw JSON value of from. final JsonField<String>
_locale()
Returns the raw JSON value of locale. final JsonField<TransactionalSendParams.Variables>
_variables()
Returns the raw JSON value of variables. final Map<String, JsonValue>
_additionalProperties()
final TransactionalSendParams.Body.Builder
toBuilder()
final TransactionalSendParams.Body
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static TransactionalSendParams.Body.Builder
builder()
Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
templateId
final String templateId()
The template identifier.
-
callbackUrl
final Optional<String> callbackUrl()
The callback URL.
-
correlationId
final Optional<String> correlationId()
A user-defined identifier to correlate this transactional message with. It is returned in the response and any webhook events that refer to this transactionalmessage.
-
locale
final Optional<String> locale()
A BCP-47 formatted locale string with the language the text message will be sent to. If there's no locale set, the language will be determined by the country code of the phone number. If the language specified doesn't exist, the default set on the template will be used.
-
variables
final Optional<TransactionalSendParams.Variables> variables()
The variables to be replaced in the template.
-
_templateId
final JsonField<String> _templateId()
Returns the raw JSON value of templateId.
Unlike templateId, this method doesn't throw if the JSON field has an unexpected type.
-
_to
final JsonField<String> _to()
Returns the raw JSON value of to.
Unlike to, this method doesn't throw if the JSON field has an unexpected type.
-
_callbackUrl
final JsonField<String> _callbackUrl()
Returns the raw JSON value of callbackUrl.
Unlike callbackUrl, this method doesn't throw if the JSON field has an unexpected type.
-
_correlationId
final JsonField<String> _correlationId()
Returns the raw JSON value of correlationId.
Unlike correlationId, this method doesn't throw if the JSON field has an unexpected type.
-
_expiresAt
final JsonField<String> _expiresAt()
Returns the raw JSON value of expiresAt.
Unlike expiresAt, this method doesn't throw if the JSON field has an unexpected type.
-
_from
final JsonField<String> _from()
Returns the raw JSON value of from.
Unlike from, this method doesn't throw if the JSON field has an unexpected type.
-
_locale
final JsonField<String> _locale()
Returns the raw JSON value of locale.
Unlike locale, this method doesn't throw if the JSON field has an unexpected type.
-
_variables
final JsonField<TransactionalSendParams.Variables> _variables()
Returns the raw JSON value of variables.
Unlike variables, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final TransactionalSendParams.Body.Builder toBuilder()
-
validate
final TransactionalSendParams.Body validate()
-
builder
final static TransactionalSendParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
The following fields are required:
.templateId() .to()
-
-
-
-