Class MessageRetrieveResponse
-
- All Implemented Interfaces:
public final class MessageRetrieveResponse
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classMessageRetrieveResponse.BuilderA builder for MessageRetrieveResponse.
public final classMessageRetrieveResponse.Provider
-
Method Summary
Modifier and Type Method Description final MessageDetailstoMessageDetails()final Stringid()A unique identifier associated with the message you wish to retrieve (results from a send). final Longenqueued()A UTC timestamp at which Courier received the message request. final Stringevent()A unique identifier associated with the event of the delivered message. final Stringnotification()A unique identifier associated with the notification of the delivered message. final Stringrecipient()A unique identifier associated with the recipient of the delivered message. final MessageDetails.Statusstatus()The current status of the message. final Optional<Long>clicked()A UTC timestamp at which the recipient clicked on a tracked link for the first time. final Optional<Long>delivered()A UTC timestamp at which the Integration provider delivered the message. final Optional<String>error()A message describing the error that occurred. final Optional<Long>opened()A UTC timestamp at which the recipient opened a message for the first time. final Optional<MessageDetails.Reason>reason()The reason for the current status of the message. final Optional<Long>sent()A UTC timestamp at which Courier passed the message to the Integration provider. final Optional<List<MessageRetrieveResponse.Provider>>providers()final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<Long>_enqueued()Returns the raw JSON value of enqueued. final JsonField<String>_event()Returns the raw JSON value of event. final JsonField<String>_notification()Returns the raw JSON value of notification. final JsonField<String>_recipient()Returns the raw JSON value of recipient. final JsonField<MessageDetails.Status>_status()Returns the raw JSON value of status. final JsonField<Long>_clicked()Returns the raw JSON value of clicked. final JsonField<Long>_delivered()Returns the raw JSON value of delivered. final JsonField<String>_error()Returns the raw JSON value of error. final JsonField<Long>_opened()Returns the raw JSON value of opened. final JsonField<MessageDetails.Reason>_reason()Returns the raw JSON value of reason. final JsonField<Long>_sent()Returns the raw JSON value of sent. final JsonField<List<MessageRetrieveResponse.Provider>>_providers()Returns the raw JSON value of providers. final Map<String, JsonValue>_additionalProperties()final MessageRetrieveResponse.BuildertoBuilder()final MessageRetrieveResponsevalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static MessageRetrieveResponse.Builderbuilder()Returns a mutable builder for constructing an instance of MessageRetrieveResponse. -
-
Method Detail
-
toMessageDetails
final MessageDetails toMessageDetails()
-
id
final String id()
A unique identifier associated with the message you wish to retrieve (results from a send).
-
enqueued
final Long enqueued()
A UTC timestamp at which Courier received the message request. Stored as a millisecond representation of the Unix epoch.
-
notification
final String notification()
A unique identifier associated with the notification of the delivered message.
-
recipient
final String recipient()
A unique identifier associated with the recipient of the delivered message.
-
status
final MessageDetails.Status status()
The current status of the message.
-
clicked
final Optional<Long> clicked()
A UTC timestamp at which the recipient clicked on a tracked link for the first time. Stored as a millisecond representation of the Unix epoch.
-
delivered
final Optional<Long> delivered()
A UTC timestamp at which the Integration provider delivered the message. Stored as a millisecond representation of the Unix epoch.
-
opened
final Optional<Long> opened()
A UTC timestamp at which the recipient opened a message for the first time. Stored as a millisecond representation of the Unix epoch.
-
reason
final Optional<MessageDetails.Reason> reason()
The reason for the current status of the message.
-
sent
final Optional<Long> sent()
A UTC timestamp at which Courier passed the message to the Integration provider. Stored as a millisecond representation of the Unix epoch.
-
providers
final Optional<List<MessageRetrieveResponse.Provider>> providers()
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_enqueued
final JsonField<Long> _enqueued()
Returns the raw JSON value of enqueued.
Unlike enqueued, this method doesn't throw if the JSON field has an unexpected type.
-
_event
final JsonField<String> _event()
Returns the raw JSON value of event.
Unlike event, this method doesn't throw if the JSON field has an unexpected type.
-
_notification
final JsonField<String> _notification()
Returns the raw JSON value of notification.
Unlike notification, this method doesn't throw if the JSON field has an unexpected type.
-
_recipient
final JsonField<String> _recipient()
Returns the raw JSON value of recipient.
Unlike recipient, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<MessageDetails.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_clicked
final JsonField<Long> _clicked()
Returns the raw JSON value of clicked.
Unlike clicked, this method doesn't throw if the JSON field has an unexpected type.
-
_delivered
final JsonField<Long> _delivered()
Returns the raw JSON value of delivered.
Unlike delivered, this method doesn't throw if the JSON field has an unexpected type.
-
_error
final JsonField<String> _error()
Returns the raw JSON value of error.
Unlike error, this method doesn't throw if the JSON field has an unexpected type.
-
_opened
final JsonField<Long> _opened()
Returns the raw JSON value of opened.
Unlike opened, this method doesn't throw if the JSON field has an unexpected type.
-
_reason
final JsonField<MessageDetails.Reason> _reason()
Returns the raw JSON value of reason.
Unlike reason, this method doesn't throw if the JSON field has an unexpected type.
-
_sent
final JsonField<Long> _sent()
Returns the raw JSON value of sent.
Unlike sent, this method doesn't throw if the JSON field has an unexpected type.
-
_providers
final JsonField<List<MessageRetrieveResponse.Provider>> _providers()
Returns the raw JSON value of providers.
Unlike providers, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final MessageRetrieveResponse.Builder toBuilder()
-
validate
final MessageRetrieveResponse validate()
-
builder
final static MessageRetrieveResponse.Builder builder()
Returns a mutable builder for constructing an instance of MessageRetrieveResponse.
The following fields are required:
.id() .enqueued() .event() .notification() .recipient() .status()
-
-
-
-