CampaignsApi (elasticemail-RESTful-API 3.0.1 API)

java.lang.Object
- io.swagger.client.api.CampaignsApi

public class CampaignsApi
extends Object

Constructor Summary

Constructors
Constructor and Description

CampaignsApi()

CampaignsApi(ApiClient apiClient)

Constructors
Constructor and Description
`CampaignsApi()`
`CampaignsApi(ApiClient apiClient)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<SplitCampaign>`	`campaignsAbsplitGet(String search, Integer offset, Integer limit)` List all of your A/X campaigns
`com.squareup.okhttp.Call`	`campaignsAbsplitGetAsync(String search, Integer offset, Integer limit, ApiCallback<List<SplitCampaign>> callback)` List all of your A/X campaigns (asynchronously)
`com.squareup.okhttp.Call`	`campaignsAbsplitGetCall(String search, Integer offset, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsAbsplitGet
`ApiResponse<List<SplitCampaign>>`	`campaignsAbsplitGetWithHttpInfo(String search, Integer offset, Integer limit)` List all of your A/X campaigns
`void`	`campaignsAbsplitNameDelete(String name)`
`com.squareup.okhttp.Call`	`campaignsAbsplitNameDeleteAsync(String name, ApiCallback<Void> callback)` (asynchronously)
`com.squareup.okhttp.Call`	`campaignsAbsplitNameDeleteCall(String name, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsAbsplitNameDelete
`ApiResponse<Void>`	`campaignsAbsplitNameDeleteWithHttpInfo(String name)`
`SplitCampaign`	`campaignsAbsplitNameGet(String name)`
`com.squareup.okhttp.Call`	`campaignsAbsplitNameGetAsync(String name, ApiCallback<SplitCampaign> callback)` (asynchronously)
`com.squareup.okhttp.Call`	`campaignsAbsplitNameGetCall(String name, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsAbsplitNameGet
`ApiResponse<SplitCampaign>`	`campaignsAbsplitNameGetWithHttpInfo(String name)`
`SplitCampaign`	`campaignsAbsplitNamePut(String name, SplitCampaign body)` Updates a previously added campaign.
`com.squareup.okhttp.Call`	`campaignsAbsplitNamePutAsync(String name, SplitCampaign body, ApiCallback<SplitCampaign> callback)` Updates a previously added campaign.
`com.squareup.okhttp.Call`	`campaignsAbsplitNamePutCall(String name, SplitCampaign body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsAbsplitNamePut
`ApiResponse<SplitCampaign>`	`campaignsAbsplitNamePutWithHttpInfo(String name, SplitCampaign body)` Updates a previously added campaign.
`SplitCampaign`	`campaignsAbsplitPost(SplitCampaign body)`
`com.squareup.okhttp.Call`	`campaignsAbsplitPostAsync(SplitCampaign body, ApiCallback<SplitCampaign> callback)` (asynchronously)
`com.squareup.okhttp.Call`	`campaignsAbsplitPostCall(SplitCampaign body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsAbsplitPost
`ApiResponse<SplitCampaign>`	`campaignsAbsplitPostWithHttpInfo(SplitCampaign body)`
`List<NameTypeCampaign>`	`campaignsAllGet(String search, Integer offset, Integer limit)`
`com.squareup.okhttp.Call`	`campaignsAllGetAsync(String search, Integer offset, Integer limit, ApiCallback<List<NameTypeCampaign>> callback)` (asynchronously)
`com.squareup.okhttp.Call`	`campaignsAllGetCall(String search, Integer offset, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsAllGet
`ApiResponse<List<NameTypeCampaign>>`	`campaignsAllGetWithHttpInfo(String search, Integer offset, Integer limit)`
`List<Automated>`	`campaignsAutomatedGet(String search, Integer offset, Integer limit)` List all of your automated campaigns
`com.squareup.okhttp.Call`	`campaignsAutomatedGetAsync(String search, Integer offset, Integer limit, ApiCallback<List<Automated>> callback)` List all of your automated campaigns (asynchronously)
`com.squareup.okhttp.Call`	`campaignsAutomatedGetCall(String search, Integer offset, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsAutomatedGet
`ApiResponse<List<Automated>>`	`campaignsAutomatedGetWithHttpInfo(String search, Integer offset, Integer limit)` List all of your automated campaigns
`void`	`campaignsAutomatedNameDelete(String name)`
`com.squareup.okhttp.Call`	`campaignsAutomatedNameDeleteAsync(String name, ApiCallback<Void> callback)` (asynchronously)
`com.squareup.okhttp.Call`	`campaignsAutomatedNameDeleteCall(String name, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsAutomatedNameDelete
`ApiResponse<Void>`	`campaignsAutomatedNameDeleteWithHttpInfo(String name)`
`Automated`	`campaignsAutomatedNameGet(String name)`
`com.squareup.okhttp.Call`	`campaignsAutomatedNameGetAsync(String name, ApiCallback<Automated> callback)` (asynchronously)
`com.squareup.okhttp.Call`	`campaignsAutomatedNameGetCall(String name, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsAutomatedNameGet
`ApiResponse<Automated>`	`campaignsAutomatedNameGetWithHttpInfo(String name)`
`Automated`	`campaignsAutomatedNamePut(String name, Automated body)` Updates a previously added campaign.
`com.squareup.okhttp.Call`	`campaignsAutomatedNamePutAsync(String name, Automated body, ApiCallback<Automated> callback)` Updates a previously added campaign.
`com.squareup.okhttp.Call`	`campaignsAutomatedNamePutCall(String name, Automated body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsAutomatedNamePut
`ApiResponse<Automated>`	`campaignsAutomatedNamePutWithHttpInfo(String name, Automated body)` Updates a previously added campaign.
`Automated`	`campaignsAutomatedPost(Automated body)`
`com.squareup.okhttp.Call`	`campaignsAutomatedPostAsync(Automated body, ApiCallback<Automated> callback)` (asynchronously)
`com.squareup.okhttp.Call`	`campaignsAutomatedPostCall(Automated body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsAutomatedPost
`ApiResponse<Automated>`	`campaignsAutomatedPostWithHttpInfo(Automated body)`
`void`	`campaignsNameCancelPost(String name)` Cancels emails that are waiting to be sent.
`com.squareup.okhttp.Call`	`campaignsNameCancelPostAsync(String name, ApiCallback<Void> callback)` Cancels emails that are waiting to be sent.
`com.squareup.okhttp.Call`	`campaignsNameCancelPostCall(String name, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsNameCancelPost
`ApiResponse<Void>`	`campaignsNameCancelPostWithHttpInfo(String name)` Cancels emails that are waiting to be sent.
`List<Campaign>`	`campaignsSendnowGet(String search, Integer offset, Integer limit)` List all of your instant campaigns
`com.squareup.okhttp.Call`	`campaignsSendnowGetAsync(String search, Integer offset, Integer limit, ApiCallback<List<Campaign>> callback)` List all of your instant campaigns (asynchronously)
`com.squareup.okhttp.Call`	`campaignsSendnowGetCall(String search, Integer offset, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsSendnowGet
`ApiResponse<List<Campaign>>`	`campaignsSendnowGetWithHttpInfo(String search, Integer offset, Integer limit)` List all of your instant campaigns
`void`	`campaignsSendnowNameDelete(String name)`
`com.squareup.okhttp.Call`	`campaignsSendnowNameDeleteAsync(String name, ApiCallback<Void> callback)` (asynchronously)
`com.squareup.okhttp.Call`	`campaignsSendnowNameDeleteCall(String name, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsSendnowNameDelete
`ApiResponse<Void>`	`campaignsSendnowNameDeleteWithHttpInfo(String name)`
`Campaign`	`campaignsSendnowNameGet(String name)` Retrieves an existing campaign.
`com.squareup.okhttp.Call`	`campaignsSendnowNameGetAsync(String name, ApiCallback<Campaign> callback)` Retrieves an existing campaign.
`com.squareup.okhttp.Call`	`campaignsSendnowNameGetCall(String name, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsSendnowNameGet
`ApiResponse<Campaign>`	`campaignsSendnowNameGetWithHttpInfo(String name)` Retrieves an existing campaign.
`Campaign`	`campaignsSendnowNamePut(String name, Campaign body)` Updates a previously added campaign.
`com.squareup.okhttp.Call`	`campaignsSendnowNamePutAsync(String name, Campaign body, ApiCallback<Campaign> callback)` Updates a previously added campaign.
`com.squareup.okhttp.Call`	`campaignsSendnowNamePutCall(String name, Campaign body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsSendnowNamePut
`ApiResponse<Campaign>`	`campaignsSendnowNamePutWithHttpInfo(String name, Campaign body)` Updates a previously added campaign.
`Campaign`	`campaignsSendnowPost(Campaign body)`
`com.squareup.okhttp.Call`	`campaignsSendnowPostAsync(Campaign body, ApiCallback<Campaign> callback)` (asynchronously)
`com.squareup.okhttp.Call`	`campaignsSendnowPostCall(Campaign body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsSendnowPost
`ApiResponse<Campaign>`	`campaignsSendnowPostWithHttpInfo(Campaign body)`
`ExportLink`	`campaignsTasksExportGet(List<String> campaignNames, String fileFormat, String compressionFormat, String fileName)` Export selected campaigns to chosen file format.
`com.squareup.okhttp.Call`	`campaignsTasksExportGetAsync(List<String> campaignNames, String fileFormat, String compressionFormat, String fileName, ApiCallback<ExportLink> callback)` Export selected campaigns to chosen file format.
`com.squareup.okhttp.Call`	`campaignsTasksExportGetCall(List<String> campaignNames, String fileFormat, String compressionFormat, String fileName, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for campaignsTasksExportGet
`ApiResponse<ExportLink>`	`campaignsTasksExportGetWithHttpInfo(List<String> campaignNames, String fileFormat, String compressionFormat, String fileName)` Export selected campaigns to chosen file format.
`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

CampaignsApi
```
public CampaignsApi()
```

CampaignsApi

public CampaignsApi(ApiClient apiClient)

Method Detail

getApiClient
```
public ApiClient getApiClient()
```

setApiClient

public void setApiClient(ApiClient apiClient)

campaignsAbsplitGetCall

public com.squareup.okhttp.Call campaignsAbsplitGetCall(String search,
                                                        Integer offset,
                                                        Integer limit,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for campaignsAbsplitGet

Parameters:: search - Text fragment used for searching. (optional); offset - How many items should be loaded ahead. (optional, default to 0); limit - Maximum of loaded items. (optional, default to 0); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsAbsplitGet
```
public List<SplitCampaign> campaignsAbsplitGet(String search,
                                               Integer offset,
                                               Integer limit)
                                        throws ApiException
```
List all of your A/X campaigns

Parameters:

search - Text fragment used for searching. (optional)

offset - How many items should be loaded ahead. (optional, default to 0)

limit - Maximum of loaded items. (optional, default to 0)

Returns:

List<SplitCampaign>

Throws:

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

campaignsAbsplitGetWithHttpInfo

public ApiResponse<List<SplitCampaign>> campaignsAbsplitGetWithHttpInfo(String search,
                                                                        Integer offset,
                                                                        Integer limit)
                                                                 throws ApiException

List all of your A/X campaigns

Parameters:: search - Text fragment used for searching. (optional); offset - How many items should be loaded ahead. (optional, default to 0); limit - Maximum of loaded items. (optional, default to 0)
Returns:: ApiResponse<List<SplitCampaign>>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

campaignsAbsplitGetAsync

public com.squareup.okhttp.Call campaignsAbsplitGetAsync(String search,
                                                         Integer offset,
                                                         Integer limit,
                                                         ApiCallback<List<SplitCampaign>> callback)
                                                  throws ApiException

List all of your A/X campaigns (asynchronously)

Parameters:: search - Text fragment used for searching. (optional); offset - How many items should be loaded ahead. (optional, default to 0); limit - Maximum of loaded items. (optional, default to 0); 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

campaignsAbsplitNameDeleteCall

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

Build call for campaignsAbsplitNameDelete

Parameters:: name - Filename (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsAbsplitNameDelete
```
public void campaignsAbsplitNameDelete(String name)
                                throws ApiException
```
Parameters:

name - Filename (required)

Throws:

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

campaignsAbsplitNameDeleteWithHttpInfo
```
public ApiResponse<Void> campaignsAbsplitNameDeleteWithHttpInfo(String name)
                                                         throws ApiException
```
Parameters:

name - Filename (required)

Returns:

ApiResponse<Void>

Throws:

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

campaignsAbsplitNameDeleteAsync

public com.squareup.okhttp.Call campaignsAbsplitNameDeleteAsync(String name,
                                                                ApiCallback<Void> callback)
                                                         throws ApiException

(asynchronously)

Parameters:: name - Filename (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

campaignsAbsplitNameGetCall

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

Build call for campaignsAbsplitNameGet

Parameters:: name - Filename (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsAbsplitNameGet
```
public SplitCampaign campaignsAbsplitNameGet(String name)
                                      throws ApiException
```
Parameters:

name - Filename (required)

Returns:

SplitCampaign

Throws:

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

campaignsAbsplitNameGetWithHttpInfo
```
public ApiResponse<SplitCampaign> campaignsAbsplitNameGetWithHttpInfo(String name)
                                                               throws ApiException
```
Parameters:

name - Filename (required)

Returns:

ApiResponse<SplitCampaign>

Throws:

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

campaignsAbsplitNameGetAsync

public com.squareup.okhttp.Call campaignsAbsplitNameGetAsync(String name,
                                                             ApiCallback<SplitCampaign> callback)
                                                      throws ApiException

(asynchronously)

Parameters:: name - Filename (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

campaignsAbsplitNamePutCall

public com.squareup.okhttp.Call campaignsAbsplitNamePutCall(String name,
                                                            SplitCampaign body,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for campaignsAbsplitNamePut

Parameters:: name - Filename (required); body - Json representation of a campaign (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsAbsplitNamePut
```
public SplitCampaign campaignsAbsplitNamePut(String name,
                                             SplitCampaign body)
                                      throws ApiException
```
Updates a previously added campaign. Only Active and Paused campaigns can be updated.

Parameters:

name - Filename (required)

body - Json representation of a campaign (required)

Returns:

SplitCampaign

Throws:

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

campaignsAbsplitNamePutWithHttpInfo
```
public ApiResponse<SplitCampaign> campaignsAbsplitNamePutWithHttpInfo(String name,
                                                                      SplitCampaign body)
                                                               throws ApiException
```
Updates a previously added campaign. Only Active and Paused campaigns can be updated.

Parameters:

name - Filename (required)

body - Json representation of a campaign (required)

Returns:

ApiResponse<SplitCampaign>

Throws:

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

campaignsAbsplitNamePutAsync

public com.squareup.okhttp.Call campaignsAbsplitNamePutAsync(String name,
                                                             SplitCampaign body,
                                                             ApiCallback<SplitCampaign> callback)
                                                      throws ApiException

Updates a previously added campaign. Only Active and Paused campaigns can be updated. (asynchronously)

Parameters:: name - Filename (required); body - Json representation of a campaign (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

campaignsAbsplitPostCall

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

Build call for campaignsAbsplitPost

Parameters:: body - Json representation of a campaign (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsAbsplitPost
```
public SplitCampaign campaignsAbsplitPost(SplitCampaign body)
                                   throws ApiException
```
Parameters:

body - Json representation of a campaign (required)

Returns:

SplitCampaign

Throws:

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

campaignsAbsplitPostWithHttpInfo
```
public ApiResponse<SplitCampaign> campaignsAbsplitPostWithHttpInfo(SplitCampaign body)
                                                            throws ApiException
```
Parameters:

body - Json representation of a campaign (required)

Returns:

ApiResponse<SplitCampaign>

Throws:

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

campaignsAbsplitPostAsync

public com.squareup.okhttp.Call campaignsAbsplitPostAsync(SplitCampaign body,
                                                          ApiCallback<SplitCampaign> callback)
                                                   throws ApiException

(asynchronously)

Parameters:: body - Json representation of a campaign (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

campaignsAllGetCall

public com.squareup.okhttp.Call campaignsAllGetCall(String search,
                                                    Integer offset,
                                                    Integer limit,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for campaignsAllGet

Parameters:: search - Text fragment used for searching. (optional); offset - How many items should be loaded ahead. (optional, default to 0); limit - Maximum of loaded items. (optional, default to 0); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsAllGet

public List<NameTypeCampaign> campaignsAllGet(String search,
                                              Integer offset,
                                              Integer limit)
                                       throws ApiException

Parameters:: search - Text fragment used for searching. (optional); offset - How many items should be loaded ahead. (optional, default to 0); limit - Maximum of loaded items. (optional, default to 0)
Returns:: List<NameTypeCampaign>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

campaignsAllGetWithHttpInfo

public ApiResponse<List<NameTypeCampaign>> campaignsAllGetWithHttpInfo(String search,
                                                                       Integer offset,
                                                                       Integer limit)
                                                                throws ApiException

Parameters:: search - Text fragment used for searching. (optional); offset - How many items should be loaded ahead. (optional, default to 0); limit - Maximum of loaded items. (optional, default to 0)
Returns:: ApiResponse<List<NameTypeCampaign>>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

campaignsAllGetAsync

public com.squareup.okhttp.Call campaignsAllGetAsync(String search,
                                                     Integer offset,
                                                     Integer limit,
                                                     ApiCallback<List<NameTypeCampaign>> callback)
                                              throws ApiException

(asynchronously)

Parameters:: search - Text fragment used for searching. (optional); offset - How many items should be loaded ahead. (optional, default to 0); limit - Maximum of loaded items. (optional, default to 0); 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

campaignsAutomatedGetCall

public com.squareup.okhttp.Call campaignsAutomatedGetCall(String search,
                                                          Integer offset,
                                                          Integer limit,
                                                          ProgressResponseBody.ProgressListener progressListener,
                                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                   throws ApiException

Build call for campaignsAutomatedGet

Parameters:: search - Text fragment used for searching. (optional); offset - How many items should be loaded ahead. (optional, default to 0); limit - Maximum of loaded items. (optional, default to 0); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsAutomatedGet
```
public List<Automated> campaignsAutomatedGet(String search,
                                             Integer offset,
                                             Integer limit)
                                      throws ApiException
```
List all of your automated campaigns

Parameters:

search - Text fragment used for searching. (optional)

offset - How many items should be loaded ahead. (optional, default to 0)

limit - Maximum of loaded items. (optional, default to 0)

Returns:

List<Automated>

Throws:

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

campaignsAutomatedGetWithHttpInfo

public ApiResponse<List<Automated>> campaignsAutomatedGetWithHttpInfo(String search,
                                                                      Integer offset,
                                                                      Integer limit)
                                                               throws ApiException

List all of your automated campaigns

Parameters:: search - Text fragment used for searching. (optional); offset - How many items should be loaded ahead. (optional, default to 0); limit - Maximum of loaded items. (optional, default to 0)
Returns:: ApiResponse<List<Automated>>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

campaignsAutomatedGetAsync

public com.squareup.okhttp.Call campaignsAutomatedGetAsync(String search,
                                                           Integer offset,
                                                           Integer limit,
                                                           ApiCallback<List<Automated>> callback)
                                                    throws ApiException

List all of your automated campaigns (asynchronously)

Parameters:: search - Text fragment used for searching. (optional); offset - How many items should be loaded ahead. (optional, default to 0); limit - Maximum of loaded items. (optional, default to 0); 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

campaignsAutomatedNameDeleteCall

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

Build call for campaignsAutomatedNameDelete

Parameters:: name - Filename (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsAutomatedNameDelete
```
public void campaignsAutomatedNameDelete(String name)
                                  throws ApiException
```
Parameters:

name - Filename (required)

Throws:

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

campaignsAutomatedNameDeleteWithHttpInfo
```
public ApiResponse<Void> campaignsAutomatedNameDeleteWithHttpInfo(String name)
                                                           throws ApiException
```
Parameters:

name - Filename (required)

Returns:

ApiResponse<Void>

Throws:

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

campaignsAutomatedNameDeleteAsync

public com.squareup.okhttp.Call campaignsAutomatedNameDeleteAsync(String name,
                                                                  ApiCallback<Void> callback)
                                                           throws ApiException

(asynchronously)

Parameters:: name - Filename (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

campaignsAutomatedNameGetCall

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

Build call for campaignsAutomatedNameGet

Parameters:: name - Filename (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsAutomatedNameGet
```
public Automated campaignsAutomatedNameGet(String name)
                                    throws ApiException
```
Parameters:

name - Filename (required)

Returns:

Automated

Throws:

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

campaignsAutomatedNameGetWithHttpInfo
```
public ApiResponse<Automated> campaignsAutomatedNameGetWithHttpInfo(String name)
                                                             throws ApiException
```
Parameters:

name - Filename (required)

Returns:

ApiResponse<Automated>

Throws:

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

campaignsAutomatedNameGetAsync

public com.squareup.okhttp.Call campaignsAutomatedNameGetAsync(String name,
                                                               ApiCallback<Automated> callback)
                                                        throws ApiException

(asynchronously)

Parameters:: name - Filename (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

campaignsAutomatedNamePutCall

public com.squareup.okhttp.Call campaignsAutomatedNamePutCall(String name,
                                                              Automated body,
                                                              ProgressResponseBody.ProgressListener progressListener,
                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                       throws ApiException

Build call for campaignsAutomatedNamePut

Parameters:: name - Filename (required); body - Json representation of a campaign (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsAutomatedNamePut
```
public Automated campaignsAutomatedNamePut(String name,
                                           Automated body)
                                    throws ApiException
```
Updates a previously added campaign. Only Active and Paused campaigns can be updated.

Parameters:

name - Filename (required)

body - Json representation of a campaign (required)

Returns:

Automated

Throws:

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

campaignsAutomatedNamePutWithHttpInfo
```
public ApiResponse<Automated> campaignsAutomatedNamePutWithHttpInfo(String name,
                                                                    Automated body)
                                                             throws ApiException
```
Updates a previously added campaign. Only Active and Paused campaigns can be updated.

Parameters:

name - Filename (required)

body - Json representation of a campaign (required)

Returns:

ApiResponse<Automated>

Throws:

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

campaignsAutomatedNamePutAsync

public com.squareup.okhttp.Call campaignsAutomatedNamePutAsync(String name,
                                                               Automated body,
                                                               ApiCallback<Automated> callback)
                                                        throws ApiException

Updates a previously added campaign. Only Active and Paused campaigns can be updated. (asynchronously)

Parameters:: name - Filename (required); body - Json representation of a campaign (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

campaignsAutomatedPostCall

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

Build call for campaignsAutomatedPost

Parameters:: body - Json representation of a campaign (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsAutomatedPost
```
public Automated campaignsAutomatedPost(Automated body)
                                 throws ApiException
```
Parameters:

body - Json representation of a campaign (required)

Returns:

Automated

Throws:

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

campaignsAutomatedPostWithHttpInfo
```
public ApiResponse<Automated> campaignsAutomatedPostWithHttpInfo(Automated body)
                                                          throws ApiException
```
Parameters:

body - Json representation of a campaign (required)

Returns:

ApiResponse<Automated>

Throws:

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

campaignsAutomatedPostAsync

public com.squareup.okhttp.Call campaignsAutomatedPostAsync(Automated body,
                                                            ApiCallback<Automated> callback)
                                                     throws ApiException

(asynchronously)

Parameters:: body - Json representation of a campaign (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

campaignsNameCancelPostCall

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

Build call for campaignsNameCancelPost

Parameters:: name - Name of selected channel. (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsNameCancelPost
```
public void campaignsNameCancelPost(String name)
                             throws ApiException
```
Cancels emails that are waiting to be sent.

Parameters:

name - Name of selected channel. (required)

Throws:

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

campaignsNameCancelPostWithHttpInfo
```
public ApiResponse<Void> campaignsNameCancelPostWithHttpInfo(String name)
                                                      throws ApiException
```
Cancels emails that are waiting to be sent.

Parameters:

name - Name of selected channel. (required)

Returns:

ApiResponse<Void>

Throws:

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

campaignsNameCancelPostAsync
```
public com.squareup.okhttp.Call campaignsNameCancelPostAsync(String name,
                                                             ApiCallback<Void> callback)
                                                      throws ApiException
```
Cancels emails that are waiting to be sent. (asynchronously)

Parameters:

name - Name of selected channel. (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

campaignsSendnowGetCall

public com.squareup.okhttp.Call campaignsSendnowGetCall(String search,
                                                        Integer offset,
                                                        Integer limit,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for campaignsSendnowGet

Parameters:: search - Text fragment used for searching. (optional); offset - How many items should be loaded ahead. (optional, default to 0); limit - Maximum of loaded items. (optional, default to 0); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsSendnowGet
```
public List<Campaign> campaignsSendnowGet(String search,
                                          Integer offset,
                                          Integer limit)
                                   throws ApiException
```
List all of your instant campaigns

Parameters:

search - Text fragment used for searching. (optional)

offset - How many items should be loaded ahead. (optional, default to 0)

limit - Maximum of loaded items. (optional, default to 0)

Returns:

List<Campaign>

Throws:

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

campaignsSendnowGetWithHttpInfo

public ApiResponse<List<Campaign>> campaignsSendnowGetWithHttpInfo(String search,
                                                                   Integer offset,
                                                                   Integer limit)
                                                            throws ApiException

List all of your instant campaigns

Parameters:: search - Text fragment used for searching. (optional); offset - How many items should be loaded ahead. (optional, default to 0); limit - Maximum of loaded items. (optional, default to 0)
Returns:: ApiResponse<List<Campaign>>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

campaignsSendnowGetAsync

public com.squareup.okhttp.Call campaignsSendnowGetAsync(String search,
                                                         Integer offset,
                                                         Integer limit,
                                                         ApiCallback<List<Campaign>> callback)
                                                  throws ApiException

List all of your instant campaigns (asynchronously)

Parameters:: search - Text fragment used for searching. (optional); offset - How many items should be loaded ahead. (optional, default to 0); limit - Maximum of loaded items. (optional, default to 0); 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

campaignsSendnowNameDeleteCall

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

Build call for campaignsSendnowNameDelete

Parameters:: name - Filename (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsSendnowNameDelete
```
public void campaignsSendnowNameDelete(String name)
                                throws ApiException
```
Parameters:

name - Filename (required)

Throws:

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

campaignsSendnowNameDeleteWithHttpInfo
```
public ApiResponse<Void> campaignsSendnowNameDeleteWithHttpInfo(String name)
                                                         throws ApiException
```
Parameters:

name - Filename (required)

Returns:

ApiResponse<Void>

Throws:

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

campaignsSendnowNameDeleteAsync

public com.squareup.okhttp.Call campaignsSendnowNameDeleteAsync(String name,
                                                                ApiCallback<Void> callback)
                                                         throws ApiException

(asynchronously)

Parameters:: name - Filename (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

campaignsSendnowNameGetCall

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

Build call for campaignsSendnowNameGet

Parameters:: name - Filename (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsSendnowNameGet
```
public Campaign campaignsSendnowNameGet(String name)
                                 throws ApiException
```
Retrieves an existing campaign.

Parameters:

name - Filename (required)

Returns:

Campaign

Throws:

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

campaignsSendnowNameGetWithHttpInfo
```
public ApiResponse<Campaign> campaignsSendnowNameGetWithHttpInfo(String name)
                                                          throws ApiException
```
Retrieves an existing campaign.

Parameters:

name - Filename (required)

Returns:

ApiResponse<Campaign>

Throws:

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

campaignsSendnowNameGetAsync

public com.squareup.okhttp.Call campaignsSendnowNameGetAsync(String name,
                                                             ApiCallback<Campaign> callback)
                                                      throws ApiException

Retrieves an existing campaign. (asynchronously)

Parameters:: name - Filename (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

campaignsSendnowNamePutCall

public com.squareup.okhttp.Call campaignsSendnowNamePutCall(String name,
                                                            Campaign body,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for campaignsSendnowNamePut

Parameters:: name - Filename (required); body - Json representation of a campaign (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsSendnowNamePut
```
public Campaign campaignsSendnowNamePut(String name,
                                        Campaign body)
                                 throws ApiException
```
Updates a previously added campaign. Only Active and Paused campaigns can be updated.

Parameters:

name - Filename (required)

body - Json representation of a campaign (required)

Returns:

Campaign

Throws:

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

campaignsSendnowNamePutWithHttpInfo
```
public ApiResponse<Campaign> campaignsSendnowNamePutWithHttpInfo(String name,
                                                                 Campaign body)
                                                          throws ApiException
```
Updates a previously added campaign. Only Active and Paused campaigns can be updated.

Parameters:

name - Filename (required)

body - Json representation of a campaign (required)

Returns:

ApiResponse<Campaign>

Throws:

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

campaignsSendnowNamePutAsync

public com.squareup.okhttp.Call campaignsSendnowNamePutAsync(String name,
                                                             Campaign body,
                                                             ApiCallback<Campaign> callback)
                                                      throws ApiException

Updates a previously added campaign. Only Active and Paused campaigns can be updated. (asynchronously)

Parameters:: name - Filename (required); body - Json representation of a campaign (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

campaignsSendnowPostCall

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

Build call for campaignsSendnowPost

Parameters:: body - Json representation of a campaign (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsSendnowPost
```
public Campaign campaignsSendnowPost(Campaign body)
                              throws ApiException
```
Parameters:

body - Json representation of a campaign (required)

Returns:

Campaign

Throws:

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

campaignsSendnowPostWithHttpInfo
```
public ApiResponse<Campaign> campaignsSendnowPostWithHttpInfo(Campaign body)
                                                       throws ApiException
```
Parameters:

body - Json representation of a campaign (required)

Returns:

ApiResponse<Campaign>

Throws:

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

campaignsSendnowPostAsync

public com.squareup.okhttp.Call campaignsSendnowPostAsync(Campaign body,
                                                          ApiCallback<Campaign> callback)
                                                   throws ApiException

(asynchronously)

Parameters:: body - Json representation of a campaign (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

campaignsTasksExportGetCall

public com.squareup.okhttp.Call campaignsTasksExportGetCall(List<String> campaignNames,
                                                            String fileFormat,
                                                            String compressionFormat,
                                                            String fileName,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for campaignsTasksExportGet

Parameters:: campaignNames - List of campaign names used for processing (required); fileFormat - Format of the exported file (optional, default to Csv); compressionFormat - FileResponse compression format. None or Zip. (optional, default to None); fileName - Name of your file. (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

campaignsTasksExportGet
```
public ExportLink campaignsTasksExportGet(List<String> campaignNames,
                                          String fileFormat,
                                          String compressionFormat,
                                          String fileName)
                                   throws ApiException
```
Export selected campaigns to chosen file format.

Parameters:

campaignNames - List of campaign names used for processing (required)

fileFormat - Format of the exported file (optional, default to Csv)

compressionFormat - FileResponse compression format. None or Zip. (optional, default to None)

fileName - Name of your file. (optional)

Returns:

ExportLink

Throws:

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

campaignsTasksExportGetWithHttpInfo

public ApiResponse<ExportLink> campaignsTasksExportGetWithHttpInfo(List<String> campaignNames,
                                                                   String fileFormat,
                                                                   String compressionFormat,
                                                                   String fileName)
                                                            throws ApiException

Export selected campaigns to chosen file format.

Parameters:: campaignNames - List of campaign names used for processing (required); fileFormat - Format of the exported file (optional, default to Csv); compressionFormat - FileResponse compression format. None or Zip. (optional, default to None); fileName - Name of your file. (optional)
Returns:: ApiResponse<ExportLink>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

campaignsTasksExportGetAsync

public com.squareup.okhttp.Call campaignsTasksExportGetAsync(List<String> campaignNames,
                                                             String fileFormat,
                                                             String compressionFormat,
                                                             String fileName,
                                                             ApiCallback<ExportLink> callback)
                                                      throws ApiException

Export selected campaigns to chosen file format. (asynchronously)

Parameters:: campaignNames - List of campaign names used for processing (required); fileFormat - Format of the exported file (optional, default to Csv); compressionFormat - FileResponse compression format. None or Zip. (optional, default to None); fileName - Name of your file. (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

Class CampaignsApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CampaignsApi

CampaignsApi

Method Detail

getApiClient

setApiClient

campaignsAbsplitGetCall

campaignsAbsplitGet

campaignsAbsplitGetWithHttpInfo

campaignsAbsplitGetAsync

campaignsAbsplitNameDeleteCall

campaignsAbsplitNameDelete

campaignsAbsplitNameDeleteWithHttpInfo

campaignsAbsplitNameDeleteAsync

campaignsAbsplitNameGetCall

campaignsAbsplitNameGet

campaignsAbsplitNameGetWithHttpInfo

campaignsAbsplitNameGetAsync

campaignsAbsplitNamePutCall

campaignsAbsplitNamePut

campaignsAbsplitNamePutWithHttpInfo

campaignsAbsplitNamePutAsync

campaignsAbsplitPostCall

campaignsAbsplitPost

campaignsAbsplitPostWithHttpInfo

campaignsAbsplitPostAsync

campaignsAllGetCall

campaignsAllGet

campaignsAllGetWithHttpInfo

campaignsAllGetAsync

campaignsAutomatedGetCall

campaignsAutomatedGet

campaignsAutomatedGetWithHttpInfo

campaignsAutomatedGetAsync

campaignsAutomatedNameDeleteCall

campaignsAutomatedNameDelete

campaignsAutomatedNameDeleteWithHttpInfo

campaignsAutomatedNameDeleteAsync

campaignsAutomatedNameGetCall

campaignsAutomatedNameGet

campaignsAutomatedNameGetWithHttpInfo

campaignsAutomatedNameGetAsync

campaignsAutomatedNamePutCall

campaignsAutomatedNamePut

campaignsAutomatedNamePutWithHttpInfo

campaignsAutomatedNamePutAsync

campaignsAutomatedPostCall

campaignsAutomatedPost

campaignsAutomatedPostWithHttpInfo

campaignsAutomatedPostAsync

campaignsNameCancelPostCall

campaignsNameCancelPost

campaignsNameCancelPostWithHttpInfo

campaignsNameCancelPostAsync

campaignsSendnowGetCall

campaignsSendnowGet

campaignsSendnowGetWithHttpInfo

campaignsSendnowGetAsync

campaignsSendnowNameDeleteCall

campaignsSendnowNameDelete

campaignsSendnowNameDeleteWithHttpInfo

campaignsSendnowNameDeleteAsync

campaignsSendnowNameGetCall

campaignsSendnowNameGet

campaignsSendnowNameGetWithHttpInfo

campaignsSendnowNameGetAsync

campaignsSendnowNamePutCall

campaignsSendnowNamePut

campaignsSendnowNamePutWithHttpInfo

campaignsSendnowNamePutAsync

campaignsSendnowPostCall

campaignsSendnowPost

campaignsSendnowPostWithHttpInfo

campaignsSendnowPostAsync

campaignsTasksExportGetCall

campaignsTasksExportGet