ClickSend.Api

Class TransactionalEmailApi

java.lang.Object

ClickSend.Api.TransactionalEmailApi

public class TransactionalEmailApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TransactionalEmailApi()
TransactionalEmailApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
String	emailHistoryExportGet(String filename, Integer dateFrom, Integer dateTo) Export all Transactional Email history Export all Transactional Email history
com.squareup.okhttp.Call	emailHistoryExportGetAsync(String filename, Integer dateFrom, Integer dateTo, ApiCallback<String> callback) Export all Transactional Email history (asynchronously) Export all Transactional Email history
com.squareup.okhttp.Call	emailHistoryExportGetCall(String filename, Integer dateFrom, Integer dateTo, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for emailHistoryExportGet
ApiResponse<String>	emailHistoryExportGetWithHttpInfo(String filename, Integer dateFrom, Integer dateTo) Export all Transactional Email history Export all Transactional Email history
String	emailHistoryGet(Integer dateFrom, Integer dateTo, Integer page, Integer limit) Get all transactional email history Get all transactional email history
com.squareup.okhttp.Call	emailHistoryGetAsync(Integer dateFrom, Integer dateTo, Integer page, Integer limit, ApiCallback<String> callback) Get all transactional email history (asynchronously) Get all transactional email history
com.squareup.okhttp.Call	emailHistoryGetCall(Integer dateFrom, Integer dateTo, Integer page, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for emailHistoryGet
ApiResponse<String>	emailHistoryGetWithHttpInfo(Integer dateFrom, Integer dateTo, Integer page, Integer limit) Get all transactional email history Get all transactional email history
String	emailPricePost(Email email) Get transactional email price Get transactional email price
com.squareup.okhttp.Call	emailPricePostAsync(Email email, ApiCallback<String> callback) Get transactional email price (asynchronously) Get transactional email price
com.squareup.okhttp.Call	emailPricePostCall(Email email, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for emailPricePost
ApiResponse<String>	emailPricePostWithHttpInfo(Email email) Get transactional email price Get transactional email price
String	emailSendPost(Email email) Send transactional email Send transactional email
com.squareup.okhttp.Call	emailSendPostAsync(Email email, ApiCallback<String> callback) Send transactional email (asynchronously) Send transactional email
com.squareup.okhttp.Call	emailSendPostCall(Email email, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for emailSendPost
ApiResponse<String>	emailSendPostWithHttpInfo(Email email) Send transactional email Send transactional email
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionalEmailApi

public TransactionalEmailApi()

TransactionalEmailApi

public TransactionalEmailApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

emailHistoryExportGetCall

public com.squareup.okhttp.Call emailHistoryExportGetCall(String filename,
                                                          Integer dateFrom,
                                                          Integer dateTo,
                                                          ProgressResponseBody.ProgressListener progressListener,
                                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                   throws ApiException

Build call for emailHistoryExportGet

Parameters:

filename - Filename to download history as (required)

dateFrom - Start date (optional)

dateTo - End date (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

emailHistoryExportGet

public String emailHistoryExportGet(String filename,
                                    Integer dateFrom,
                                    Integer dateTo)
                             throws ApiException

Export all Transactional Email history Export all Transactional Email history

Parameters:

filename - Filename to download history as (required)

dateFrom - Start date (optional)

dateTo - End date (optional)

Returns:

String

Throws:

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

emailHistoryExportGetWithHttpInfo

public ApiResponse<String> emailHistoryExportGetWithHttpInfo(String filename,
                                                             Integer dateFrom,
                                                             Integer dateTo)
                                                      throws ApiException

Export all Transactional Email history Export all Transactional Email history

Parameters:

filename - Filename to download history as (required)

dateFrom - Start date (optional)

dateTo - End date (optional)

Returns:

ApiResponse<String>

Throws:

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

emailHistoryExportGetAsync

public com.squareup.okhttp.Call emailHistoryExportGetAsync(String filename,
                                                           Integer dateFrom,
                                                           Integer dateTo,
                                                           ApiCallback<String> callback)
                                                    throws ApiException

Export all Transactional Email history (asynchronously) Export all Transactional Email history

Parameters:

filename - Filename to download history as (required)

dateFrom - Start date (optional)

dateTo - End date (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

emailHistoryGetCall

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

Build call for emailHistoryGet

Parameters:

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

emailHistoryGet

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

Get all transactional email history Get all transactional email history

Parameters:

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

emailHistoryGetWithHttpInfo

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

Get all transactional email history Get all transactional email history

Parameters:

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

emailHistoryGetAsync

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

Get all transactional email history (asynchronously) Get all transactional email history

Parameters:

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

emailPricePostCall

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

Build call for emailPricePost

Parameters:

email - Email model (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

emailPricePost

public String emailPricePost(Email email)
                      throws ApiException

Get transactional email price Get transactional email price

Parameters:

email - Email model (required)

Returns:

String

Throws:

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

emailPricePostWithHttpInfo

public ApiResponse<String> emailPricePostWithHttpInfo(Email email)
                                               throws ApiException

Get transactional email price Get transactional email price

Parameters:

email - Email model (required)

Returns:

ApiResponse<String>

Throws:

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

emailPricePostAsync

public com.squareup.okhttp.Call emailPricePostAsync(Email email,
                                                    ApiCallback<String> callback)
                                             throws ApiException

Get transactional email price (asynchronously) Get transactional email price

Parameters:

email - Email 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

emailSendPostCall

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

Build call for emailSendPost

Parameters:

email - Email model (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

emailSendPost

public String emailSendPost(Email email)
                     throws ApiException

Send transactional email Send transactional email

Parameters:

email - Email model (required)

Returns:

String

Throws:

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

emailSendPostWithHttpInfo

public ApiResponse<String> emailSendPostWithHttpInfo(Email email)
                                              throws ApiException

Send transactional email Send transactional email

Parameters:

email - Email model (required)

Returns:

ApiResponse<String>

Throws:

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

emailSendPostAsync

public com.squareup.okhttp.Call emailSendPostAsync(Email email,
                                                   ApiCallback<String> callback)
                                            throws ApiException

Send transactional email (asynchronously) Send transactional email

Parameters:

email - Email 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