ClickSend.Api

Class PostPostcardApi

java.lang.Object

ClickSend.Api.PostPostcardApi

public class PostPostcardApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PostPostcardApi()
PostPostcardApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
String	postPostcardsHistoryExportGet(String filename) Export postcard history to a CSV file Export postcard history to a CSV file
com.squareup.okhttp.Call	postPostcardsHistoryExportGetAsync(String filename, ApiCallback<String> callback) Export postcard history to a CSV file (asynchronously) Export postcard history to a CSV file
com.squareup.okhttp.Call	postPostcardsHistoryExportGetCall(String filename, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postPostcardsHistoryExportGet
ApiResponse<String>	postPostcardsHistoryExportGetWithHttpInfo(String filename) Export postcard history to a CSV file Export postcard history to a CSV file
String	postPostcardsHistoryGet(Integer page, Integer limit) Retrieve the history of postcards sent or scheduled Retrieve the history of postcards sent or scheduled
com.squareup.okhttp.Call	postPostcardsHistoryGetAsync(Integer page, Integer limit, ApiCallback<String> callback) Retrieve the history of postcards sent or scheduled (asynchronously) Retrieve the history of postcards sent or scheduled
com.squareup.okhttp.Call	postPostcardsHistoryGetCall(Integer page, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postPostcardsHistoryGet
ApiResponse<String>	postPostcardsHistoryGetWithHttpInfo(Integer page, Integer limit) Retrieve the history of postcards sent or scheduled Retrieve the history of postcards sent or scheduled
String	postPostcardsPricePost(PostPostcard postPostcards) Calculate price for sending one or more postcards Calculate price for sending one or more postcards
com.squareup.okhttp.Call	postPostcardsPricePostAsync(PostPostcard postPostcards, ApiCallback<String> callback) Calculate price for sending one or more postcards (asynchronously) Calculate price for sending one or more postcards
com.squareup.okhttp.Call	postPostcardsPricePostCall(PostPostcard postPostcards, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postPostcardsPricePost
ApiResponse<String>	postPostcardsPricePostWithHttpInfo(PostPostcard postPostcards) Calculate price for sending one or more postcards Calculate price for sending one or more postcards
String	postPostcardsSendPost(PostPostcard postPostcards) Send one or more postcards Send one or more postcards
com.squareup.okhttp.Call	postPostcardsSendPostAsync(PostPostcard postPostcards, ApiCallback<String> callback) Send one or more postcards (asynchronously) Send one or more postcards
com.squareup.okhttp.Call	postPostcardsSendPostCall(PostPostcard postPostcards, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postPostcardsSendPost
ApiResponse<String>	postPostcardsSendPostWithHttpInfo(PostPostcard postPostcards) Send one or more postcards Send one or more postcards
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

PostPostcardApi

public PostPostcardApi()

PostPostcardApi

public PostPostcardApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

postPostcardsHistoryExportGetCall

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

Build call for postPostcardsHistoryExportGet

Parameters:

filename - Filename to export to (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

postPostcardsHistoryExportGet

public String postPostcardsHistoryExportGet(String filename)
                                     throws ApiException

Export postcard history to a CSV file Export postcard history to a CSV file

Parameters:

filename - Filename to export to (required)

Returns:

String

Throws:

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

postPostcardsHistoryExportGetWithHttpInfo

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

Export postcard history to a CSV file Export postcard history to a CSV file

Parameters:

filename - Filename to export to (required)

Returns:

ApiResponse<String>

Throws:

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

postPostcardsHistoryExportGetAsync

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

Export postcard history to a CSV file (asynchronously) Export postcard history to a CSV file

Parameters:

filename - Filename to export to (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

postPostcardsHistoryGetCall

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

Build call for postPostcardsHistoryGet

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

postPostcardsHistoryGet

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

Retrieve the history of postcards sent or scheduled Retrieve the history of postcards sent or scheduled

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

postPostcardsHistoryGetWithHttpInfo

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

Retrieve the history of postcards sent or scheduled Retrieve the history of postcards sent or scheduled

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

postPostcardsHistoryGetAsync

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

Retrieve the history of postcards sent or scheduled (asynchronously) Retrieve the history of postcards sent or scheduled

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

postPostcardsPricePostCall

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

Build call for postPostcardsPricePost

Parameters:

postPostcards - PostPostcard model (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

postPostcardsPricePost

public String postPostcardsPricePost(PostPostcard postPostcards)
                              throws ApiException

Calculate price for sending one or more postcards Calculate price for sending one or more postcards

Parameters:

postPostcards - PostPostcard model (required)

Returns:

String

Throws:

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

postPostcardsPricePostWithHttpInfo

public ApiResponse<String> postPostcardsPricePostWithHttpInfo(PostPostcard postPostcards)
                                                       throws ApiException

Calculate price for sending one or more postcards Calculate price for sending one or more postcards

Parameters:

postPostcards - PostPostcard model (required)

Returns:

ApiResponse<String>

Throws:

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

postPostcardsPricePostAsync

public com.squareup.okhttp.Call postPostcardsPricePostAsync(PostPostcard postPostcards,
                                                            ApiCallback<String> callback)
                                                     throws ApiException

Calculate price for sending one or more postcards (asynchronously) Calculate price for sending one or more postcards

Parameters:

postPostcards - PostPostcard 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

postPostcardsSendPostCall

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

Build call for postPostcardsSendPost

Parameters:

postPostcards - PostPostcard model (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

postPostcardsSendPost

public String postPostcardsSendPost(PostPostcard postPostcards)
                             throws ApiException

Send one or more postcards Send one or more postcards

Parameters:

postPostcards - PostPostcard model (required)

Returns:

String

Throws:

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

postPostcardsSendPostWithHttpInfo

public ApiResponse<String> postPostcardsSendPostWithHttpInfo(PostPostcard postPostcards)
                                                      throws ApiException

Send one or more postcards Send one or more postcards

Parameters:

postPostcards - PostPostcard model (required)

Returns:

ApiResponse<String>

Throws:

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

postPostcardsSendPostAsync

public com.squareup.okhttp.Call postPostcardsSendPostAsync(PostPostcard postPostcards,
                                                           ApiCallback<String> callback)
                                                    throws ApiException

Send one or more postcards (asynchronously) Send one or more postcards

Parameters:

postPostcards - PostPostcard 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