ClickSend.Api

Class SmsApi

java.lang.Object

ClickSend.Api.SmsApi

public class SmsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SmsApi()
SmsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
String	smsCancelAllPut() Update all scheduled message as cancelled Update all scheduled message as cancelled
com.squareup.okhttp.Call	smsCancelAllPutAsync(ApiCallback<String> callback) Update all scheduled message as cancelled (asynchronously) Update all scheduled message as cancelled
com.squareup.okhttp.Call	smsCancelAllPutCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsCancelAllPut
ApiResponse<String>	smsCancelAllPutWithHttpInfo() Update all scheduled message as cancelled Update all scheduled message as cancelled
String	smsCancelByMessageIdPut(String messageId) Update scheduled message as cancelled Update scheduled message as cancelled
com.squareup.okhttp.Call	smsCancelByMessageIdPutAsync(String messageId, ApiCallback<String> callback) Update scheduled message as cancelled (asynchronously) Update scheduled message as cancelled
com.squareup.okhttp.Call	smsCancelByMessageIdPutCall(String messageId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsCancelByMessageIdPut
ApiResponse<String>	smsCancelByMessageIdPutWithHttpInfo(String messageId) Update scheduled message as cancelled Update scheduled message as cancelled
String	smsHistoryExportGet(String filename) Export all sms history Export all sms history
com.squareup.okhttp.Call	smsHistoryExportGetAsync(String filename, ApiCallback<String> callback) Export all sms history (asynchronously) Export all sms history
com.squareup.okhttp.Call	smsHistoryExportGetCall(String filename, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsHistoryExportGet
ApiResponse<String>	smsHistoryExportGetWithHttpInfo(String filename) Export all sms history Export all sms history
String	smsHistoryGet(String q, Integer dateFrom, Integer dateTo, Integer page, Integer limit) Get all sms history Get all sms history
com.squareup.okhttp.Call	smsHistoryGetAsync(String q, Integer dateFrom, Integer dateTo, Integer page, Integer limit, ApiCallback<String> callback) Get all sms history (asynchronously) Get all sms history
com.squareup.okhttp.Call	smsHistoryGetCall(String q, Integer dateFrom, Integer dateTo, Integer page, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsHistoryGet
ApiResponse<String>	smsHistoryGetWithHttpInfo(String q, Integer dateFrom, Integer dateTo, Integer page, Integer limit) Get all sms history Get all sms history
String	smsInboundGet(String q, Integer page, Integer limit) Get all inbound sms Get all inbound sms
com.squareup.okhttp.Call	smsInboundGetAsync(String q, Integer page, Integer limit, ApiCallback<String> callback) Get all inbound sms (asynchronously) Get all inbound sms
com.squareup.okhttp.Call	smsInboundGetCall(String q, Integer page, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsInboundGet
ApiResponse<String>	smsInboundGetWithHttpInfo(String q, Integer page, Integer limit) Get all inbound sms Get all inbound sms
String	smsInboundPost(Url url) Create inbound sms Create inbound sms
com.squareup.okhttp.Call	smsInboundPostAsync(Url url, ApiCallback<String> callback) Create inbound sms (asynchronously) Create inbound sms
com.squareup.okhttp.Call	smsInboundPostCall(Url url, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsInboundPost
ApiResponse<String>	smsInboundPostWithHttpInfo(Url url) Create inbound sms Create inbound sms
String	smsInboundReadByMessageIdPut(String messageId) Mark inbound SMS as read Mark specific inbound SMS as read
com.squareup.okhttp.Call	smsInboundReadByMessageIdPutAsync(String messageId, ApiCallback<String> callback) Mark inbound SMS as read (asynchronously) Mark specific inbound SMS as read
com.squareup.okhttp.Call	smsInboundReadByMessageIdPutCall(String messageId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsInboundReadByMessageIdPut
ApiResponse<String>	smsInboundReadByMessageIdPutWithHttpInfo(String messageId) Mark inbound SMS as read Mark specific inbound SMS as read
String	smsInboundReadPut(DateBefore dateBefore) Mark inbound SMS as read Mark all inbound SMS as read optionally before a certain date
com.squareup.okhttp.Call	smsInboundReadPutAsync(DateBefore dateBefore, ApiCallback<String> callback) Mark inbound SMS as read (asynchronously) Mark all inbound SMS as read optionally before a certain date
com.squareup.okhttp.Call	smsInboundReadPutCall(DateBefore dateBefore, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsInboundReadPut
ApiResponse<String>	smsInboundReadPutWithHttpInfo(DateBefore dateBefore) Mark inbound SMS as read Mark all inbound SMS as read optionally before a certain date
String	smsPricePost(SmsMessageCollection smsMessages) Calculate sms price Calculate sms price
com.squareup.okhttp.Call	smsPricePostAsync(SmsMessageCollection smsMessages, ApiCallback<String> callback) Calculate sms price (asynchronously) Calculate sms price
com.squareup.okhttp.Call	smsPricePostCall(SmsMessageCollection smsMessages, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsPricePost
ApiResponse<String>	smsPricePostWithHttpInfo(SmsMessageCollection smsMessages) Calculate sms price Calculate sms price
String	smsReceiptsByMessageIdGet(String messageId) Get a Specific Delivery Receipt Get a Specific Delivery Receipt
com.squareup.okhttp.Call	smsReceiptsByMessageIdGetAsync(String messageId, ApiCallback<String> callback) Get a Specific Delivery Receipt (asynchronously) Get a Specific Delivery Receipt
com.squareup.okhttp.Call	smsReceiptsByMessageIdGetCall(String messageId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsReceiptsByMessageIdGet
ApiResponse<String>	smsReceiptsByMessageIdGetWithHttpInfo(String messageId) Get a Specific Delivery Receipt Get a Specific Delivery Receipt
String	smsReceiptsGet(Integer page, Integer limit) Get all delivery receipts Get all delivery receipts
com.squareup.okhttp.Call	smsReceiptsGetAsync(Integer page, Integer limit, ApiCallback<String> callback) Get all delivery receipts (asynchronously) Get all delivery receipts
com.squareup.okhttp.Call	smsReceiptsGetCall(Integer page, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsReceiptsGet
ApiResponse<String>	smsReceiptsGetWithHttpInfo(Integer page, Integer limit) Get all delivery receipts Get all delivery receipts
String	smsReceiptsPost(Url url) Add a delivery receipt Add a delivery receipt
com.squareup.okhttp.Call	smsReceiptsPostAsync(Url url, ApiCallback<String> callback) Add a delivery receipt (asynchronously) Add a delivery receipt
com.squareup.okhttp.Call	smsReceiptsPostCall(Url url, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsReceiptsPost
ApiResponse<String>	smsReceiptsPostWithHttpInfo(Url url) Add a delivery receipt Add a delivery receipt
String	smsReceiptsReadPut(DateBefore dateBefore) Mark delivery receipts as read Mark delivery receipts as read
com.squareup.okhttp.Call	smsReceiptsReadPutAsync(DateBefore dateBefore, ApiCallback<String> callback) Mark delivery receipts as read (asynchronously) Mark delivery receipts as read
com.squareup.okhttp.Call	smsReceiptsReadPutCall(DateBefore dateBefore, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsReceiptsReadPut
ApiResponse<String>	smsReceiptsReadPutWithHttpInfo(DateBefore dateBefore) Mark delivery receipts as read Mark delivery receipts as read
String	smsSendPost(SmsMessageCollection smsMessages) Send sms message(s) # Send one or more SMS messages You can post up to 1000 messages with each API call.
com.squareup.okhttp.Call	smsSendPostAsync(SmsMessageCollection smsMessages, ApiCallback<String> callback) Send sms message(s) (asynchronously) # Send one or more SMS messages You can post up to 1000 messages with each API call.
com.squareup.okhttp.Call	smsSendPostCall(SmsMessageCollection smsMessages, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsSendPost
ApiResponse<String>	smsSendPostWithHttpInfo(SmsMessageCollection smsMessages) Send sms message(s) # Send one or more SMS messages You can post up to 1000 messages with each API call.
String	smsTemplatesByTemplateIdDelete(Integer templateId) Delete sms template Delete sms template
com.squareup.okhttp.Call	smsTemplatesByTemplateIdDeleteAsync(Integer templateId, ApiCallback<String> callback) Delete sms template (asynchronously) Delete sms template
com.squareup.okhttp.Call	smsTemplatesByTemplateIdDeleteCall(Integer templateId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsTemplatesByTemplateIdDelete
ApiResponse<String>	smsTemplatesByTemplateIdDeleteWithHttpInfo(Integer templateId) Delete sms template Delete sms template
String	smsTemplatesByTemplateIdPut(Integer templateId, SmsTemplate smsTemplate) Update sms template Update sms template
com.squareup.okhttp.Call	smsTemplatesByTemplateIdPutAsync(Integer templateId, SmsTemplate smsTemplate, ApiCallback<String> callback) Update sms template (asynchronously) Update sms template
com.squareup.okhttp.Call	smsTemplatesByTemplateIdPutCall(Integer templateId, SmsTemplate smsTemplate, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsTemplatesByTemplateIdPut
ApiResponse<String>	smsTemplatesByTemplateIdPutWithHttpInfo(Integer templateId, SmsTemplate smsTemplate) Update sms template Update sms template
String	smsTemplatesGet(Integer page, Integer limit) Get lists of all sms templates Get lists of all sms templates
com.squareup.okhttp.Call	smsTemplatesGetAsync(Integer page, Integer limit, ApiCallback<String> callback) Get lists of all sms templates (asynchronously) Get lists of all sms templates
com.squareup.okhttp.Call	smsTemplatesGetCall(Integer page, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsTemplatesGet
ApiResponse<String>	smsTemplatesGetWithHttpInfo(Integer page, Integer limit) Get lists of all sms templates Get lists of all sms templates
String	smsTemplatesPost(SmsTemplate smsTemplate) Create sms template Create sms template
com.squareup.okhttp.Call	smsTemplatesPostAsync(SmsTemplate smsTemplate, ApiCallback<String> callback) Create sms template (asynchronously) Create sms template
com.squareup.okhttp.Call	smsTemplatesPostCall(SmsTemplate smsTemplate, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsTemplatesPost
ApiResponse<String>	smsTemplatesPostWithHttpInfo(SmsTemplate smsTemplate) Create sms template Create sms template

Methods inherited from class java.lang.Object

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

Constructor Detail

SmsApi

public SmsApi()

SmsApi

public SmsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

smsCancelAllPutCall

public com.squareup.okhttp.Call smsCancelAllPutCall(ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for smsCancelAllPut

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsCancelAllPut

public String smsCancelAllPut()
                       throws ApiException

Update all scheduled message as cancelled Update all scheduled message as cancelled

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsCancelAllPutWithHttpInfo

public ApiResponse<String> smsCancelAllPutWithHttpInfo()
                                                throws ApiException

Update all scheduled message as cancelled Update all scheduled message as cancelled

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsCancelAllPutAsync

public com.squareup.okhttp.Call smsCancelAllPutAsync(ApiCallback<String> callback)
                                              throws ApiException

Update all scheduled message as cancelled (asynchronously) Update all scheduled message as cancelled

Parameters:

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

smsCancelByMessageIdPutCall

public com.squareup.okhttp.Call smsCancelByMessageIdPutCall(String messageId,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for smsCancelByMessageIdPut

Parameters:

messageId - The message ID you want to cancel (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsCancelByMessageIdPut

public String smsCancelByMessageIdPut(String messageId)
                               throws ApiException

Update scheduled message as cancelled Update scheduled message as cancelled

Parameters:

messageId - The message ID you want to cancel (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsCancelByMessageIdPutWithHttpInfo

public ApiResponse<String> smsCancelByMessageIdPutWithHttpInfo(String messageId)
                                                        throws ApiException

Update scheduled message as cancelled Update scheduled message as cancelled

Parameters:

messageId - The message ID you want to cancel (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsCancelByMessageIdPutAsync

public com.squareup.okhttp.Call smsCancelByMessageIdPutAsync(String messageId,
                                                             ApiCallback<String> callback)
                                                      throws ApiException

Update scheduled message as cancelled (asynchronously) Update scheduled message as cancelled

Parameters:

messageId - The message ID you want to cancel (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

smsHistoryExportGetCall

public com.squareup.okhttp.Call smsHistoryExportGetCall(String filename,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for smsHistoryExportGet

Parameters:

filename - Filename to download history as (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsHistoryExportGet

public String smsHistoryExportGet(String filename)
                           throws ApiException

Export all sms history Export all sms history

Parameters:

filename - Filename to download history as (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsHistoryExportGetWithHttpInfo

public ApiResponse<String> smsHistoryExportGetWithHttpInfo(String filename)
                                                    throws ApiException

Export all sms history Export all sms history

Parameters:

filename - Filename to download history as (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsHistoryExportGetAsync

public com.squareup.okhttp.Call smsHistoryExportGetAsync(String filename,
                                                         ApiCallback<String> callback)
                                                  throws ApiException

Export all sms history (asynchronously) Export all sms history

Parameters:

filename - Filename to download history as (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

smsHistoryGetCall

public com.squareup.okhttp.Call smsHistoryGetCall(String q,
                                                  Integer dateFrom,
                                                  Integer dateTo,
                                                  Integer page,
                                                  Integer limit,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for smsHistoryGet

Parameters:

q - Custom query Example: from:{number},status_code:201. (optional)

dateFrom - Start date (optional)

dateTo - End date (optional)

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsHistoryGet

public String smsHistoryGet(String q,
                            Integer dateFrom,
                            Integer dateTo,
                            Integer page,
                            Integer limit)
                     throws ApiException

Get all sms history Get all sms history

Parameters:

q - Custom query Example: from:{number},status_code:201. (optional)

dateFrom - Start date (optional)

dateTo - End date (optional)

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsHistoryGetWithHttpInfo

public ApiResponse<String> smsHistoryGetWithHttpInfo(String q,
                                                     Integer dateFrom,
                                                     Integer dateTo,
                                                     Integer page,
                                                     Integer limit)
                                              throws ApiException

Get all sms history Get all sms history

Parameters:

q - Custom query Example: from:{number},status_code:201. (optional)

dateFrom - Start date (optional)

dateTo - End date (optional)

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsHistoryGetAsync

public com.squareup.okhttp.Call smsHistoryGetAsync(String q,
                                                   Integer dateFrom,
                                                   Integer dateTo,
                                                   Integer page,
                                                   Integer limit,
                                                   ApiCallback<String> callback)
                                            throws ApiException

Get all sms history (asynchronously) Get all sms history

Parameters:

q - Custom query Example: from:{number},status_code:201. (optional)

dateFrom - Start date (optional)

dateTo - End date (optional)

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

smsInboundGetCall

public com.squareup.okhttp.Call smsInboundGetCall(String q,
                                                  Integer page,
                                                  Integer limit,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for smsInboundGet

Parameters:

q - Your keyword or query. (optional)

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsInboundGet

public String smsInboundGet(String q,
                            Integer page,
                            Integer limit)
                     throws ApiException

Get all inbound sms Get all inbound sms

Parameters:

q - Your keyword or query. (optional)

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsInboundGetWithHttpInfo

public ApiResponse<String> smsInboundGetWithHttpInfo(String q,
                                                     Integer page,
                                                     Integer limit)
                                              throws ApiException

Get all inbound sms Get all inbound sms

Parameters:

q - Your keyword or query. (optional)

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsInboundGetAsync

public com.squareup.okhttp.Call smsInboundGetAsync(String q,
                                                   Integer page,
                                                   Integer limit,
                                                   ApiCallback<String> callback)
                                            throws ApiException

Get all inbound sms (asynchronously) Get all inbound sms

Parameters:

q - Your keyword or query. (optional)

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

smsInboundPostCall

public com.squareup.okhttp.Call smsInboundPostCall(Url url,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for smsInboundPost

Parameters:

url - Url model (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsInboundPost

public String smsInboundPost(Url url)
                      throws ApiException

Create inbound sms Create inbound sms

Parameters:

url - Url model (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsInboundPostWithHttpInfo

public ApiResponse<String> smsInboundPostWithHttpInfo(Url url)
                                               throws ApiException

Create inbound sms Create inbound sms

Parameters:

url - Url model (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsInboundPostAsync

public com.squareup.okhttp.Call smsInboundPostAsync(Url url,
                                                    ApiCallback<String> callback)
                                             throws ApiException

Create inbound sms (asynchronously) Create inbound sms

Parameters:

url - Url model (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

smsInboundReadByMessageIdPutCall

public com.squareup.okhttp.Call smsInboundReadByMessageIdPutCall(String messageId,
                                                                 ProgressResponseBody.ProgressListener progressListener,
                                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                          throws ApiException

Build call for smsInboundReadByMessageIdPut

Parameters:

messageId - Message ID (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsInboundReadByMessageIdPut

public String smsInboundReadByMessageIdPut(String messageId)
                                    throws ApiException

Mark inbound SMS as read Mark specific inbound SMS as read

Parameters:

messageId - Message ID (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsInboundReadByMessageIdPutWithHttpInfo

public ApiResponse<String> smsInboundReadByMessageIdPutWithHttpInfo(String messageId)
                                                             throws ApiException

Mark inbound SMS as read Mark specific inbound SMS as read

Parameters:

messageId - Message ID (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsInboundReadByMessageIdPutAsync

public com.squareup.okhttp.Call smsInboundReadByMessageIdPutAsync(String messageId,
                                                                  ApiCallback<String> callback)
                                                           throws ApiException

Mark inbound SMS as read (asynchronously) Mark specific inbound SMS as read

Parameters:

messageId - Message ID (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

smsInboundReadPutCall

public com.squareup.okhttp.Call smsInboundReadPutCall(DateBefore dateBefore,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for smsInboundReadPut

Parameters:

dateBefore - DateBefore model (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsInboundReadPut

public String smsInboundReadPut(DateBefore dateBefore)
                         throws ApiException

Mark inbound SMS as read Mark all inbound SMS as read optionally before a certain date

Parameters:

dateBefore - DateBefore model (optional)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsInboundReadPutWithHttpInfo

public ApiResponse<String> smsInboundReadPutWithHttpInfo(DateBefore dateBefore)
                                                  throws ApiException

Mark inbound SMS as read Mark all inbound SMS as read optionally before a certain date

Parameters:

dateBefore - DateBefore model (optional)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsInboundReadPutAsync

public com.squareup.okhttp.Call smsInboundReadPutAsync(DateBefore dateBefore,
                                                       ApiCallback<String> callback)
                                                throws ApiException

Mark inbound SMS as read (asynchronously) Mark all inbound SMS as read optionally before a certain date

Parameters:

dateBefore - DateBefore model (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

smsPricePostCall

public com.squareup.okhttp.Call smsPricePostCall(SmsMessageCollection smsMessages,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for smsPricePost

Parameters:

smsMessages - SmsMessageCollection model (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsPricePost

public String smsPricePost(SmsMessageCollection smsMessages)
                    throws ApiException

Calculate sms price Calculate sms price

Parameters:

smsMessages - SmsMessageCollection model (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsPricePostWithHttpInfo

public ApiResponse<String> smsPricePostWithHttpInfo(SmsMessageCollection smsMessages)
                                             throws ApiException

Calculate sms price Calculate sms price

Parameters:

smsMessages - SmsMessageCollection model (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsPricePostAsync

public com.squareup.okhttp.Call smsPricePostAsync(SmsMessageCollection smsMessages,
                                                  ApiCallback<String> callback)
                                           throws ApiException

Calculate sms price (asynchronously) Calculate sms price

Parameters:

smsMessages - SmsMessageCollection model (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

smsReceiptsByMessageIdGetCall

public com.squareup.okhttp.Call smsReceiptsByMessageIdGetCall(String messageId,
                                                              ProgressResponseBody.ProgressListener progressListener,
                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                       throws ApiException

Build call for smsReceiptsByMessageIdGet

Parameters:

messageId - Message ID (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsReceiptsByMessageIdGet

public String smsReceiptsByMessageIdGet(String messageId)
                                 throws ApiException

Get a Specific Delivery Receipt Get a Specific Delivery Receipt

Parameters:

messageId - Message ID (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsReceiptsByMessageIdGetWithHttpInfo

public ApiResponse<String> smsReceiptsByMessageIdGetWithHttpInfo(String messageId)
                                                          throws ApiException

Get a Specific Delivery Receipt Get a Specific Delivery Receipt

Parameters:

messageId - Message ID (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsReceiptsByMessageIdGetAsync

public com.squareup.okhttp.Call smsReceiptsByMessageIdGetAsync(String messageId,
                                                               ApiCallback<String> callback)
                                                        throws ApiException

Get a Specific Delivery Receipt (asynchronously) Get a Specific Delivery Receipt

Parameters:

messageId - Message ID (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

smsReceiptsGetCall

public com.squareup.okhttp.Call smsReceiptsGetCall(Integer page,
                                                   Integer limit,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for smsReceiptsGet

Parameters:

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsReceiptsGet

public String smsReceiptsGet(Integer page,
                             Integer limit)
                      throws ApiException

Get all delivery receipts Get all delivery receipts

Parameters:

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsReceiptsGetWithHttpInfo

public ApiResponse<String> smsReceiptsGetWithHttpInfo(Integer page,
                                                      Integer limit)
                                               throws ApiException

Get all delivery receipts Get all delivery receipts

Parameters:

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsReceiptsGetAsync

public com.squareup.okhttp.Call smsReceiptsGetAsync(Integer page,
                                                    Integer limit,
                                                    ApiCallback<String> callback)
                                             throws ApiException

Get all delivery receipts (asynchronously) Get all delivery receipts

Parameters:

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

smsReceiptsPostCall

public com.squareup.okhttp.Call smsReceiptsPostCall(Url url,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for smsReceiptsPost

Parameters:

url - Url model (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsReceiptsPost

public String smsReceiptsPost(Url url)
                       throws ApiException

Add a delivery receipt Add a delivery receipt

Parameters:

url - Url model (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsReceiptsPostWithHttpInfo

public ApiResponse<String> smsReceiptsPostWithHttpInfo(Url url)
                                                throws ApiException

Add a delivery receipt Add a delivery receipt

Parameters:

url - Url model (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsReceiptsPostAsync

public com.squareup.okhttp.Call smsReceiptsPostAsync(Url url,
                                                     ApiCallback<String> callback)
                                              throws ApiException

Add a delivery receipt (asynchronously) Add a delivery receipt

Parameters:

url - Url model (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

smsReceiptsReadPutCall

public com.squareup.okhttp.Call smsReceiptsReadPutCall(DateBefore dateBefore,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for smsReceiptsReadPut

Parameters:

dateBefore - DateBefore model (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsReceiptsReadPut

public String smsReceiptsReadPut(DateBefore dateBefore)
                          throws ApiException

Mark delivery receipts as read Mark delivery receipts as read

Parameters:

dateBefore - DateBefore model (optional)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsReceiptsReadPutWithHttpInfo

public ApiResponse<String> smsReceiptsReadPutWithHttpInfo(DateBefore dateBefore)
                                                   throws ApiException

Mark delivery receipts as read Mark delivery receipts as read

Parameters:

dateBefore - DateBefore model (optional)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsReceiptsReadPutAsync

public com.squareup.okhttp.Call smsReceiptsReadPutAsync(DateBefore dateBefore,
                                                        ApiCallback<String> callback)
                                                 throws ApiException

Mark delivery receipts as read (asynchronously) Mark delivery receipts as read

Parameters:

dateBefore - DateBefore model (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

smsSendPostCall

public com.squareup.okhttp.Call smsSendPostCall(SmsMessageCollection smsMessages,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for smsSendPost

Parameters:

smsMessages - SmsMessageCollection model (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsSendPost

public String smsSendPost(SmsMessageCollection smsMessages)
                   throws ApiException

Send sms message(s) # Send one or more SMS messages You can post up to 1000 messages with each API call. You can send to a mix of contacts and contact lists, as long as the total number of recipients is up to 1000. The response contains status and details for each recipient. *Refer to [Application Status Codes](https://dashboard.clicksend.com/#/signup/step1/) for the possible response message status strings.*

Parameters:

smsMessages - SmsMessageCollection model (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsSendPostWithHttpInfo

public ApiResponse<String> smsSendPostWithHttpInfo(SmsMessageCollection smsMessages)
                                            throws ApiException

Send sms message(s) # Send one or more SMS messages You can post up to 1000 messages with each API call. You can send to a mix of contacts and contact lists, as long as the total number of recipients is up to 1000. The response contains status and details for each recipient. *Refer to [Application Status Codes](https://dashboard.clicksend.com/#/signup/step1/) for the possible response message status strings.*

Parameters:

smsMessages - SmsMessageCollection model (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsSendPostAsync

public com.squareup.okhttp.Call smsSendPostAsync(SmsMessageCollection smsMessages,
                                                 ApiCallback<String> callback)
                                          throws ApiException

Send sms message(s) (asynchronously) # Send one or more SMS messages You can post up to 1000 messages with each API call. You can send to a mix of contacts and contact lists, as long as the total number of recipients is up to 1000. The response contains status and details for each recipient. *Refer to [Application Status Codes](https://dashboard.clicksend.com/#/signup/step1/) for the possible response message status strings.*

Parameters:

smsMessages - SmsMessageCollection model (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

smsTemplatesByTemplateIdDeleteCall

public com.squareup.okhttp.Call smsTemplatesByTemplateIdDeleteCall(Integer templateId,
                                                                   ProgressResponseBody.ProgressListener progressListener,
                                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                            throws ApiException

Build call for smsTemplatesByTemplateIdDelete

Parameters:

templateId - Template id (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsTemplatesByTemplateIdDelete

public String smsTemplatesByTemplateIdDelete(Integer templateId)
                                      throws ApiException

Delete sms template Delete sms template

Parameters:

templateId - Template id (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsTemplatesByTemplateIdDeleteWithHttpInfo

public ApiResponse<String> smsTemplatesByTemplateIdDeleteWithHttpInfo(Integer templateId)
                                                               throws ApiException

Delete sms template Delete sms template

Parameters:

templateId - Template id (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsTemplatesByTemplateIdDeleteAsync

public com.squareup.okhttp.Call smsTemplatesByTemplateIdDeleteAsync(Integer templateId,
                                                                    ApiCallback<String> callback)
                                                             throws ApiException

Delete sms template (asynchronously) Delete sms template

Parameters:

templateId - Template id (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

smsTemplatesByTemplateIdPutCall

public com.squareup.okhttp.Call smsTemplatesByTemplateIdPutCall(Integer templateId,
                                                                SmsTemplate smsTemplate,
                                                                ProgressResponseBody.ProgressListener progressListener,
                                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                         throws ApiException

Build call for smsTemplatesByTemplateIdPut

Parameters:

templateId - Template id (required)

smsTemplate - Template item (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsTemplatesByTemplateIdPut

public String smsTemplatesByTemplateIdPut(Integer templateId,
                                          SmsTemplate smsTemplate)
                                   throws ApiException

Update sms template Update sms template

Parameters:

templateId - Template id (required)

smsTemplate - Template item (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsTemplatesByTemplateIdPutWithHttpInfo

public ApiResponse<String> smsTemplatesByTemplateIdPutWithHttpInfo(Integer templateId,
                                                                   SmsTemplate smsTemplate)
                                                            throws ApiException

Update sms template Update sms template

Parameters:

templateId - Template id (required)

smsTemplate - Template item (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsTemplatesByTemplateIdPutAsync

public com.squareup.okhttp.Call smsTemplatesByTemplateIdPutAsync(Integer templateId,
                                                                 SmsTemplate smsTemplate,
                                                                 ApiCallback<String> callback)
                                                          throws ApiException

Update sms template (asynchronously) Update sms template

Parameters:

templateId - Template id (required)

smsTemplate - Template item (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

smsTemplatesGetCall

public com.squareup.okhttp.Call smsTemplatesGetCall(Integer page,
                                                    Integer limit,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for smsTemplatesGet

Parameters:

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsTemplatesGet

public String smsTemplatesGet(Integer page,
                              Integer limit)
                       throws ApiException

Get lists of all sms templates Get lists of all sms templates

Parameters:

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsTemplatesGetWithHttpInfo

public ApiResponse<String> smsTemplatesGetWithHttpInfo(Integer page,
                                                       Integer limit)
                                                throws ApiException

Get lists of all sms templates Get lists of all sms templates

Parameters:

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsTemplatesGetAsync

public com.squareup.okhttp.Call smsTemplatesGetAsync(Integer page,
                                                     Integer limit,
                                                     ApiCallback<String> callback)
                                              throws ApiException

Get lists of all sms templates (asynchronously) Get lists of all sms templates

Parameters:

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

smsTemplatesPostCall

public com.squareup.okhttp.Call smsTemplatesPostCall(SmsTemplate smsTemplate,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for smsTemplatesPost

Parameters:

smsTemplate - SmsTemplate model (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsTemplatesPost

public String smsTemplatesPost(SmsTemplate smsTemplate)
                        throws ApiException

Create sms template Create sms template

Parameters:

smsTemplate - SmsTemplate model (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsTemplatesPostWithHttpInfo

public ApiResponse<String> smsTemplatesPostWithHttpInfo(SmsTemplate smsTemplate)
                                                 throws ApiException

Create sms template Create sms template

Parameters:

smsTemplate - SmsTemplate model (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

smsTemplatesPostAsync

public com.squareup.okhttp.Call smsTemplatesPostAsync(SmsTemplate smsTemplate,
                                                      ApiCallback<String> callback)
                                               throws ApiException

Create sms template (asynchronously) Create sms template

Parameters:

smsTemplate - SmsTemplate model (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object