sibApi

Class ListsApi

java.lang.Object

sibApi.ListsApi

public class ListsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ListsApi()
ListsApi(ApiClient apiClient)

Method Summary

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

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)

addContactToListCall

public com.squareup.okhttp.Call addContactToListCall(Long listId,
                                                     AddContactToList contactEmails,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for addContactToList

Parameters:

listId - Id of the list (required)

contactEmails - Emails addresses OR IDs of the contacts (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

addContactToList

public PostContactInfo addContactToList(Long listId,
                                        AddContactToList contactEmails)
                                 throws ApiException

Add existing contacts to a list

Parameters:

listId - Id of the list (required)

contactEmails - Emails addresses OR IDs of the contacts (required)

Returns:

PostContactInfo

Throws:

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

addContactToListWithHttpInfo

public ApiResponse<PostContactInfo> addContactToListWithHttpInfo(Long listId,
                                                                 AddContactToList contactEmails)
                                                          throws ApiException

Add existing contacts to a list

Parameters:

listId - Id of the list (required)

contactEmails - Emails addresses OR IDs of the contacts (required)

Returns:

ApiResponse<PostContactInfo>

Throws:

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

addContactToListAsync

public com.squareup.okhttp.Call addContactToListAsync(Long listId,
                                                      AddContactToList contactEmails,
                                                      ApiCallback<PostContactInfo> callback)
                                               throws ApiException

Add existing contacts to a list (asynchronously)

Parameters:

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 finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

createListCall

public com.squareup.okhttp.Call createListCall(CreateList createList,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for createList

Parameters:

createList - Values to create a list (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createList

public CreateModel createList(CreateList createList)
                       throws ApiException

Create a list

Parameters:

createList - Values to create a list (required)

Returns:

CreateModel

Throws:

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

createListWithHttpInfo

public ApiResponse<CreateModel> createListWithHttpInfo(CreateList createList)
                                                throws ApiException

Create a list

Parameters:

createList - Values to create a list (required)

Returns:

ApiResponse<CreateModel>

Throws:

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

createListAsync

public com.squareup.okhttp.Call createListAsync(CreateList createList,
                                                ApiCallback<CreateModel> callback)
                                         throws ApiException

Create a list (asynchronously)

Parameters:

createList - Values to create a 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

deleteListCall

public com.squareup.okhttp.Call deleteListCall(Long listId,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for deleteList

Parameters:

listId - Id of the list (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteList

public void deleteList(Long listId)
                throws ApiException

Delete a list

Parameters:

listId - Id of the list (required)

Throws:

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

deleteListWithHttpInfo

public ApiResponse<Void> deleteListWithHttpInfo(Long listId)
                                         throws ApiException

Delete a list

Parameters:

listId - Id of the list (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteListAsync

public com.squareup.okhttp.Call deleteListAsync(Long listId,
                                                ApiCallback<Void> callback)
                                         throws ApiException

Delete a list (asynchronously)

Parameters:

listId - Id of the 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

getContactsFromListCall

public com.squareup.okhttp.Call getContactsFromListCall(Long listId,
                                                        String modifiedSince,
                                                        Long limit,
                                                        Long offset,
                                                        String sort,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for getContactsFromList

Parameters:

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 listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getContactsFromList

public GetContacts getContactsFromList(Long listId,
                                       String modifiedSince,
                                       Long limit,
                                       Long offset,
                                       String sort)
                                throws ApiException

Get contacts in a list

Parameters:

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)

Returns:

GetContacts

Throws:

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

getContactsFromListWithHttpInfo

public ApiResponse<GetContacts> getContactsFromListWithHttpInfo(Long listId,
                                                                String modifiedSince,
                                                                Long limit,
                                                                Long offset,
                                                                String sort)
                                                         throws ApiException

Get contacts in a list

Parameters:

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)

Returns:

ApiResponse<GetContacts>

Throws:

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

getContactsFromListAsync

public com.squareup.okhttp.Call getContactsFromListAsync(Long listId,
                                                         String modifiedSince,
                                                         Long limit,
                                                         Long offset,
                                                         String sort,
                                                         ApiCallback<GetContacts> callback)
                                                  throws ApiException

Get contacts in a list (asynchronously)

Parameters:

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 finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getFolderListsCall

public com.squareup.okhttp.Call getFolderListsCall(Long folderId,
                                                   Long limit,
                                                   Long offset,
                                                   String sort,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for getFolderLists

Parameters:

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 listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getFolderLists

public GetFolderLists getFolderLists(Long folderId,
                                     Long limit,
                                     Long offset,
                                     String sort)
                              throws ApiException

Get lists in a folder

Parameters:

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)

Returns:

GetFolderLists

Throws:

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

getFolderListsWithHttpInfo

public ApiResponse<GetFolderLists> getFolderListsWithHttpInfo(Long folderId,
                                                              Long limit,
                                                              Long offset,
                                                              String sort)
                                                       throws ApiException

Get lists in a folder

Parameters:

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)

Returns:

ApiResponse<GetFolderLists>

Throws:

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

getFolderListsAsync

public com.squareup.okhttp.Call getFolderListsAsync(Long folderId,
                                                    Long limit,
                                                    Long offset,
                                                    String sort,
                                                    ApiCallback<GetFolderLists> callback)
                                             throws ApiException

Get lists in a folder (asynchronously)

Parameters:

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 finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getListCall

public com.squareup.okhttp.Call getListCall(Long listId,
                                            ProgressResponseBody.ProgressListener progressListener,
                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                     throws ApiException

Build call for getList

Parameters:

listId - Id of the list (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getList

public GetExtendedList getList(Long listId)
                        throws ApiException

Get a list's details

Parameters:

listId - Id of the list (required)

Returns:

GetExtendedList

Throws:

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

getListWithHttpInfo

public ApiResponse<GetExtendedList> getListWithHttpInfo(Long listId)
                                                 throws ApiException

Get a list's details

Parameters:

listId - Id of the list (required)

Returns:

ApiResponse<GetExtendedList>

Throws:

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

getListAsync

public com.squareup.okhttp.Call getListAsync(Long listId,
                                             ApiCallback<GetExtendedList> callback)
                                      throws ApiException

Get a list's details (asynchronously)

Parameters:

listId - Id of the 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

getListsCall

public com.squareup.okhttp.Call getListsCall(Long limit,
                                             Long offset,
                                             String sort,
                                             ProgressResponseBody.ProgressListener progressListener,
                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                      throws ApiException

Build call for getLists

Parameters:

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 listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getLists

public GetLists getLists(Long limit,
                         Long offset,
                         String sort)
                  throws ApiException

Get all the lists

Parameters:

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)

Returns:

GetLists

Throws:

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

getListsWithHttpInfo

public ApiResponse<GetLists> getListsWithHttpInfo(Long limit,
                                                  Long offset,
                                                  String sort)
                                           throws ApiException

Get all the lists

Parameters:

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)

Returns:

ApiResponse<GetLists>

Throws:

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

getListsAsync

public com.squareup.okhttp.Call getListsAsync(Long limit,
                                              Long offset,
                                              String sort,
                                              ApiCallback<GetLists> callback)
                                       throws ApiException

Get all the lists (asynchronously)

Parameters:

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 finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

removeContactFromListCall

public com.squareup.okhttp.Call removeContactFromListCall(Long listId,
                                                          RemoveContactFromList contactEmails,
                                                          ProgressResponseBody.ProgressListener progressListener,
                                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                   throws ApiException

Build call for removeContactFromList

Parameters:

listId - Id of the list (required)

contactEmails - Emails addresses OR IDs of the contacts (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

removeContactFromList

public PostContactInfo removeContactFromList(Long listId,
                                             RemoveContactFromList contactEmails)
                                      throws ApiException

Delete a contact from a list

Parameters:

listId - Id of the list (required)

contactEmails - Emails addresses OR IDs of the contacts (required)

Returns:

PostContactInfo

Throws:

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

removeContactFromListWithHttpInfo

public ApiResponse<PostContactInfo> removeContactFromListWithHttpInfo(Long listId,
                                                                      RemoveContactFromList contactEmails)
                                                               throws ApiException

Delete a contact from a list

Parameters:

listId - Id of the list (required)

contactEmails - Emails addresses OR IDs of the contacts (required)

Returns:

ApiResponse<PostContactInfo>

Throws:

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

removeContactFromListAsync

public com.squareup.okhttp.Call removeContactFromListAsync(Long listId,
                                                           RemoveContactFromList contactEmails,
                                                           ApiCallback<PostContactInfo> callback)
                                                    throws ApiException

Delete a contact from a list (asynchronously)

Parameters:

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 finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

updateListCall

public com.squareup.okhttp.Call updateListCall(Long listId,
                                               UpdateList updateList,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for updateList

Parameters:

listId - Id of the list (required)

updateList - Values to update a list (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateList

public void updateList(Long listId,
                       UpdateList updateList)
                throws ApiException

Update a list

Parameters:

listId - Id of the list (required)

updateList - Values to update a list (required)

Throws:

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

updateListWithHttpInfo

public ApiResponse<Void> updateListWithHttpInfo(Long listId,
                                                UpdateList updateList)
                                         throws ApiException

Update a list

Parameters:

listId - Id of the list (required)

updateList - Values to update a list (required)

Returns:

ApiResponse<Void>

Throws:

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

updateListAsync

public com.squareup.okhttp.Call updateListAsync(Long listId,
                                                UpdateList updateList,
                                                ApiCallback<Void> callback)
                                         throws ApiException

Update a list (asynchronously)

Parameters:

listId - Id of the list (required)

updateList - Values to update a 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