ClickSend.Api

Class SmsCampaignApi

java.lang.Object

ClickSend.Api.SmsCampaignApi

public class SmsCampaignApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SmsCampaignApi()
SmsCampaignApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
String	smsCampaignBySmsCampaignIdGet(Integer smsCampaignId) Get specific sms campaign Get specific sms campaign
com.squareup.okhttp.Call	smsCampaignBySmsCampaignIdGetAsync(Integer smsCampaignId, ApiCallback<String> callback) Get specific sms campaign (asynchronously) Get specific sms campaign
com.squareup.okhttp.Call	smsCampaignBySmsCampaignIdGetCall(Integer smsCampaignId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsCampaignBySmsCampaignIdGet
ApiResponse<String>	smsCampaignBySmsCampaignIdGetWithHttpInfo(Integer smsCampaignId) Get specific sms campaign Get specific sms campaign
String	smsCampaignsBySmsCampaignIdPut(Integer smsCampaignId, SmsCampaign campaign) Update sms campaign Update sms campaign
com.squareup.okhttp.Call	smsCampaignsBySmsCampaignIdPutAsync(Integer smsCampaignId, SmsCampaign campaign, ApiCallback<String> callback) Update sms campaign (asynchronously) Update sms campaign
com.squareup.okhttp.Call	smsCampaignsBySmsCampaignIdPutCall(Integer smsCampaignId, SmsCampaign campaign, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsCampaignsBySmsCampaignIdPut
ApiResponse<String>	smsCampaignsBySmsCampaignIdPutWithHttpInfo(Integer smsCampaignId, SmsCampaign campaign) Update sms campaign Update sms campaign
String	smsCampaignsCancelBySmsCampaignIdPut(Integer smsCampaignId) Cancel sms campaign Cancel sms campaign
com.squareup.okhttp.Call	smsCampaignsCancelBySmsCampaignIdPutAsync(Integer smsCampaignId, ApiCallback<String> callback) Cancel sms campaign (asynchronously) Cancel sms campaign
com.squareup.okhttp.Call	smsCampaignsCancelBySmsCampaignIdPutCall(Integer smsCampaignId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsCampaignsCancelBySmsCampaignIdPut
ApiResponse<String>	smsCampaignsCancelBySmsCampaignIdPutWithHttpInfo(Integer smsCampaignId) Cancel sms campaign Cancel sms campaign
String	smsCampaignsGet(Integer page, Integer limit) Get list of sms campaigns Get list of sms campaigns
com.squareup.okhttp.Call	smsCampaignsGetAsync(Integer page, Integer limit, ApiCallback<String> callback) Get list of sms campaigns (asynchronously) Get list of sms campaigns
com.squareup.okhttp.Call	smsCampaignsGetCall(Integer page, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsCampaignsGet
ApiResponse<String>	smsCampaignsGetWithHttpInfo(Integer page, Integer limit) Get list of sms campaigns Get list of sms campaigns
String	smsCampaignsPricePost(SmsCampaign campaign) Calculate price for sms campaign Calculate price for sms campaign
com.squareup.okhttp.Call	smsCampaignsPricePostAsync(SmsCampaign campaign, ApiCallback<String> callback) Calculate price for sms campaign (asynchronously) Calculate price for sms campaign
com.squareup.okhttp.Call	smsCampaignsPricePostCall(SmsCampaign campaign, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsCampaignsPricePost
ApiResponse<String>	smsCampaignsPricePostWithHttpInfo(SmsCampaign campaign) Calculate price for sms campaign Calculate price for sms campaign
String	smsCampaignsSendPost(SmsCampaign campaign) Create sms campaign Create sms campaign
com.squareup.okhttp.Call	smsCampaignsSendPostAsync(SmsCampaign campaign, ApiCallback<String> callback) Create sms campaign (asynchronously) Create sms campaign
com.squareup.okhttp.Call	smsCampaignsSendPostCall(SmsCampaign campaign, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for smsCampaignsSendPost
ApiResponse<String>	smsCampaignsSendPostWithHttpInfo(SmsCampaign campaign) Create sms campaign Create sms campaign

Methods inherited from class java.lang.Object

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

Constructor Detail

SmsCampaignApi

public SmsCampaignApi()

SmsCampaignApi

public SmsCampaignApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

smsCampaignBySmsCampaignIdGetCall

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

Build call for smsCampaignBySmsCampaignIdGet

Parameters:

smsCampaignId - ID of SMS campaign to retrieve (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsCampaignBySmsCampaignIdGet

public String smsCampaignBySmsCampaignIdGet(Integer smsCampaignId)
                                     throws ApiException

Get specific sms campaign Get specific sms campaign

Parameters:

smsCampaignId - ID of SMS campaign to retrieve (required)

Returns:

String

Throws:

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

smsCampaignBySmsCampaignIdGetWithHttpInfo

public ApiResponse<String> smsCampaignBySmsCampaignIdGetWithHttpInfo(Integer smsCampaignId)
                                                              throws ApiException

Get specific sms campaign Get specific sms campaign

Parameters:

smsCampaignId - ID of SMS campaign to retrieve (required)

Returns:

ApiResponse<String>

Throws:

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

smsCampaignBySmsCampaignIdGetAsync

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

Get specific sms campaign (asynchronously) Get specific sms campaign

Parameters:

smsCampaignId - ID of SMS campaign 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

smsCampaignsBySmsCampaignIdPutCall

public com.squareup.okhttp.Call smsCampaignsBySmsCampaignIdPutCall(Integer smsCampaignId,
                                                                   SmsCampaign campaign,
                                                                   ProgressResponseBody.ProgressListener progressListener,
                                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                            throws ApiException

Build call for smsCampaignsBySmsCampaignIdPut

Parameters:

smsCampaignId - ID of SMS campaign to update (required)

campaign - SmsCampaign model (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsCampaignsBySmsCampaignIdPut

public String smsCampaignsBySmsCampaignIdPut(Integer smsCampaignId,
                                             SmsCampaign campaign)
                                      throws ApiException

Update sms campaign Update sms campaign

Parameters:

smsCampaignId - ID of SMS campaign to update (required)

campaign - SmsCampaign model (required)

Returns:

String

Throws:

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

smsCampaignsBySmsCampaignIdPutWithHttpInfo

public ApiResponse<String> smsCampaignsBySmsCampaignIdPutWithHttpInfo(Integer smsCampaignId,
                                                                      SmsCampaign campaign)
                                                               throws ApiException

Update sms campaign Update sms campaign

Parameters:

smsCampaignId - ID of SMS campaign to update (required)

campaign - SmsCampaign model (required)

Returns:

ApiResponse<String>

Throws:

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

smsCampaignsBySmsCampaignIdPutAsync

public com.squareup.okhttp.Call smsCampaignsBySmsCampaignIdPutAsync(Integer smsCampaignId,
                                                                    SmsCampaign campaign,
                                                                    ApiCallback<String> callback)
                                                             throws ApiException

Update sms campaign (asynchronously) Update sms campaign

Parameters:

smsCampaignId - ID of SMS campaign to update (required)

campaign - SmsCampaign 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

smsCampaignsCancelBySmsCampaignIdPutCall

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

Build call for smsCampaignsCancelBySmsCampaignIdPut

Parameters:

smsCampaignId - ID of SMS Campaign to cancel (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsCampaignsCancelBySmsCampaignIdPut

public String smsCampaignsCancelBySmsCampaignIdPut(Integer smsCampaignId)
                                            throws ApiException

Cancel sms campaign Cancel sms campaign

Parameters:

smsCampaignId - ID of SMS Campaign to cancel (required)

Returns:

String

Throws:

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

smsCampaignsCancelBySmsCampaignIdPutWithHttpInfo

public ApiResponse<String> smsCampaignsCancelBySmsCampaignIdPutWithHttpInfo(Integer smsCampaignId)
                                                                     throws ApiException

Cancel sms campaign Cancel sms campaign

Parameters:

smsCampaignId - ID of SMS Campaign to cancel (required)

Returns:

ApiResponse<String>

Throws:

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

smsCampaignsCancelBySmsCampaignIdPutAsync

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

Cancel sms campaign (asynchronously) Cancel sms campaign

Parameters:

smsCampaignId - ID of SMS Campaign 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

smsCampaignsGetCall

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

Build call for smsCampaignsGet

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

smsCampaignsGet

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

Get list of sms campaigns Get list of sms campaigns

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

smsCampaignsGetWithHttpInfo

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

Get list of sms campaigns Get list of sms campaigns

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

smsCampaignsGetAsync

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

Get list of sms campaigns (asynchronously) Get list of sms campaigns

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

smsCampaignsPricePostCall

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

Build call for smsCampaignsPricePost

Parameters:

campaign - SmsCampaign model (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsCampaignsPricePost

public String smsCampaignsPricePost(SmsCampaign campaign)
                             throws ApiException

Calculate price for sms campaign Calculate price for sms campaign

Parameters:

campaign - SmsCampaign model (required)

Returns:

String

Throws:

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

smsCampaignsPricePostWithHttpInfo

public ApiResponse<String> smsCampaignsPricePostWithHttpInfo(SmsCampaign campaign)
                                                      throws ApiException

Calculate price for sms campaign Calculate price for sms campaign

Parameters:

campaign - SmsCampaign model (required)

Returns:

ApiResponse<String>

Throws:

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

smsCampaignsPricePostAsync

public com.squareup.okhttp.Call smsCampaignsPricePostAsync(SmsCampaign campaign,
                                                           ApiCallback<String> callback)
                                                    throws ApiException

Calculate price for sms campaign (asynchronously) Calculate price for sms campaign

Parameters:

campaign - SmsCampaign 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

smsCampaignsSendPostCall

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

Build call for smsCampaignsSendPost

Parameters:

campaign - SmsCampaign model (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

smsCampaignsSendPost

public String smsCampaignsSendPost(SmsCampaign campaign)
                            throws ApiException

Create sms campaign Create sms campaign

Parameters:

campaign - SmsCampaign model (required)

Returns:

String

Throws:

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

smsCampaignsSendPostWithHttpInfo

public ApiResponse<String> smsCampaignsSendPostWithHttpInfo(SmsCampaign campaign)
                                                     throws ApiException

Create sms campaign Create sms campaign

Parameters:

campaign - SmsCampaign model (required)

Returns:

ApiResponse<String>

Throws:

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

smsCampaignsSendPostAsync

public com.squareup.okhttp.Call smsCampaignsSendPostAsync(SmsCampaign campaign,
                                                          ApiCallback<String> callback)
                                                   throws ApiException

Create sms campaign (asynchronously) Create sms campaign

Parameters:

campaign - SmsCampaign 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