io.swagger.client.api

Class ListsApi

java.lang.Object

io.swagger.client.api.ListsApi

public class ListsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ListsApi()
ListsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
List	listsFromcampaignPost(CampaignListPayload body) Create a new list from the recipients of the given campaign, using the given statuses of Messages
com.squareup.okhttp.Call	listsFromcampaignPostAsync(CampaignListPayload body, ApiCallback<List> callback) Create a new list from the recipients of the given campaign, using the given statuses of Messages (asynchronously)
com.squareup.okhttp.Call	listsFromcampaignPostCall(CampaignListPayload body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for listsFromcampaignPost
ApiResponse<List>	listsFromcampaignPostWithHttpInfo(CampaignListPayload body) Create a new list from the recipients of the given campaign, using the given statuses of Messages
List<List>	listsGet(String from, String to) Shows all your existing lists
com.squareup.okhttp.Call	listsGetAsync(String from, String to, ApiCallback<List<List>> callback) Shows all your existing lists (asynchronously)
com.squareup.okhttp.Call	listsGetCall(String from, String to, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for listsGet
ApiResponse<List<List>>	listsGetWithHttpInfo(String from, String to) Shows all your existing lists
void	listsListnameContactsDelete(String listname, List<String> emails, String rule) Remove selected Contacts from your list
com.squareup.okhttp.Call	listsListnameContactsDeleteAsync(String listname, List<String> emails, String rule, ApiCallback<Void> callback) Remove selected Contacts from your list (asynchronously)
com.squareup.okhttp.Call	listsListnameContactsDeleteCall(String listname, List<String> emails, String rule, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for listsListnameContactsDelete
ApiResponse<Void>	listsListnameContactsDeleteWithHttpInfo(String listname, List<String> emails, String rule) Remove selected Contacts from your list
List	listsListnameContactsMovePut(String listname, MoveToListPayload body) Move selected contacts from one List to another
com.squareup.okhttp.Call	listsListnameContactsMovePutAsync(String listname, MoveToListPayload body, ApiCallback<List> callback) Move selected contacts from one List to another (asynchronously)
com.squareup.okhttp.Call	listsListnameContactsMovePutCall(String listname, MoveToListPayload body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for listsListnameContactsMovePut
ApiResponse<List>	listsListnameContactsMovePutWithHttpInfo(String listname, MoveToListPayload body) Move selected contacts from one List to another
List	listsListnameContactsPut(String listname, EmailsPayload body) Add existing Contacts to chosen list
com.squareup.okhttp.Call	listsListnameContactsPutAsync(String listname, EmailsPayload body, ApiCallback<List> callback) Add existing Contacts to chosen list (asynchronously)
com.squareup.okhttp.Call	listsListnameContactsPutCall(String listname, EmailsPayload body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for listsListnameContactsPut
ApiResponse<List>	listsListnameContactsPutWithHttpInfo(String listname, EmailsPayload body) Add existing Contacts to chosen list
void	listsListnameDelete(String listname) Deletes List and removes all the Contacts from it (does not delete Contacts).
com.squareup.okhttp.Call	listsListnameDeleteAsync(String listname, ApiCallback<Void> callback) Deletes List and removes all the Contacts from it (does not delete Contacts).
com.squareup.okhttp.Call	listsListnameDeleteCall(String listname, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for listsListnameDelete
ApiResponse<Void>	listsListnameDeleteWithHttpInfo(String listname) Deletes List and removes all the Contacts from it (does not delete Contacts).
List	listsListnameGet(String listname) Returns detailed information about specific list.
com.squareup.okhttp.Call	listsListnameGetAsync(String listname, ApiCallback<List> callback) Returns detailed information about specific list.
com.squareup.okhttp.Call	listsListnameGetCall(String listname, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for listsListnameGet
ApiResponse<List>	listsListnameGetWithHttpInfo(String listname) Returns detailed information about specific list.
List	listsListnamePut(String listname, ListUpdatePayload body) Update existing list
com.squareup.okhttp.Call	listsListnamePutAsync(String listname, ListUpdatePayload body, ApiCallback<List> callback) Update existing list (asynchronously)
com.squareup.okhttp.Call	listsListnamePutCall(String listname, ListUpdatePayload body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for listsListnamePut
ApiResponse<List>	listsListnamePutWithHttpInfo(String listname, ListUpdatePayload body) Update existing list
List	listsPost(ListPayload body) Create new list, based on filtering rule or list of IDs
com.squareup.okhttp.Call	listsPostAsync(ListPayload body, ApiCallback<List> callback) Create new list, based on filtering rule or list of IDs (asynchronously)
com.squareup.okhttp.Call	listsPostCall(ListPayload body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for listsPost
ApiResponse<List>	listsPostWithHttpInfo(ListPayload body) Create new list, based on filtering rule or list of IDs
List	listsRandomPost(RandomListPayload body) Create a new list with randomized contacts from an existing list or segment
com.squareup.okhttp.Call	listsRandomPostAsync(RandomListPayload body, ApiCallback<List> callback) Create a new list with randomized contacts from an existing list or segment (asynchronously)
com.squareup.okhttp.Call	listsRandomPostCall(RandomListPayload body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for listsRandomPost
ApiResponse<List>	listsRandomPostWithHttpInfo(RandomListPayload body) Create a new list with randomized contacts from an existing list or segment
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ListsApi

public ListsApi()

ListsApi

public ListsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

listsFromcampaignPostCall

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

Build call for listsFromcampaignPost

Parameters:

body - Data of the campaign which recipients you want to copy (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listsFromcampaignPost

public List listsFromcampaignPost(CampaignListPayload body)
                           throws ApiException

Create a new list from the recipients of the given campaign, using the given statuses of Messages

Parameters:

body - Data of the campaign which recipients you want to copy (required)

Returns:

List

Throws:

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

listsFromcampaignPostWithHttpInfo

public ApiResponse<List> listsFromcampaignPostWithHttpInfo(CampaignListPayload body)
                                                    throws ApiException

Create a new list from the recipients of the given campaign, using the given statuses of Messages

Parameters:

body - Data of the campaign which recipients you want to copy (required)

Returns:

ApiResponse<List>

Throws:

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

listsFromcampaignPostAsync

public com.squareup.okhttp.Call listsFromcampaignPostAsync(CampaignListPayload body,
                                                           ApiCallback<List> callback)
                                                    throws ApiException

Create a new list from the recipients of the given campaign, using the given statuses of Messages (asynchronously)

Parameters:

body - Data of the campaign which recipients you want to copy (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

listsGetCall

public com.squareup.okhttp.Call listsGetCall(String from,
                                             String to,
                                             ProgressResponseBody.ProgressListener progressListener,
                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                      throws ApiException

Build call for listsGet

Parameters:

from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional)

to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listsGet

public List<List> listsGet(String from,
                           String to)
                    throws ApiException

Shows all your existing lists

Parameters:

from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional)

to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional)

Returns:

List<List>

Throws:

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

listsGetWithHttpInfo

public ApiResponse<List<List>> listsGetWithHttpInfo(String from,
                                                    String to)
                                             throws ApiException

Shows all your existing lists

Parameters:

from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional)

to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional)

Returns:

ApiResponse<List<List>>

Throws:

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

listsGetAsync

public com.squareup.okhttp.Call listsGetAsync(String from,
                                              String to,
                                              ApiCallback<List<List>> callback)
                                       throws ApiException

Shows all your existing lists (asynchronously)

Parameters:

from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional)

to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (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

listsListnameContactsDeleteCall

public com.squareup.okhttp.Call listsListnameContactsDeleteCall(String listname,
                                                                List<String> emails,
                                                                String rule,
                                                                ProgressResponseBody.ProgressListener progressListener,
                                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                         throws ApiException

Build call for listsListnameContactsDelete

Parameters:

listname - Name of your list. (required)

emails - Comma delimited list of contact emails (optional)

rule - Query used for filtering. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listsListnameContactsDelete

public void listsListnameContactsDelete(String listname,
                                        List<String> emails,
                                        String rule)
                                 throws ApiException

Remove selected Contacts from your list

Parameters:

listname - Name of your list. (required)

emails - Comma delimited list of contact emails (optional)

rule - Query used for filtering. (optional)

Throws:

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

listsListnameContactsDeleteWithHttpInfo

public ApiResponse<Void> listsListnameContactsDeleteWithHttpInfo(String listname,
                                                                 List<String> emails,
                                                                 String rule)
                                                          throws ApiException

Remove selected Contacts from your list

Parameters:

listname - Name of your list. (required)

emails - Comma delimited list of contact emails (optional)

rule - Query used for filtering. (optional)

Returns:

ApiResponse<Void>

Throws:

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

listsListnameContactsDeleteAsync

public com.squareup.okhttp.Call listsListnameContactsDeleteAsync(String listname,
                                                                 List<String> emails,
                                                                 String rule,
                                                                 ApiCallback<Void> callback)
                                                          throws ApiException

Remove selected Contacts from your list (asynchronously)

Parameters:

listname - Name of your list. (required)

emails - Comma delimited list of contact emails (optional)

rule - Query used for filtering. (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

listsListnameContactsMovePutCall

public com.squareup.okhttp.Call listsListnameContactsMovePutCall(String listname,
                                                                 MoveToListPayload body,
                                                                 ProgressResponseBody.ProgressListener progressListener,
                                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                          throws ApiException

Build call for listsListnameContactsMovePut

Parameters:

listname - The name of the list from which the contacts will be copied from (required)

body - The data of the list to copy the contacts to (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listsListnameContactsMovePut

public List listsListnameContactsMovePut(String listname,
                                         MoveToListPayload body)
                                  throws ApiException

Move selected contacts from one List to another

Parameters:

listname - The name of the list from which the contacts will be copied from (required)

body - The data of the list to copy the contacts to (required)

Returns:

List

Throws:

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

listsListnameContactsMovePutWithHttpInfo

public ApiResponse<List> listsListnameContactsMovePutWithHttpInfo(String listname,
                                                                  MoveToListPayload body)
                                                           throws ApiException

Move selected contacts from one List to another

Parameters:

listname - The name of the list from which the contacts will be copied from (required)

body - The data of the list to copy the contacts to (required)

Returns:

ApiResponse<List>

Throws:

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

listsListnameContactsMovePutAsync

public com.squareup.okhttp.Call listsListnameContactsMovePutAsync(String listname,
                                                                  MoveToListPayload body,
                                                                  ApiCallback<List> callback)
                                                           throws ApiException

Move selected contacts from one List to another (asynchronously)

Parameters:

listname - The name of the list from which the contacts will be copied from (required)

body - The data of the list to copy the contacts 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

listsListnameContactsPutCall

public com.squareup.okhttp.Call listsListnameContactsPutCall(String listname,
                                                             EmailsPayload body,
                                                             ProgressResponseBody.ProgressListener progressListener,
                                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                      throws ApiException

Build call for listsListnameContactsPut

Parameters:

listname - Name of your list. (required)

body - Comma delimited list of contact emails (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listsListnameContactsPut

public List listsListnameContactsPut(String listname,
                                     EmailsPayload body)
                              throws ApiException

Add existing Contacts to chosen list

Parameters:

listname - Name of your list. (required)

body - Comma delimited list of contact emails (required)

Returns:

List

Throws:

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

listsListnameContactsPutWithHttpInfo

public ApiResponse<List> listsListnameContactsPutWithHttpInfo(String listname,
                                                              EmailsPayload body)
                                                       throws ApiException

Add existing Contacts to chosen list

Parameters:

listname - Name of your list. (required)

body - Comma delimited list of contact emails (required)

Returns:

ApiResponse<List>

Throws:

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

listsListnameContactsPutAsync

public com.squareup.okhttp.Call listsListnameContactsPutAsync(String listname,
                                                              EmailsPayload body,
                                                              ApiCallback<List> callback)
                                                       throws ApiException

Add existing Contacts to chosen list (asynchronously)

Parameters:

listname - Name of your list. (required)

body - Comma delimited list of contact emails (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

listsListnameDeleteCall

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

Build call for listsListnameDelete

Parameters:

listname - Name of your list. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listsListnameDelete

public void listsListnameDelete(String listname)
                         throws ApiException

Deletes List and removes all the Contacts from it (does not delete Contacts).

Parameters:

listname - Name of your list. (required)

Throws:

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

listsListnameDeleteWithHttpInfo

public ApiResponse<Void> listsListnameDeleteWithHttpInfo(String listname)
                                                  throws ApiException

Deletes List and removes all the Contacts from it (does not delete Contacts).

Parameters:

listname - Name of your list. (required)

Returns:

ApiResponse<Void>

Throws:

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

listsListnameDeleteAsync

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

Deletes List and removes all the Contacts from it (does not delete Contacts). (asynchronously)

Parameters:

listname - Name of your list. (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

listsListnameGetCall

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

Build call for listsListnameGet

Parameters:

listname - Name of your list. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listsListnameGet

public List listsListnameGet(String listname)
                      throws ApiException

Returns detailed information about specific list.

Parameters:

listname - Name of your list. (required)

Returns:

List

Throws:

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

listsListnameGetWithHttpInfo

public ApiResponse<List> listsListnameGetWithHttpInfo(String listname)
                                               throws ApiException

Returns detailed information about specific list.

Parameters:

listname - Name of your list. (required)

Returns:

ApiResponse<List>

Throws:

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

listsListnameGetAsync

public com.squareup.okhttp.Call listsListnameGetAsync(String listname,
                                                      ApiCallback<List> callback)
                                               throws ApiException

Returns detailed information about specific list. (asynchronously)

Parameters:

listname - Name of your list. (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

listsListnamePutCall

public com.squareup.okhttp.Call listsListnamePutCall(String listname,
                                                     ListUpdatePayload body,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for listsListnamePut

Parameters:

listname - Name of your list. (required)

body - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listsListnamePut

public List listsListnamePut(String listname,
                             ListUpdatePayload body)
                      throws ApiException

Update existing list

Parameters:

listname - Name of your list. (required)

body - (required)

Returns:

List

Throws:

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

listsListnamePutWithHttpInfo

public ApiResponse<List> listsListnamePutWithHttpInfo(String listname,
                                                      ListUpdatePayload body)
                                               throws ApiException

Update existing list

Parameters:

listname - Name of your list. (required)

body - (required)

Returns:

ApiResponse<List>

Throws:

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

listsListnamePutAsync

public com.squareup.okhttp.Call listsListnamePutAsync(String listname,
                                                      ListUpdatePayload body,
                                                      ApiCallback<List> callback)
                                               throws ApiException

Update existing list (asynchronously)

Parameters:

listname - Name of your list. (required)

body - (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

listsPostCall

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

Build call for listsPost

Parameters:

body - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listsPost

public List listsPost(ListPayload body)
               throws ApiException

Create new list, based on filtering rule or list of IDs

Parameters:

body - (required)

Returns:

List

Throws:

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

listsPostWithHttpInfo

public ApiResponse<List> listsPostWithHttpInfo(ListPayload body)
                                        throws ApiException

Create new list, based on filtering rule or list of IDs

Parameters:

body - (required)

Returns:

ApiResponse<List>

Throws:

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

listsPostAsync

public com.squareup.okhttp.Call listsPostAsync(ListPayload body,
                                               ApiCallback<List> callback)
                                        throws ApiException

Create new list, based on filtering rule or list of IDs (asynchronously)

Parameters:

body - (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

listsRandomPostCall

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

Build call for listsRandomPost

Parameters:

body - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listsRandomPost

public List listsRandomPost(RandomListPayload body)
                     throws ApiException

Create a new list with randomized contacts from an existing list or segment

Parameters:

body - (required)

Returns:

List

Throws:

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

listsRandomPostWithHttpInfo

public ApiResponse<List> listsRandomPostWithHttpInfo(RandomListPayload body)
                                              throws ApiException

Create a new list with randomized contacts from an existing list or segment

Parameters:

body - (required)

Returns:

ApiResponse<List>

Throws:

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

listsRandomPostAsync

public com.squareup.okhttp.Call listsRandomPostAsync(RandomListPayload body,
                                                     ApiCallback<List> callback)
                                              throws ApiException

Create a new list with randomized contacts from an existing list or segment (asynchronously)

Parameters:

body - (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