Package com.courier.api.types

Class SendMessageResponse.Builder

java.lang.Object

com.courier.api.types.SendMessageResponse.Builder

All Implemented Interfaces:

SendMessageResponse._FinalStage, SendMessageResponse.RequestIdStage

Enclosing class:

SendMessageResponse

public static final class SendMessageResponse.Builder
extends java.lang.Object
implements SendMessageResponse.RequestIdStage, SendMessageResponse._FinalStage

Method Summary

Modifier and Type	Method	Description
SendMessageResponse	build()
SendMessageResponse.Builder	from(SendMessageResponse other)
SendMessageResponse._FinalStage	requestId(java.lang.String requestId)	A successful call to POST /send returns a 202 status code along with a requestId in the response body.

Methods inherited from class java.lang.Object

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

Method Detail

from

public SendMessageResponse.Builder from(SendMessageResponse other)

Specified by:

from in interface SendMessageResponse.RequestIdStage

requestId

public SendMessageResponse._FinalStage requestId(java.lang.String requestId)

A successful call to POST /send returns a 202 status code along with a requestId in the response body.

For send requests that have a single recipient, the requestId is assigned to the derived message as its message_id. Therefore the requestId can be supplied to the Message's API for single recipient messages.

For send requests that have multiple recipients (accounts, audiences, lists, etc.), Courier assigns a unique id to each derived message as its message_id. Therefore the requestId cannot be supplied to the Message's API for single-recipient messages.

Specified by:

requestId in interface SendMessageResponse.RequestIdStage

Returns:

Reference to this so that method calls can be chained together.

build

public SendMessageResponse build()

Specified by:

build in interface SendMessageResponse._FinalStage