ClickSend.Api

Class ContactApi

java.lang.Object

ClickSend.Api.ContactApi

public class ContactApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ContactApi()
ContactApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
String	listsContactsByListIdAndContactIdDelete(Integer listId, Integer contactId) Delete a contact Delete a contact
com.squareup.okhttp.Call	listsContactsByListIdAndContactIdDeleteAsync(Integer listId, Integer contactId, ApiCallback<String> callback) Delete a contact (asynchronously) Delete a contact
com.squareup.okhttp.Call	listsContactsByListIdAndContactIdDeleteCall(Integer listId, Integer contactId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for listsContactsByListIdAndContactIdDelete
ApiResponse<String>	listsContactsByListIdAndContactIdDeleteWithHttpInfo(Integer listId, Integer contactId) Delete a contact Delete a contact
String	listsContactsByListIdAndContactIdGet(Integer listId, Integer contactId) Get a specific contact Get a specific contact
com.squareup.okhttp.Call	listsContactsByListIdAndContactIdGetAsync(Integer listId, Integer contactId, ApiCallback<String> callback) Get a specific contact (asynchronously) Get a specific contact
com.squareup.okhttp.Call	listsContactsByListIdAndContactIdGetCall(Integer listId, Integer contactId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for listsContactsByListIdAndContactIdGet
ApiResponse<String>	listsContactsByListIdAndContactIdGetWithHttpInfo(Integer listId, Integer contactId) Get a specific contact Get a specific contact
String	listsContactsByListIdAndContactIdPut(Integer listId, Integer contactId, Contact contact) Update specific contact Update specific contact
com.squareup.okhttp.Call	listsContactsByListIdAndContactIdPutAsync(Integer listId, Integer contactId, Contact contact, ApiCallback<String> callback) Update specific contact (asynchronously) Update specific contact
com.squareup.okhttp.Call	listsContactsByListIdAndContactIdPutCall(Integer listId, Integer contactId, Contact contact, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for listsContactsByListIdAndContactIdPut
ApiResponse<String>	listsContactsByListIdAndContactIdPutWithHttpInfo(Integer listId, Integer contactId, Contact contact) Update specific contact Update specific contact
String	listsContactsByListIdGet(Integer listId, Integer page, Integer limit) Get all contacts in a list Get all contacts in a list
com.squareup.okhttp.Call	listsContactsByListIdGetAsync(Integer listId, Integer page, Integer limit, ApiCallback<String> callback) Get all contacts in a list (asynchronously) Get all contacts in a list
com.squareup.okhttp.Call	listsContactsByListIdGetCall(Integer listId, Integer page, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for listsContactsByListIdGet
ApiResponse<String>	listsContactsByListIdGetWithHttpInfo(Integer listId, Integer page, Integer limit) Get all contacts in a list Get all contacts in a list
String	listsContactsByListIdPost(Contact contact, Integer listId) Create new contact Create new contact
com.squareup.okhttp.Call	listsContactsByListIdPostAsync(Contact contact, Integer listId, ApiCallback<String> callback) Create new contact (asynchronously) Create new contact
com.squareup.okhttp.Call	listsContactsByListIdPostCall(Contact contact, Integer listId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for listsContactsByListIdPost
ApiResponse<String>	listsContactsByListIdPostWithHttpInfo(Contact contact, Integer listId) Create new contact Create new contact
String	listsRemoveOptedOutContactsByListIdAndOptOutListIdPut(Integer listId, Integer optOutListId) Remove all opted out contacts Remove all opted out contacts
com.squareup.okhttp.Call	listsRemoveOptedOutContactsByListIdAndOptOutListIdPutAsync(Integer listId, Integer optOutListId, ApiCallback<String> callback) Remove all opted out contacts (asynchronously) Remove all opted out contacts
com.squareup.okhttp.Call	listsRemoveOptedOutContactsByListIdAndOptOutListIdPutCall(Integer listId, Integer optOutListId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for listsRemoveOptedOutContactsByListIdAndOptOutListIdPut
ApiResponse<String>	listsRemoveOptedOutContactsByListIdAndOptOutListIdPutWithHttpInfo(Integer listId, Integer optOutListId) Remove all opted out contacts Remove all opted out contacts
String	listsTransferContactPut(Integer fromListId, Integer contactId, Integer toListId) Transfer contact to another list Transfer contact to another list
com.squareup.okhttp.Call	listsTransferContactPutAsync(Integer fromListId, Integer contactId, Integer toListId, ApiCallback<String> callback) Transfer contact to another list (asynchronously) Transfer contact to another list
com.squareup.okhttp.Call	listsTransferContactPutCall(Integer fromListId, Integer contactId, Integer toListId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for listsTransferContactPut
ApiResponse<String>	listsTransferContactPutWithHttpInfo(Integer fromListId, Integer contactId, Integer toListId) Transfer contact to another list Transfer contact to another list
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ContactApi

public ContactApi()

ContactApi

public ContactApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

listsContactsByListIdAndContactIdDeleteCall

public com.squareup.okhttp.Call listsContactsByListIdAndContactIdDeleteCall(Integer listId,
                                                                            Integer contactId,
                                                                            ProgressResponseBody.ProgressListener progressListener,
                                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                                     throws ApiException

Build call for listsContactsByListIdAndContactIdDelete

Parameters:

listId - List ID (required)

contactId - Contact ID (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listsContactsByListIdAndContactIdDelete

public String listsContactsByListIdAndContactIdDelete(Integer listId,
                                                      Integer contactId)
                                               throws ApiException

Delete a contact Delete a contact

Parameters:

listId - List ID (required)

contactId - Contact ID (required)

Returns:

String

Throws:

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

listsContactsByListIdAndContactIdDeleteWithHttpInfo

public ApiResponse<String> listsContactsByListIdAndContactIdDeleteWithHttpInfo(Integer listId,
                                                                               Integer contactId)
                                                                        throws ApiException

Delete a contact Delete a contact

Parameters:

listId - List ID (required)

contactId - Contact ID (required)

Returns:

ApiResponse<String>

Throws:

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

listsContactsByListIdAndContactIdDeleteAsync

public com.squareup.okhttp.Call listsContactsByListIdAndContactIdDeleteAsync(Integer listId,
                                                                             Integer contactId,
                                                                             ApiCallback<String> callback)
                                                                      throws ApiException

Delete a contact (asynchronously) Delete a contact

Parameters:

listId - List ID (required)

contactId - Contact ID (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

listsContactsByListIdAndContactIdGetCall

public com.squareup.okhttp.Call listsContactsByListIdAndContactIdGetCall(Integer listId,
                                                                         Integer contactId,
                                                                         ProgressResponseBody.ProgressListener progressListener,
                                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                                  throws ApiException

Build call for listsContactsByListIdAndContactIdGet

Parameters:

listId - Your contact list id you want to access. (required)

contactId - Your contact id you want to access. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listsContactsByListIdAndContactIdGet

public String listsContactsByListIdAndContactIdGet(Integer listId,
                                                   Integer contactId)
                                            throws ApiException

Get a specific contact Get a specific contact

Parameters:

listId - Your contact list id you want to access. (required)

contactId - Your contact id you want to access. (required)

Returns:

String

Throws:

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

listsContactsByListIdAndContactIdGetWithHttpInfo

public ApiResponse<String> listsContactsByListIdAndContactIdGetWithHttpInfo(Integer listId,
                                                                            Integer contactId)
                                                                     throws ApiException

Get a specific contact Get a specific contact

Parameters:

listId - Your contact list id you want to access. (required)

contactId - Your contact id you want to access. (required)

Returns:

ApiResponse<String>

Throws:

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

listsContactsByListIdAndContactIdGetAsync

public com.squareup.okhttp.Call listsContactsByListIdAndContactIdGetAsync(Integer listId,
                                                                          Integer contactId,
                                                                          ApiCallback<String> callback)
                                                                   throws ApiException

Get a specific contact (asynchronously) Get a specific contact

Parameters:

listId - Your contact list id you want to access. (required)

contactId - Your contact id you want to access. (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

listsContactsByListIdAndContactIdPutCall

public com.squareup.okhttp.Call listsContactsByListIdAndContactIdPutCall(Integer listId,
                                                                         Integer contactId,
                                                                         Contact contact,
                                                                         ProgressResponseBody.ProgressListener progressListener,
                                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                                  throws ApiException

Build call for listsContactsByListIdAndContactIdPut

Parameters:

listId - Contact list id (required)

contactId - Contact ID (required)

contact - Contact model (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listsContactsByListIdAndContactIdPut

public String listsContactsByListIdAndContactIdPut(Integer listId,
                                                   Integer contactId,
                                                   Contact contact)
                                            throws ApiException

Update specific contact Update specific contact

Parameters:

listId - Contact list id (required)

contactId - Contact ID (required)

contact - Contact model (required)

Returns:

String

Throws:

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

listsContactsByListIdAndContactIdPutWithHttpInfo

public ApiResponse<String> listsContactsByListIdAndContactIdPutWithHttpInfo(Integer listId,
                                                                            Integer contactId,
                                                                            Contact contact)
                                                                     throws ApiException

Update specific contact Update specific contact

Parameters:

listId - Contact list id (required)

contactId - Contact ID (required)

contact - Contact model (required)

Returns:

ApiResponse<String>

Throws:

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

listsContactsByListIdAndContactIdPutAsync

public com.squareup.okhttp.Call listsContactsByListIdAndContactIdPutAsync(Integer listId,
                                                                          Integer contactId,
                                                                          Contact contact,
                                                                          ApiCallback<String> callback)
                                                                   throws ApiException

Update specific contact (asynchronously) Update specific contact

Parameters:

listId - Contact list id (required)

contactId - Contact ID (required)

contact - Contact 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

listsContactsByListIdGetCall

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

Build call for listsContactsByListIdGet

Parameters:

listId - Contact list ID (required)

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

listsContactsByListIdGet

public String listsContactsByListIdGet(Integer listId,
                                       Integer page,
                                       Integer limit)
                                throws ApiException

Get all contacts in a list Get all contacts in a list

Parameters:

listId - Contact list ID (required)

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

listsContactsByListIdGetWithHttpInfo

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

Get all contacts in a list Get all contacts in a list

Parameters:

listId - Contact list ID (required)

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

listsContactsByListIdGetAsync

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

Get all contacts in a list (asynchronously) Get all contacts in a list

Parameters:

listId - Contact list ID (required)

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

listsContactsByListIdPostCall

public com.squareup.okhttp.Call listsContactsByListIdPostCall(Contact contact,
                                                              Integer listId,
                                                              ProgressResponseBody.ProgressListener progressListener,
                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                       throws ApiException

Build call for listsContactsByListIdPost

Parameters:

contact - Contact model (required)

listId - List id (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listsContactsByListIdPost

public String listsContactsByListIdPost(Contact contact,
                                        Integer listId)
                                 throws ApiException

Create new contact Create new contact

Parameters:

contact - Contact model (required)

listId - List id (required)

Returns:

String

Throws:

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

listsContactsByListIdPostWithHttpInfo

public ApiResponse<String> listsContactsByListIdPostWithHttpInfo(Contact contact,
                                                                 Integer listId)
                                                          throws ApiException

Create new contact Create new contact

Parameters:

contact - Contact model (required)

listId - List id (required)

Returns:

ApiResponse<String>

Throws:

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

listsContactsByListIdPostAsync

public com.squareup.okhttp.Call listsContactsByListIdPostAsync(Contact contact,
                                                               Integer listId,
                                                               ApiCallback<String> callback)
                                                        throws ApiException

Create new contact (asynchronously) Create new contact

Parameters:

contact - Contact model (required)

listId - List id (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

listsRemoveOptedOutContactsByListIdAndOptOutListIdPutCall

public com.squareup.okhttp.Call listsRemoveOptedOutContactsByListIdAndOptOutListIdPutCall(Integer listId,
                                                                                          Integer optOutListId,
                                                                                          ProgressResponseBody.ProgressListener progressListener,
                                                                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                                                   throws ApiException

Build call for listsRemoveOptedOutContactsByListIdAndOptOutListIdPut

Parameters:

listId - Your list id (required)

optOutListId - Your opt out list id (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listsRemoveOptedOutContactsByListIdAndOptOutListIdPut

public String listsRemoveOptedOutContactsByListIdAndOptOutListIdPut(Integer listId,
                                                                    Integer optOutListId)
                                                             throws ApiException

Remove all opted out contacts Remove all opted out contacts

Parameters:

listId - Your list id (required)

optOutListId - Your opt out list id (required)

Returns:

String

Throws:

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

listsRemoveOptedOutContactsByListIdAndOptOutListIdPutWithHttpInfo

public ApiResponse<String> listsRemoveOptedOutContactsByListIdAndOptOutListIdPutWithHttpInfo(Integer listId,
                                                                                             Integer optOutListId)
                                                                                      throws ApiException

Remove all opted out contacts Remove all opted out contacts

Parameters:

listId - Your list id (required)

optOutListId - Your opt out list id (required)

Returns:

ApiResponse<String>

Throws:

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

listsRemoveOptedOutContactsByListIdAndOptOutListIdPutAsync

public com.squareup.okhttp.Call listsRemoveOptedOutContactsByListIdAndOptOutListIdPutAsync(Integer listId,
                                                                                           Integer optOutListId,
                                                                                           ApiCallback<String> callback)
                                                                                    throws ApiException

Remove all opted out contacts (asynchronously) Remove all opted out contacts

Parameters:

listId - Your list id (required)

optOutListId - Your opt out list id (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

listsTransferContactPutCall

public com.squareup.okhttp.Call listsTransferContactPutCall(Integer fromListId,
                                                            Integer contactId,
                                                            Integer toListId,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for listsTransferContactPut

Parameters:

fromListId - List ID for list that contains contact. (required)

contactId - Contact ID (required)

toListId - List ID for list you want to transfer contact to. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listsTransferContactPut

public String listsTransferContactPut(Integer fromListId,
                                      Integer contactId,
                                      Integer toListId)
                               throws ApiException

Transfer contact to another list Transfer contact to another list

Parameters:

fromListId - List ID for list that contains contact. (required)

contactId - Contact ID (required)

toListId - List ID for list you want to transfer contact to. (required)

Returns:

String

Throws:

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

listsTransferContactPutWithHttpInfo

public ApiResponse<String> listsTransferContactPutWithHttpInfo(Integer fromListId,
                                                               Integer contactId,
                                                               Integer toListId)
                                                        throws ApiException

Transfer contact to another list Transfer contact to another list

Parameters:

fromListId - List ID for list that contains contact. (required)

contactId - Contact ID (required)

toListId - List ID for list you want to transfer contact to. (required)

Returns:

ApiResponse<String>

Throws:

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

listsTransferContactPutAsync

public com.squareup.okhttp.Call listsTransferContactPutAsync(Integer fromListId,
                                                             Integer contactId,
                                                             Integer toListId,
                                                             ApiCallback<String> callback)
                                                      throws ApiException

Transfer contact to another list (asynchronously) Transfer contact to another list

Parameters:

fromListId - List ID for list that contains contact. (required)

contactId - Contact ID (required)

toListId - List ID for list you want to transfer contact 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