Package com.courier.api.resources.messages

Class MessagesClient

java.lang.Object

com.courier.api.resources.messages.MessagesClient

public class MessagesClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
MessagesClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
void	archive(java.lang.String requestId)
void	archive(java.lang.String requestId, RequestOptions requestOptions)
MessageDetails	cancel(java.lang.String messageId)	Cancel a message that is currently in the process of being delivered.
MessageDetails	cancel(java.lang.String messageId, IdempotentRequestOptions requestOptions)	Cancel a message that is currently in the process of being delivered.
MessageDetailsExtended	get(java.lang.String messageId)	Fetch the status of a message you've previously sent.
MessageDetailsExtended	get(java.lang.String messageId, RequestOptions requestOptions)	Fetch the status of a message you've previously sent.
RenderOutputResponse	getContent(java.lang.String messageId)
RenderOutputResponse	getContent(java.lang.String messageId, RequestOptions requestOptions)
MessageHistoryResponse	getHistory(java.lang.String messageId)	Fetch the array of events of a message you've previously sent.
MessageHistoryResponse	getHistory(java.lang.String messageId, GetMessageHistoryRequest request)	Fetch the array of events of a message you've previously sent.
MessageHistoryResponse	getHistory(java.lang.String messageId, GetMessageHistoryRequest request, RequestOptions requestOptions)	Fetch the array of events of a message you've previously sent.
ListMessagesResponse	list()	Fetch the statuses of messages you've previously sent.
ListMessagesResponse	list(ListMessagesRequest request)	Fetch the statuses of messages you've previously sent.
ListMessagesResponse	list(ListMessagesRequest request, RequestOptions requestOptions)	Fetch the statuses of messages you've previously sent.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

MessagesClient

public MessagesClient(ClientOptions clientOptions)

Method Detail

list

public ListMessagesResponse list()

Fetch the statuses of messages you've previously sent.

list

public ListMessagesResponse list(ListMessagesRequest request)

Fetch the statuses of messages you've previously sent.

list

public ListMessagesResponse list(ListMessagesRequest request,
                                 RequestOptions requestOptions)

Fetch the statuses of messages you've previously sent.

get

public MessageDetailsExtended get(java.lang.String messageId)

Fetch the status of a message you've previously sent.

get

public MessageDetailsExtended get(java.lang.String messageId,
                                  RequestOptions requestOptions)

Fetch the status of a message you've previously sent.

cancel

public MessageDetails cancel(java.lang.String messageId)

Cancel a message that is currently in the process of being delivered. A well-formatted API call to the cancel message API will return either 200 status code for a successful cancellation or 409 status code for an unsuccessful cancellation. Both cases will include the actual message record in the response body (see details below).

cancel

public MessageDetails cancel(java.lang.String messageId,
                             IdempotentRequestOptions requestOptions)

Cancel a message that is currently in the process of being delivered. A well-formatted API call to the cancel message API will return either 200 status code for a successful cancellation or 409 status code for an unsuccessful cancellation. Both cases will include the actual message record in the response body (see details below).

getHistory

public MessageHistoryResponse getHistory(java.lang.String messageId)

Fetch the array of events of a message you've previously sent.

getHistory

public MessageHistoryResponse getHistory(java.lang.String messageId,
                                         GetMessageHistoryRequest request)

Fetch the array of events of a message you've previously sent.

getHistory

public MessageHistoryResponse getHistory(java.lang.String messageId,
                                         GetMessageHistoryRequest request,
                                         RequestOptions requestOptions)

Fetch the array of events of a message you've previously sent.

getContent

public RenderOutputResponse getContent(java.lang.String messageId)

getContent

public RenderOutputResponse getContent(java.lang.String messageId,
                                       RequestOptions requestOptions)

archive

public void archive(java.lang.String requestId)

archive

public void archive(java.lang.String requestId,
                    RequestOptions requestOptions)