public class ListsApi extends Object
| Constructor and Description |
|---|
ListsApi() |
ListsApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
PostContactInfo |
addContactToList(Long listId,
AddContactToList contactEmails)
Add existing contacts to a list
|
com.squareup.okhttp.Call |
addContactToListAsync(Long listId,
AddContactToList contactEmails,
ApiCallback<PostContactInfo> callback)
Add existing contacts to a list (asynchronously)
|
com.squareup.okhttp.Call |
addContactToListCall(Long listId,
AddContactToList contactEmails,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for addContactToList
|
ApiResponse<PostContactInfo> |
addContactToListWithHttpInfo(Long listId,
AddContactToList contactEmails)
Add existing contacts to a list
|
CreateModel |
createList(CreateList createList)
Create a list
|
com.squareup.okhttp.Call |
createListAsync(CreateList createList,
ApiCallback<CreateModel> callback)
Create a list (asynchronously)
|
com.squareup.okhttp.Call |
createListCall(CreateList createList,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createList
|
ApiResponse<CreateModel> |
createListWithHttpInfo(CreateList createList)
Create a list
|
void |
deleteList(Long listId)
Delete a list
|
com.squareup.okhttp.Call |
deleteListAsync(Long listId,
ApiCallback<Void> callback)
Delete a list (asynchronously)
|
com.squareup.okhttp.Call |
deleteListCall(Long listId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for deleteList
|
ApiResponse<Void> |
deleteListWithHttpInfo(Long listId)
Delete a list
|
ApiClient |
getApiClient() |
GetContacts |
getContactsFromList(Long listId,
String modifiedSince,
Long limit,
Long offset,
String sort)
Get contacts in a list
|
com.squareup.okhttp.Call |
getContactsFromListAsync(Long listId,
String modifiedSince,
Long limit,
Long offset,
String sort,
ApiCallback<GetContacts> callback)
Get contacts in a list (asynchronously)
|
com.squareup.okhttp.Call |
getContactsFromListCall(Long listId,
String modifiedSince,
Long limit,
Long offset,
String sort,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getContactsFromList
|
ApiResponse<GetContacts> |
getContactsFromListWithHttpInfo(Long listId,
String modifiedSince,
Long limit,
Long offset,
String sort)
Get contacts in a list
|
GetFolderLists |
getFolderLists(Long folderId,
Long limit,
Long offset,
String sort)
Get lists in a folder
|
com.squareup.okhttp.Call |
getFolderListsAsync(Long folderId,
Long limit,
Long offset,
String sort,
ApiCallback<GetFolderLists> callback)
Get lists in a folder (asynchronously)
|
com.squareup.okhttp.Call |
getFolderListsCall(Long folderId,
Long limit,
Long offset,
String sort,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getFolderLists
|
ApiResponse<GetFolderLists> |
getFolderListsWithHttpInfo(Long folderId,
Long limit,
Long offset,
String sort)
Get lists in a folder
|
GetExtendedList |
getList(Long listId)
Get a list's details
|
com.squareup.okhttp.Call |
getListAsync(Long listId,
ApiCallback<GetExtendedList> callback)
Get a list's details (asynchronously)
|
com.squareup.okhttp.Call |
getListCall(Long listId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getList
|
GetLists |
getLists(Long limit,
Long offset,
String sort)
Get all the lists
|
com.squareup.okhttp.Call |
getListsAsync(Long limit,
Long offset,
String sort,
ApiCallback<GetLists> callback)
Get all the lists (asynchronously)
|
com.squareup.okhttp.Call |
getListsCall(Long limit,
Long offset,
String sort,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getLists
|
ApiResponse<GetLists> |
getListsWithHttpInfo(Long limit,
Long offset,
String sort)
Get all the lists
|
ApiResponse<GetExtendedList> |
getListWithHttpInfo(Long listId)
Get a list's details
|
PostContactInfo |
removeContactFromList(Long listId,
RemoveContactFromList contactEmails)
Delete a contact from a list
|
com.squareup.okhttp.Call |
removeContactFromListAsync(Long listId,
RemoveContactFromList contactEmails,
ApiCallback<PostContactInfo> callback)
Delete a contact from a list (asynchronously)
|
com.squareup.okhttp.Call |
removeContactFromListCall(Long listId,
RemoveContactFromList contactEmails,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for removeContactFromList
|
ApiResponse<PostContactInfo> |
removeContactFromListWithHttpInfo(Long listId,
RemoveContactFromList contactEmails)
Delete a contact from a list
|
void |
setApiClient(ApiClient apiClient) |
void |
updateList(Long listId,
UpdateList updateList)
Update a list
|
com.squareup.okhttp.Call |
updateListAsync(Long listId,
UpdateList updateList,
ApiCallback<Void> callback)
Update a list (asynchronously)
|
com.squareup.okhttp.Call |
updateListCall(Long listId,
UpdateList updateList,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for updateList
|
ApiResponse<Void> |
updateListWithHttpInfo(Long listId,
UpdateList updateList)
Update a list
|
public ListsApi()
public ListsApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public com.squareup.okhttp.Call addContactToListCall(Long listId, AddContactToList contactEmails, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
listId - Id of the list (required)contactEmails - Emails addresses OR IDs of the contacts (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic PostContactInfo addContactToList(Long listId, AddContactToList contactEmails) throws ApiException
listId - Id of the list (required)contactEmails - Emails addresses OR IDs of the contacts (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<PostContactInfo> addContactToListWithHttpInfo(Long listId, AddContactToList contactEmails) throws ApiException
listId - Id of the list (required)contactEmails - Emails addresses OR IDs of the contacts (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call addContactToListAsync(Long listId, AddContactToList contactEmails, ApiCallback<PostContactInfo> callback) throws ApiException
listId - Id of the list (required)contactEmails - Emails addresses OR IDs of the contacts (required)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call createListCall(CreateList createList, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
createList - Values to create a list (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic CreateModel createList(CreateList createList) throws ApiException
createList - Values to create a list (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<CreateModel> createListWithHttpInfo(CreateList createList) throws ApiException
createList - Values to create a list (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call createListAsync(CreateList createList, ApiCallback<CreateModel> callback) throws ApiException
createList - Values to create a list (required)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call deleteListCall(Long listId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
listId - Id of the list (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic void deleteList(Long listId) throws ApiException
listId - Id of the list (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Void> deleteListWithHttpInfo(Long listId) throws ApiException
listId - Id of the list (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call deleteListAsync(Long listId, ApiCallback<Void> callback) throws ApiException
listId - Id of the list (required)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call getContactsFromListCall(Long listId, String modifiedSince, Long limit, Long offset, String sort, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
listId - Id of the list (required)modifiedSince - Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional)limit - Number of documents per page (optional, default to 50)offset - Index of the first document of the page (optional, default to 0)sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic GetContacts getContactsFromList(Long listId, String modifiedSince, Long limit, Long offset, String sort) throws ApiException
listId - Id of the list (required)modifiedSince - Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional)limit - Number of documents per page (optional, default to 50)offset - Index of the first document of the page (optional, default to 0)sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<GetContacts> getContactsFromListWithHttpInfo(Long listId, String modifiedSince, Long limit, Long offset, String sort) throws ApiException
listId - Id of the list (required)modifiedSince - Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional)limit - Number of documents per page (optional, default to 50)offset - Index of the first document of the page (optional, default to 0)sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call getContactsFromListAsync(Long listId, String modifiedSince, Long limit, Long offset, String sort, ApiCallback<GetContacts> callback) throws ApiException
listId - Id of the list (required)modifiedSince - Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional)limit - Number of documents per page (optional, default to 50)offset - Index of the first document of the page (optional, default to 0)sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call getFolderListsCall(Long folderId, Long limit, Long offset, String sort, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
folderId - Id of the folder (required)limit - Number of documents per page (optional, default to 10)offset - Index of the first document of the page (optional, default to 0)sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic GetFolderLists getFolderLists(Long folderId, Long limit, Long offset, String sort) throws ApiException
folderId - Id of the folder (required)limit - Number of documents per page (optional, default to 10)offset - Index of the first document of the page (optional, default to 0)sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<GetFolderLists> getFolderListsWithHttpInfo(Long folderId, Long limit, Long offset, String sort) throws ApiException
folderId - Id of the folder (required)limit - Number of documents per page (optional, default to 10)offset - Index of the first document of the page (optional, default to 0)sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call getFolderListsAsync(Long folderId, Long limit, Long offset, String sort, ApiCallback<GetFolderLists> callback) throws ApiException
folderId - Id of the folder (required)limit - Number of documents per page (optional, default to 10)offset - Index of the first document of the page (optional, default to 0)sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call getListCall(Long listId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
listId - Id of the list (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic GetExtendedList getList(Long listId) throws ApiException
listId - Id of the list (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<GetExtendedList> getListWithHttpInfo(Long listId) throws ApiException
listId - Id of the list (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call getListAsync(Long listId, ApiCallback<GetExtendedList> callback) throws ApiException
listId - Id of the list (required)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call getListsCall(Long limit, Long offset, String sort, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
limit - Number of documents per page (optional, default to 10)offset - Index of the first document of the page (optional, default to 0)sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic GetLists getLists(Long limit, Long offset, String sort) throws ApiException
limit - Number of documents per page (optional, default to 10)offset - Index of the first document of the page (optional, default to 0)sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<GetLists> getListsWithHttpInfo(Long limit, Long offset, String sort) throws ApiException
limit - Number of documents per page (optional, default to 10)offset - Index of the first document of the page (optional, default to 0)sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call getListsAsync(Long limit, Long offset, String sort, ApiCallback<GetLists> callback) throws ApiException
limit - Number of documents per page (optional, default to 10)offset - Index of the first document of the page (optional, default to 0)sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call removeContactFromListCall(Long listId, RemoveContactFromList contactEmails, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
listId - Id of the list (required)contactEmails - Emails addresses OR IDs of the contacts (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic PostContactInfo removeContactFromList(Long listId, RemoveContactFromList contactEmails) throws ApiException
listId - Id of the list (required)contactEmails - Emails addresses OR IDs of the contacts (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<PostContactInfo> removeContactFromListWithHttpInfo(Long listId, RemoveContactFromList contactEmails) throws ApiException
listId - Id of the list (required)contactEmails - Emails addresses OR IDs of the contacts (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call removeContactFromListAsync(Long listId, RemoveContactFromList contactEmails, ApiCallback<PostContactInfo> callback) throws ApiException
listId - Id of the list (required)contactEmails - Emails addresses OR IDs of the contacts (required)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call updateListCall(Long listId, UpdateList updateList, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
listId - Id of the list (required)updateList - Values to update a list (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic void updateList(Long listId, UpdateList updateList) throws ApiException
listId - Id of the list (required)updateList - Values to update a list (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Void> updateListWithHttpInfo(Long listId, UpdateList updateList) throws ApiException
listId - Id of the list (required)updateList - Values to update a list (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call updateListAsync(Long listId, UpdateList updateList, ApiCallback<Void> callback) throws ApiException
listId - Id of the list (required)updateList - Values to update a list (required)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectCopyright © 2021. All rights reserved.