ClickSend.Api

Class FaxApi

java.lang.Object

ClickSend.Api.FaxApi

public class FaxApi
extends Object

Constructor Summary

Constructors

Constructor and Description
FaxApi()
FaxApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
String	faxHistoryGet(Integer dateFrom, Integer dateTo, String q, String order, Integer page, Integer limit) Get a list of Fax History.
com.squareup.okhttp.Call	faxHistoryGetAsync(Integer dateFrom, Integer dateTo, String q, String order, Integer page, Integer limit, ApiCallback<String> callback) Get a list of Fax History.
com.squareup.okhttp.Call	faxHistoryGetCall(Integer dateFrom, Integer dateTo, String q, String order, Integer page, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for faxHistoryGet
ApiResponse<String>	faxHistoryGetWithHttpInfo(Integer dateFrom, Integer dateTo, String q, String order, Integer page, Integer limit) Get a list of Fax History.
String	faxPricePost(FaxMessageCollection faxMessage) Calculate Total Price for Fax Messages sent Calculate Total Price for Fax Messages sent
com.squareup.okhttp.Call	faxPricePostAsync(FaxMessageCollection faxMessage, ApiCallback<String> callback) Calculate Total Price for Fax Messages sent (asynchronously) Calculate Total Price for Fax Messages sent
com.squareup.okhttp.Call	faxPricePostCall(FaxMessageCollection faxMessage, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for faxPricePost
ApiResponse<String>	faxPricePostWithHttpInfo(FaxMessageCollection faxMessage) Calculate Total Price for Fax Messages sent Calculate Total Price for Fax Messages sent
String	faxReceiptsByMessageIdGet(String messageId) Get a single fax receipt based on message id.
com.squareup.okhttp.Call	faxReceiptsByMessageIdGetAsync(String messageId, ApiCallback<String> callback) Get a single fax receipt based on message id.
com.squareup.okhttp.Call	faxReceiptsByMessageIdGetCall(String messageId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for faxReceiptsByMessageIdGet
ApiResponse<String>	faxReceiptsByMessageIdGetWithHttpInfo(String messageId) Get a single fax receipt based on message id.
String	faxReceiptsGet(Integer page, Integer limit) Get all delivery receipts Get all delivery receipts
com.squareup.okhttp.Call	faxReceiptsGetAsync(Integer page, Integer limit, ApiCallback<String> callback) Get all delivery receipts (asynchronously) Get all delivery receipts
com.squareup.okhttp.Call	faxReceiptsGetCall(Integer page, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for faxReceiptsGet
ApiResponse<String>	faxReceiptsGetWithHttpInfo(Integer page, Integer limit) Get all delivery receipts Get all delivery receipts
String	faxReceiptsPost(Url url) Add a delivery receipt Add a delivery receipt
com.squareup.okhttp.Call	faxReceiptsPostAsync(Url url, ApiCallback<String> callback) Add a delivery receipt (asynchronously) Add a delivery receipt
com.squareup.okhttp.Call	faxReceiptsPostCall(Url url, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for faxReceiptsPost
ApiResponse<String>	faxReceiptsPostWithHttpInfo(Url url) Add a delivery receipt Add a delivery receipt
String	faxReceiptsReadPut(DateBefore dateBefore) Mark delivery receipts as read Mark delivery receipts as read
com.squareup.okhttp.Call	faxReceiptsReadPutAsync(DateBefore dateBefore, ApiCallback<String> callback) Mark delivery receipts as read (asynchronously) Mark delivery receipts as read
com.squareup.okhttp.Call	faxReceiptsReadPutCall(DateBefore dateBefore, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for faxReceiptsReadPut
ApiResponse<String>	faxReceiptsReadPutWithHttpInfo(DateBefore dateBefore) Mark delivery receipts as read Mark delivery receipts as read
String	faxSendPost(FaxMessageCollection faxMessage) Send a fax using supplied supported file-types.
com.squareup.okhttp.Call	faxSendPostAsync(FaxMessageCollection faxMessage, ApiCallback<String> callback) Send a fax using supplied supported file-types.
com.squareup.okhttp.Call	faxSendPostCall(FaxMessageCollection faxMessage, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for faxSendPost
ApiResponse<String>	faxSendPostWithHttpInfo(FaxMessageCollection faxMessage) Send a fax using supplied supported file-types.
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

FaxApi

public FaxApi()

FaxApi

public FaxApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

faxHistoryGetCall

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

Build call for faxHistoryGet

Parameters:

dateFrom - Customize result by setting from date (timestsamp) Example: 1457572619. (optional)

dateTo - Customize result by setting to date (timestamp) Example: 1457573000. (optional)

q - Custom query Example: status:Sent,status_code:201. (optional)

order - Order result by Example: date_added:desc,list_id:desc. (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

faxHistoryGet

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

Get a list of Fax History. Get a list of Fax History.

Parameters:

dateFrom - Customize result by setting from date (timestsamp) Example: 1457572619. (optional)

dateTo - Customize result by setting to date (timestamp) Example: 1457573000. (optional)

q - Custom query Example: status:Sent,status_code:201. (optional)

order - Order result by Example: date_added:desc,list_id:desc. (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

faxHistoryGetWithHttpInfo

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

Get a list of Fax History. Get a list of Fax History.

Parameters:

dateFrom - Customize result by setting from date (timestsamp) Example: 1457572619. (optional)

dateTo - Customize result by setting to date (timestamp) Example: 1457573000. (optional)

q - Custom query Example: status:Sent,status_code:201. (optional)

order - Order result by Example: date_added:desc,list_id:desc. (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

faxHistoryGetAsync

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

Get a list of Fax History. (asynchronously) Get a list of Fax History.

Parameters:

dateFrom - Customize result by setting from date (timestsamp) Example: 1457572619. (optional)

dateTo - Customize result by setting to date (timestamp) Example: 1457573000. (optional)

q - Custom query Example: status:Sent,status_code:201. (optional)

order - Order result by Example: date_added:desc,list_id:desc. (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

faxPricePostCall

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

Build call for faxPricePost

Parameters:

faxMessage - FaxMessageCollection model (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

faxPricePost

public String faxPricePost(FaxMessageCollection faxMessage)
                    throws ApiException

Calculate Total Price for Fax Messages sent Calculate Total Price for Fax Messages sent

Parameters:

faxMessage - FaxMessageCollection model (required)

Returns:

String

Throws:

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

faxPricePostWithHttpInfo

public ApiResponse<String> faxPricePostWithHttpInfo(FaxMessageCollection faxMessage)
                                             throws ApiException

Calculate Total Price for Fax Messages sent Calculate Total Price for Fax Messages sent

Parameters:

faxMessage - FaxMessageCollection model (required)

Returns:

ApiResponse<String>

Throws:

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

faxPricePostAsync

public com.squareup.okhttp.Call faxPricePostAsync(FaxMessageCollection faxMessage,
                                                  ApiCallback<String> callback)
                                           throws ApiException

Calculate Total Price for Fax Messages sent (asynchronously) Calculate Total Price for Fax Messages sent

Parameters:

faxMessage - FaxMessageCollection 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

faxReceiptsByMessageIdGetCall

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

Build call for faxReceiptsByMessageIdGet

Parameters:

messageId - ID of the message receipt to retrieve (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

faxReceiptsByMessageIdGet

public String faxReceiptsByMessageIdGet(String messageId)
                                 throws ApiException

Get a single fax receipt based on message id. Get a single fax receipt based on message id.

Parameters:

messageId - ID of the message receipt to retrieve (required)

Returns:

String

Throws:

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

faxReceiptsByMessageIdGetWithHttpInfo

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

Get a single fax receipt based on message id. Get a single fax receipt based on message id.

Parameters:

messageId - ID of the message receipt to retrieve (required)

Returns:

ApiResponse<String>

Throws:

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

faxReceiptsByMessageIdGetAsync

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

Get a single fax receipt based on message id. (asynchronously) Get a single fax receipt based on message id.

Parameters:

messageId - ID of the message receipt to retrieve (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

faxReceiptsGetCall

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

Build call for faxReceiptsGet

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

faxReceiptsGet

public String faxReceiptsGet(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

faxReceiptsGetWithHttpInfo

public ApiResponse<String> faxReceiptsGetWithHttpInfo(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

faxReceiptsGetAsync

public com.squareup.okhttp.Call faxReceiptsGetAsync(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

faxReceiptsPostCall

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

Build call for faxReceiptsPost

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

faxReceiptsPost

public String faxReceiptsPost(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

faxReceiptsPostWithHttpInfo

public ApiResponse<String> faxReceiptsPostWithHttpInfo(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

faxReceiptsPostAsync

public com.squareup.okhttp.Call faxReceiptsPostAsync(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

faxReceiptsReadPutCall

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

Build call for faxReceiptsReadPut

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

faxReceiptsReadPut

public String faxReceiptsReadPut(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

faxReceiptsReadPutWithHttpInfo

public ApiResponse<String> faxReceiptsReadPutWithHttpInfo(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

faxReceiptsReadPutAsync

public com.squareup.okhttp.Call faxReceiptsReadPutAsync(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

faxSendPostCall

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

Build call for faxSendPost

Parameters:

faxMessage - FaxMessageCollection model (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

faxSendPost

public String faxSendPost(FaxMessageCollection faxMessage)
                   throws ApiException

Send a fax using supplied supported file-types. Send a fax using supplied supported file-types.

Parameters:

faxMessage - FaxMessageCollection model (required)

Returns:

String

Throws:

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

faxSendPostWithHttpInfo

public ApiResponse<String> faxSendPostWithHttpInfo(FaxMessageCollection faxMessage)
                                            throws ApiException

Send a fax using supplied supported file-types. Send a fax using supplied supported file-types.

Parameters:

faxMessage - FaxMessageCollection model (required)

Returns:

ApiResponse<String>

Throws:

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

faxSendPostAsync

public com.squareup.okhttp.Call faxSendPostAsync(FaxMessageCollection faxMessage,
                                                 ApiCallback<String> callback)
                                          throws ApiException

Send a fax using supplied supported file-types. (asynchronously) Send a fax using supplied supported file-types.

Parameters:

faxMessage - FaxMessageCollection 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