All Implemented Interfaces:: so.prelude.sdk.core.Params


public final class TransactionalSendParams
 implements Params

Send a transactional message to your user.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`TransactionalSendParams.Builder`	A builder for TransactionalSendParams.
`public final class`	`TransactionalSendParams.Body`
`public final class`	`TransactionalSendParams.Variables`	The variables to be replaced in the template.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

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>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final TransactionalSendParams.Builder`	`toBuilder()`
`final TransactionalSendParams.Body`	`_body()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static TransactionalSendParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of TransactionalSendParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - templateId
```
 final String templateId()
```
    The template identifier.
  - to
```
 final String to()
```
    The recipient's phone number.
  - 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.
  - expiresAt
```
 final Optional<String> expiresAt()
```
    The message expiration date.
  - from
```
 final Optional<String> from()
```
    The Sender ID.
  - 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.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final TransactionalSendParams.Builder toBuilder()
```
  - _body
```
 final TransactionalSendParams.Body _body()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static TransactionalSendParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of TransactionalSendParams.
    The following fields are required:
    .templateId() .to()

Class TransactionalSendParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

templateId

to

callbackUrl

correlationId

expiresAt

from

locale

variables

_templateId

_to

_callbackUrl

_correlationId

_expiresAt

_from

_locale

_variables

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

builder