ContactsApi (sib-api-v3-sdk 5.3.0 API)

java.lang.Object
- sibApi.ContactsApi

```
public class ContactsApi
extends Object
```

Constructor Summary

Constructors
Constructor and Description

ContactsApi()

ContactsApi(ApiClient apiClient)

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

Method Summary

All Methods Instance Methods Concrete Methods
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
`void`	`createAttribute(String attributeCategory, String attributeName, CreateAttribute createAttribute)` Create contact attribute
`com.squareup.okhttp.Call`	`createAttributeAsync(String attributeCategory, String attributeName, CreateAttribute createAttribute, ApiCallback<Void> callback)` Create contact attribute (asynchronously)
`com.squareup.okhttp.Call`	`createAttributeCall(String attributeCategory, String attributeName, CreateAttribute createAttribute, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for createAttribute
`ApiResponse<Void>`	`createAttributeWithHttpInfo(String attributeCategory, String attributeName, CreateAttribute createAttribute)` Create contact attribute
`CreateUpdateContactModel`	`createContact(CreateContact createContact)` Create a contact
`com.squareup.okhttp.Call`	`createContactAsync(CreateContact createContact, ApiCallback<CreateUpdateContactModel> callback)` Create a contact (asynchronously)
`com.squareup.okhttp.Call`	`createContactCall(CreateContact createContact, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for createContact
`ApiResponse<CreateUpdateContactModel>`	`createContactWithHttpInfo(CreateContact createContact)` Create a contact
`void`	`createDoiContact(CreateDoiContact createDoiContact)` Create Contact via DOI (Double-Opt-In) Flow
`com.squareup.okhttp.Call`	`createDoiContactAsync(CreateDoiContact createDoiContact, ApiCallback<Void> callback)` Create Contact via DOI (Double-Opt-In) Flow (asynchronously)
`com.squareup.okhttp.Call`	`createDoiContactCall(CreateDoiContact createDoiContact, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for createDoiContact
`ApiResponse<Void>`	`createDoiContactWithHttpInfo(CreateDoiContact createDoiContact)` Create Contact via DOI (Double-Opt-In) Flow
`CreateModel`	`createFolder(CreateUpdateFolder createFolder)` Create a folder
`com.squareup.okhttp.Call`	`createFolderAsync(CreateUpdateFolder createFolder, ApiCallback<CreateModel> callback)` Create a folder (asynchronously)
`com.squareup.okhttp.Call`	`createFolderCall(CreateUpdateFolder createFolder, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for createFolder
`ApiResponse<CreateModel>`	`createFolderWithHttpInfo(CreateUpdateFolder createFolder)` Create a folder
`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`	`deleteAttribute(String attributeCategory, String attributeName)` Delete an attribute
`com.squareup.okhttp.Call`	`deleteAttributeAsync(String attributeCategory, String attributeName, ApiCallback<Void> callback)` Delete an attribute (asynchronously)
`com.squareup.okhttp.Call`	`deleteAttributeCall(String attributeCategory, String attributeName, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for deleteAttribute
`ApiResponse<Void>`	`deleteAttributeWithHttpInfo(String attributeCategory, String attributeName)` Delete an attribute
`void`	`deleteContact(String identifier)` Delete a contact
`com.squareup.okhttp.Call`	`deleteContactAsync(String identifier, ApiCallback<Void> callback)` Delete a contact (asynchronously)
`com.squareup.okhttp.Call`	`deleteContactCall(String identifier, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for deleteContact
`ApiResponse<Void>`	`deleteContactWithHttpInfo(String identifier)` Delete a contact
`void`	`deleteFolder(Long folderId)` Delete a folder (and all its lists)
`com.squareup.okhttp.Call`	`deleteFolderAsync(Long folderId, ApiCallback<Void> callback)` Delete a folder (and all its lists) (asynchronously)
`com.squareup.okhttp.Call`	`deleteFolderCall(Long folderId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for deleteFolder
`ApiResponse<Void>`	`deleteFolderWithHttpInfo(Long folderId)` Delete a folder (and all its lists)
`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()`
`GetAttributes`	`getAttributes()` List all attributes
`com.squareup.okhttp.Call`	`getAttributesAsync(ApiCallback<GetAttributes> callback)` List all attributes (asynchronously)
`com.squareup.okhttp.Call`	`getAttributesCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getAttributes
`ApiResponse<GetAttributes>`	`getAttributesWithHttpInfo()` List all attributes
`GetExtendedContactDetails`	`getContactInfo(String identifier)` Get a contact's details
`com.squareup.okhttp.Call`	`getContactInfoAsync(String identifier, ApiCallback<GetExtendedContactDetails> callback)` Get a contact's details (asynchronously)
`com.squareup.okhttp.Call`	`getContactInfoCall(String identifier, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getContactInfo
`ApiResponse<GetExtendedContactDetails>`	`getContactInfoWithHttpInfo(String identifier)` Get a contact's details
`GetContacts`	`getContacts(Long limit, Long offset, String modifiedSince, String sort)` Get all the contacts
`com.squareup.okhttp.Call`	`getContactsAsync(Long limit, Long offset, String modifiedSince, String sort, ApiCallback<GetContacts> callback)` Get all the contacts (asynchronously)
`com.squareup.okhttp.Call`	`getContactsCall(Long limit, Long offset, String modifiedSince, String sort, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getContacts
`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
`GetContactCampaignStats`	`getContactStats(String identifier, String startDate, String endDate)` Get email campaigns' statistics for a contact
`com.squareup.okhttp.Call`	`getContactStatsAsync(String identifier, String startDate, String endDate, ApiCallback<GetContactCampaignStats> callback)` Get email campaigns' statistics for a contact (asynchronously)
`com.squareup.okhttp.Call`	`getContactStatsCall(String identifier, String startDate, String endDate, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getContactStats
`ApiResponse<GetContactCampaignStats>`	`getContactStatsWithHttpInfo(String identifier, String startDate, String endDate)` Get email campaigns' statistics for a contact
`ApiResponse<GetContacts>`	`getContactsWithHttpInfo(Long limit, Long offset, String modifiedSince, String sort)` Get all the contacts
`GetFolder`	`getFolder(Long folderId)` Returns a folder's details
`com.squareup.okhttp.Call`	`getFolderAsync(Long folderId, ApiCallback<GetFolder> callback)` Returns a folder's details (asynchronously)
`com.squareup.okhttp.Call`	`getFolderCall(Long folderId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getFolder
`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
`GetFolders`	`getFolders(Long limit, Long offset, String sort)` Get all folders
`com.squareup.okhttp.Call`	`getFoldersAsync(Long limit, Long offset, String sort, ApiCallback<GetFolders> callback)` Get all folders (asynchronously)
`com.squareup.okhttp.Call`	`getFoldersCall(Long limit, Long offset, String sort, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getFolders
`ApiResponse<GetFolders>`	`getFoldersWithHttpInfo(Long limit, Long offset, String sort)` Get all folders
`ApiResponse<GetFolder>`	`getFolderWithHttpInfo(Long folderId)` Returns a folder's details
`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
`CreatedProcessId`	`importContacts(RequestContactImport requestContactImport)` Import contacts It returns the background process ID which on completion calls the notify URL that you have set in the input.
`com.squareup.okhttp.Call`	`importContactsAsync(RequestContactImport requestContactImport, ApiCallback<CreatedProcessId> callback)` Import contacts (asynchronously) It returns the background process ID which on completion calls the notify URL that you have set in the input.
`com.squareup.okhttp.Call`	`importContactsCall(RequestContactImport requestContactImport, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for importContacts
`ApiResponse<CreatedProcessId>`	`importContactsWithHttpInfo(RequestContactImport requestContactImport)` Import contacts It returns the background process ID which on completion calls the notify URL that you have set in the input.
`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
`CreatedProcessId`	`requestContactExport(RequestContactExport requestContactExport)` Export contacts It returns the background process ID which on completion calls the notify URL that you have set in the input.
`com.squareup.okhttp.Call`	`requestContactExportAsync(RequestContactExport requestContactExport, ApiCallback<CreatedProcessId> callback)` Export contacts (asynchronously) It returns the background process ID which on completion calls the notify URL that you have set in the input.
`com.squareup.okhttp.Call`	`requestContactExportCall(RequestContactExport requestContactExport, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for requestContactExport
`ApiResponse<CreatedProcessId>`	`requestContactExportWithHttpInfo(RequestContactExport requestContactExport)` Export contacts It returns the background process ID which on completion calls the notify URL that you have set in the input.
`void`	`setApiClient(ApiClient apiClient)`
`void`	`updateAttribute(String attributeCategory, String attributeName, UpdateAttribute updateAttribute)` Update contact attribute
`com.squareup.okhttp.Call`	`updateAttributeAsync(String attributeCategory, String attributeName, UpdateAttribute updateAttribute, ApiCallback<Void> callback)` Update contact attribute (asynchronously)
`com.squareup.okhttp.Call`	`updateAttributeCall(String attributeCategory, String attributeName, UpdateAttribute updateAttribute, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for updateAttribute
`ApiResponse<Void>`	`updateAttributeWithHttpInfo(String attributeCategory, String attributeName, UpdateAttribute updateAttribute)` Update contact attribute
`void`	`updateContact(String identifier, UpdateContact updateContact)` Update a contact
`com.squareup.okhttp.Call`	`updateContactAsync(String identifier, UpdateContact updateContact, ApiCallback<Void> callback)` Update a contact (asynchronously)
`com.squareup.okhttp.Call`	`updateContactCall(String identifier, UpdateContact updateContact, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for updateContact
`ApiResponse<Void>`	`updateContactWithHttpInfo(String identifier, UpdateContact updateContact)` Update a contact
`void`	`updateFolder(Long folderId, CreateUpdateFolder updateFolder)` Update a folder
`com.squareup.okhttp.Call`	`updateFolderAsync(Long folderId, CreateUpdateFolder updateFolder, ApiCallback<Void> callback)` Update a folder (asynchronously)
`com.squareup.okhttp.Call`	`updateFolderCall(Long folderId, CreateUpdateFolder updateFolder, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for updateFolder
`ApiResponse<Void>`	`updateFolderWithHttpInfo(Long folderId, CreateUpdateFolder updateFolder)` Update a folder
`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

ContactsApi
```
public ContactsApi()
```

ContactsApi

public ContactsApi(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

createAttributeCall

public com.squareup.okhttp.Call createAttributeCall(String attributeCategory,
                                                    String attributeName,
                                                    CreateAttribute createAttribute,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for createAttribute

Parameters:: attributeCategory - Category of the attribute (required); attributeName - Name of the attribute (required); createAttribute - Values to create an attribute (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

createAttribute
```
public void createAttribute(String attributeCategory,
                            String attributeName,
                            CreateAttribute createAttribute)
                     throws ApiException
```
Create contact attribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the attribute (required)

createAttribute - Values to create an attribute (required)

Throws:

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

createAttributeWithHttpInfo

public ApiResponse<Void> createAttributeWithHttpInfo(String attributeCategory,
                                                     String attributeName,
                                                     CreateAttribute createAttribute)
                                              throws ApiException

Create contact attribute

Parameters:: attributeCategory - Category of the attribute (required); attributeName - Name of the attribute (required); createAttribute - Values to create an attribute (required)
Returns:: ApiResponse<Void>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createAttributeAsync

public com.squareup.okhttp.Call createAttributeAsync(String attributeCategory,
                                                     String attributeName,
                                                     CreateAttribute createAttribute,
                                                     ApiCallback<Void> callback)
                                              throws ApiException

Create contact attribute (asynchronously)

Parameters:: attributeCategory - Category of the attribute (required); attributeName - Name of the attribute (required); createAttribute - Values to create an attribute (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

createContactCall

public com.squareup.okhttp.Call createContactCall(CreateContact createContact,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for createContact

Parameters:: createContact - Values to create a contact (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

createContact
```
public CreateUpdateContactModel createContact(CreateContact createContact)
                                       throws ApiException
```
Create a contact

Parameters:

createContact - Values to create a contact (required)

Returns:

CreateUpdateContactModel

Throws:

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

createContactWithHttpInfo
```
public ApiResponse<CreateUpdateContactModel> createContactWithHttpInfo(CreateContact createContact)
                                                                throws ApiException
```
Create a contact

Parameters:

createContact - Values to create a contact (required)

Returns:

ApiResponse<CreateUpdateContactModel>

Throws:

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

createContactAsync

public com.squareup.okhttp.Call createContactAsync(CreateContact createContact,
                                                   ApiCallback<CreateUpdateContactModel> callback)
                                            throws ApiException

Create a contact (asynchronously)

Parameters:: createContact - Values to create a contact (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

createDoiContactCall

public com.squareup.okhttp.Call createDoiContactCall(CreateDoiContact createDoiContact,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for createDoiContact

Parameters:: createDoiContact - Values to create the Double opt-in (DOI) contact (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

createDoiContact
```
public void createDoiContact(CreateDoiContact createDoiContact)
                      throws ApiException
```
Create Contact via DOI (Double-Opt-In) Flow

Parameters:

createDoiContact - Values to create the Double opt-in (DOI) contact (required)

Throws:

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

createDoiContactWithHttpInfo
```
public ApiResponse<Void> createDoiContactWithHttpInfo(CreateDoiContact createDoiContact)
                                               throws ApiException
```
Create Contact via DOI (Double-Opt-In) Flow

Parameters:

createDoiContact - Values to create the Double opt-in (DOI) contact (required)

Returns:

ApiResponse<Void>

Throws:

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

createDoiContactAsync
```
public com.squareup.okhttp.Call createDoiContactAsync(CreateDoiContact createDoiContact,
                                                      ApiCallback<Void> callback)
                                               throws ApiException
```
Create Contact via DOI (Double-Opt-In) Flow (asynchronously)

Parameters:

createDoiContact - Values to create the Double opt-in (DOI) contact (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

createFolderCall

public com.squareup.okhttp.Call createFolderCall(CreateUpdateFolder createFolder,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for createFolder

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

createFolder
```
public CreateModel createFolder(CreateUpdateFolder createFolder)
                         throws ApiException
```
Create a folder

Parameters:

createFolder - Name of the folder (required)

Returns:

CreateModel

Throws:

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

createFolderWithHttpInfo
```
public ApiResponse<CreateModel> createFolderWithHttpInfo(CreateUpdateFolder createFolder)
                                                  throws ApiException
```
Create a folder

Parameters:

createFolder - Name of the folder (required)

Returns:

ApiResponse<CreateModel>

Throws:

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

createFolderAsync

public com.squareup.okhttp.Call createFolderAsync(CreateUpdateFolder createFolder,
                                                  ApiCallback<CreateModel> callback)
                                           throws ApiException

Create a folder (asynchronously)

Parameters:: createFolder - Name of the folder (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

deleteAttributeCall

public com.squareup.okhttp.Call deleteAttributeCall(String attributeCategory,
                                                    String attributeName,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for deleteAttribute

Parameters:: attributeCategory - Category of the attribute (required); attributeName - Name of the existing attribute (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

deleteAttribute
```
public void deleteAttribute(String attributeCategory,
                            String attributeName)
                     throws ApiException
```
Delete an attribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the existing attribute (required)

Throws:

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

deleteAttributeWithHttpInfo
```
public ApiResponse<Void> deleteAttributeWithHttpInfo(String attributeCategory,
                                                     String attributeName)
                                              throws ApiException
```
Delete an attribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the existing attribute (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteAttributeAsync

public com.squareup.okhttp.Call deleteAttributeAsync(String attributeCategory,
                                                     String attributeName,
                                                     ApiCallback<Void> callback)
                                              throws ApiException

Delete an attribute (asynchronously)

Parameters:: attributeCategory - Category of the attribute (required); attributeName - Name of the existing attribute (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

deleteContactCall

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

Build call for deleteContact

Parameters:: identifier - Email (urlencoded) OR ID of the contact (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

deleteContact
```
public void deleteContact(String identifier)
                   throws ApiException
```
Delete a contact

Parameters:

identifier - Email (urlencoded) OR ID of the contact (required)

Throws:

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

deleteContactWithHttpInfo
```
public ApiResponse<Void> deleteContactWithHttpInfo(String identifier)
                                            throws ApiException
```
Delete a contact

Parameters:

identifier - Email (urlencoded) OR ID of the contact (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteContactAsync
```
public com.squareup.okhttp.Call deleteContactAsync(String identifier,
                                                   ApiCallback<Void> callback)
                                            throws ApiException
```
Delete a contact (asynchronously)

Parameters:

identifier - Email (urlencoded) OR ID of the contact (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

deleteFolderCall

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

Build call for deleteFolder

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

deleteFolder
```
public void deleteFolder(Long folderId)
                  throws ApiException
```
Delete a folder (and all its lists)

Parameters:

folderId - Id of the folder (required)

Throws:

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

deleteFolderWithHttpInfo
```
public ApiResponse<Void> deleteFolderWithHttpInfo(Long folderId)
                                           throws ApiException
```
Delete a folder (and all its lists)

Parameters:

folderId - Id of the folder (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteFolderAsync
```
public com.squareup.okhttp.Call deleteFolderAsync(Long folderId,
                                                  ApiCallback<Void> callback)
                                           throws ApiException
```
Delete a folder (and all its lists) (asynchronously)

Parameters:

folderId - Id of the folder (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

getAttributesCall

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

Build call for getAttributes

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

getAttributes
```
public GetAttributes getAttributes()
                            throws ApiException
```
List all attributes

Returns:

GetAttributes

Throws:

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

getAttributesWithHttpInfo
```
public ApiResponse<GetAttributes> getAttributesWithHttpInfo()
                                                     throws ApiException
```
List all attributes

Returns:

ApiResponse<GetAttributes>

Throws:

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

getAttributesAsync
```
public com.squareup.okhttp.Call getAttributesAsync(ApiCallback<GetAttributes> callback)
                                            throws ApiException
```
List all attributes (asynchronously)

Parameters:

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

getContactInfoCall

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

Build call for getContactInfo

Parameters:: identifier - Email (urlencoded) OR ID of the contact OR its SMS attribute value (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

getContactInfo
```
public GetExtendedContactDetails getContactInfo(String identifier)
                                         throws ApiException
```
Get a contact's details

Parameters:

identifier - Email (urlencoded) OR ID of the contact OR its SMS attribute value (required)

Returns:

GetExtendedContactDetails

Throws:

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

getContactInfoWithHttpInfo
```
public ApiResponse<GetExtendedContactDetails> getContactInfoWithHttpInfo(String identifier)
                                                                  throws ApiException
```
Get a contact's details

Parameters:

identifier - Email (urlencoded) OR ID of the contact OR its SMS attribute value (required)

Returns:

ApiResponse<GetExtendedContactDetails>

Throws:

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

getContactInfoAsync
```
public com.squareup.okhttp.Call getContactInfoAsync(String identifier,
                                                    ApiCallback<GetExtendedContactDetails> callback)
                                             throws ApiException
```
Get a contact's details (asynchronously)

Parameters:

identifier - Email (urlencoded) OR ID of the contact OR its SMS attribute value (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

getContactStatsCall

public com.squareup.okhttp.Call getContactStatsCall(String identifier,
                                                    String startDate,
                                                    String endDate,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for getContactStats

Parameters:: identifier - Email (urlencoded) OR ID of the contact (required); startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional); endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

getContactStats
```
public GetContactCampaignStats getContactStats(String identifier,
                                               String startDate,
                                               String endDate)
                                        throws ApiException
```
Get email campaigns' statistics for a contact

Parameters:

identifier - Email (urlencoded) OR ID of the contact (required)

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate (optional)

Returns:

GetContactCampaignStats

Throws:

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

getContactStatsWithHttpInfo
```
public ApiResponse<GetContactCampaignStats> getContactStatsWithHttpInfo(String identifier,
                                                                        String startDate,
                                                                        String endDate)
                                                                 throws ApiException
```
Get email campaigns' statistics for a contact

Parameters:

identifier - Email (urlencoded) OR ID of the contact (required)

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate (optional)

Returns:

ApiResponse<GetContactCampaignStats>

Throws:

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

getContactStatsAsync
```
public com.squareup.okhttp.Call getContactStatsAsync(String identifier,
                                                     String startDate,
                                                     String endDate,
                                                     ApiCallback<GetContactCampaignStats> callback)
                                              throws ApiException
```
Get email campaigns' statistics for a contact (asynchronously)

Parameters:

identifier - Email (urlencoded) OR ID of the contact (required)

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate (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

getContactsCall

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

Build call for getContacts

Parameters:: limit - Number of documents per page (optional, default to 50); offset - Index of the first document of the page (optional, default to 0); 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); 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

getContacts
```
public GetContacts getContacts(Long limit,
                               Long offset,
                               String modifiedSince,
                               String sort)
                        throws ApiException
```
Get all the contacts

Parameters:

limit - Number of documents per page (optional, default to 50)

offset - Index of the first document of the page (optional, default to 0)

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)

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

getContactsWithHttpInfo
```
public ApiResponse<GetContacts> getContactsWithHttpInfo(Long limit,
                                                        Long offset,
                                                        String modifiedSince,
                                                        String sort)
                                                 throws ApiException
```
Get all the contacts

Parameters:

limit - Number of documents per page (optional, default to 50)

offset - Index of the first document of the page (optional, default to 0)

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)

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

getContactsAsync
```
public com.squareup.okhttp.Call getContactsAsync(Long limit,
                                                 Long offset,
                                                 String modifiedSince,
                                                 String sort,
                                                 ApiCallback<GetContacts> callback)
                                          throws ApiException
```
Get all the contacts (asynchronously)

Parameters:

limit - Number of documents per page (optional, default to 50)

offset - Index of the first document of the page (optional, default to 0)

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)

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

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

getFolderCall

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

Build call for getFolder

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

getFolder
```
public GetFolder getFolder(Long folderId)
                    throws ApiException
```
Returns a folder's details

Parameters:

folderId - id of the folder (required)

Returns:

GetFolder

Throws:

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

getFolderWithHttpInfo
```
public ApiResponse<GetFolder> getFolderWithHttpInfo(Long folderId)
                                             throws ApiException
```
Returns a folder's details

Parameters:

folderId - id of the folder (required)

Returns:

ApiResponse<GetFolder>

Throws:

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

getFolderAsync
```
public com.squareup.okhttp.Call getFolderAsync(Long folderId,
                                               ApiCallback<GetFolder> callback)
                                        throws ApiException
```
Returns a folder's details (asynchronously)

Parameters:

folderId - id of the folder (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

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

getFoldersCall

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

Build call for getFolders

Parameters:: limit - Number of documents per page (required); offset - Index of the first document of the page (required); 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

getFolders
```
public GetFolders getFolders(Long limit,
                             Long offset,
                             String sort)
                      throws ApiException
```
Get all folders

Parameters:

limit - Number of documents per page (required)

offset - Index of the first document of the page (required)

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:

GetFolders

Throws:

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

getFoldersWithHttpInfo
```
public ApiResponse<GetFolders> getFoldersWithHttpInfo(Long limit,
                                                      Long offset,
                                                      String sort)
                                               throws ApiException
```
Get all folders

Parameters:

limit - Number of documents per page (required)

offset - Index of the first document of the page (required)

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<GetFolders>

Throws:

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

getFoldersAsync
```
public com.squareup.okhttp.Call getFoldersAsync(Long limit,
                                                Long offset,
                                                String sort,
                                                ApiCallback<GetFolders> callback)
                                         throws ApiException
```
Get all folders (asynchronously)

Parameters:

limit - Number of documents per page (required)

offset - Index of the first document of the page (required)

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

importContactsCall

public com.squareup.okhttp.Call importContactsCall(RequestContactImport requestContactImport,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for importContacts

Parameters:: requestContactImport - Values to import contacts in Sendinblue. To know more about the expected format, please have a look at ``https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

importContacts
```
public CreatedProcessId importContacts(RequestContactImport requestContactImport)
                                throws ApiException
```
Import contacts It returns the background process ID which on completion calls the notify URL that you have set in the input.

Parameters:

requestContactImport - Values to import contacts in Sendinblue. To know more about the expected format, please have a look at ``https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` (required)

Returns:

CreatedProcessId

Throws:

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

importContactsWithHttpInfo
```
public ApiResponse<CreatedProcessId> importContactsWithHttpInfo(RequestContactImport requestContactImport)
                                                         throws ApiException
```
Import contacts It returns the background process ID which on completion calls the notify URL that you have set in the input.

Parameters:

requestContactImport - Values to import contacts in Sendinblue. To know more about the expected format, please have a look at ``https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` (required)

Returns:

ApiResponse<CreatedProcessId>

Throws:

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

importContactsAsync
```
public com.squareup.okhttp.Call importContactsAsync(RequestContactImport requestContactImport,
                                                    ApiCallback<CreatedProcessId> callback)
                                             throws ApiException
```
Import contacts (asynchronously) It returns the background process ID which on completion calls the notify URL that you have set in the input.

Parameters:

requestContactImport - Values to import contacts in Sendinblue. To know more about the expected format, please have a look at ``https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` (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

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

requestContactExportCall

public com.squareup.okhttp.Call requestContactExportCall(RequestContactExport requestContactExport,
                                                         ProgressResponseBody.ProgressListener progressListener,
                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                  throws ApiException

Build call for requestContactExport

Parameters:: requestContactExport - Values to request a contact export (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

requestContactExport
```
public CreatedProcessId requestContactExport(RequestContactExport requestContactExport)
                                      throws ApiException
```
Export contacts It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.

Parameters:

requestContactExport - Values to request a contact export (required)

Returns:

CreatedProcessId

Throws:

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

requestContactExportWithHttpInfo
```
public ApiResponse<CreatedProcessId> requestContactExportWithHttpInfo(RequestContactExport requestContactExport)
                                                               throws ApiException
```
Export contacts It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.

Parameters:

requestContactExport - Values to request a contact export (required)

Returns:

ApiResponse<CreatedProcessId>

Throws:

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

requestContactExportAsync
```
public com.squareup.okhttp.Call requestContactExportAsync(RequestContactExport requestContactExport,
                                                          ApiCallback<CreatedProcessId> callback)
                                                   throws ApiException
```
Export contacts (asynchronously) It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.

Parameters:

requestContactExport - Values to request a contact export (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

updateAttributeCall

public com.squareup.okhttp.Call updateAttributeCall(String attributeCategory,
                                                    String attributeName,
                                                    UpdateAttribute updateAttribute,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for updateAttribute

Parameters:: attributeCategory - Category of the attribute (required); attributeName - Name of the existing attribute (required); updateAttribute - Values to update an attribute (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

updateAttribute
```
public void updateAttribute(String attributeCategory,
                            String attributeName,
                            UpdateAttribute updateAttribute)
                     throws ApiException
```
Update contact attribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the existing attribute (required)

updateAttribute - Values to update an attribute (required)

Throws:

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

updateAttributeWithHttpInfo

public ApiResponse<Void> updateAttributeWithHttpInfo(String attributeCategory,
                                                     String attributeName,
                                                     UpdateAttribute updateAttribute)
                                              throws ApiException

Update contact attribute

Parameters:: attributeCategory - Category of the attribute (required); attributeName - Name of the existing attribute (required); updateAttribute - Values to update an attribute (required)
Returns:: ApiResponse<Void>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateAttributeAsync

public com.squareup.okhttp.Call updateAttributeAsync(String attributeCategory,
                                                     String attributeName,
                                                     UpdateAttribute updateAttribute,
                                                     ApiCallback<Void> callback)
                                              throws ApiException

Update contact attribute (asynchronously)

Parameters:: attributeCategory - Category of the attribute (required); attributeName - Name of the existing attribute (required); updateAttribute - Values to update an attribute (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

updateContactCall

public com.squareup.okhttp.Call updateContactCall(String identifier,
                                                  UpdateContact updateContact,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for updateContact

Parameters:: identifier - Email (urlencoded) OR ID of the contact (required); updateContact - Values to update a contact (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

updateContact
```
public void updateContact(String identifier,
                          UpdateContact updateContact)
                   throws ApiException
```
Update a contact

Parameters:

identifier - Email (urlencoded) OR ID of the contact (required)

updateContact - Values to update a contact (required)

Throws:

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

updateContactWithHttpInfo
```
public ApiResponse<Void> updateContactWithHttpInfo(String identifier,
                                                   UpdateContact updateContact)
                                            throws ApiException
```
Update a contact

Parameters:

identifier - Email (urlencoded) OR ID of the contact (required)

updateContact - Values to update a contact (required)

Returns:

ApiResponse<Void>

Throws:

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

updateContactAsync

public com.squareup.okhttp.Call updateContactAsync(String identifier,
                                                   UpdateContact updateContact,
                                                   ApiCallback<Void> callback)
                                            throws ApiException

Update a contact (asynchronously)

Parameters:: identifier - Email (urlencoded) OR ID of the contact (required); updateContact - Values to update a contact (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

updateFolderCall

public com.squareup.okhttp.Call updateFolderCall(Long folderId,
                                                 CreateUpdateFolder updateFolder,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for updateFolder

Parameters:: folderId - Id of the folder (required); updateFolder - Name of the folder (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

updateFolder
```
public void updateFolder(Long folderId,
                         CreateUpdateFolder updateFolder)
                  throws ApiException
```
Update a folder

Parameters:

folderId - Id of the folder (required)

updateFolder - Name of the folder (required)

Throws:

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

updateFolderWithHttpInfo

public ApiResponse<Void> updateFolderWithHttpInfo(Long folderId,
                                                  CreateUpdateFolder updateFolder)
                                           throws ApiException

Update a folder

Parameters:: folderId - Id of the folder (required); updateFolder - Name of the folder (required)
Returns:: ApiResponse<Void>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateFolderAsync

public com.squareup.okhttp.Call updateFolderAsync(Long folderId,
                                                  CreateUpdateFolder updateFolder,
                                                  ApiCallback<Void> callback)
                                           throws ApiException

Update a folder (asynchronously)

Parameters:: folderId - Id of the folder (required); updateFolder - Name of the folder (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

Class ContactsApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ContactsApi

ContactsApi

Method Detail

getApiClient

setApiClient

addContactToListCall

addContactToList

addContactToListWithHttpInfo

addContactToListAsync

createAttributeCall

createAttribute

createAttributeWithHttpInfo

createAttributeAsync

createContactCall

createContact

createContactWithHttpInfo

createContactAsync

createDoiContactCall

createDoiContact

createDoiContactWithHttpInfo

createDoiContactAsync

createFolderCall

createFolder

createFolderWithHttpInfo

createFolderAsync

createListCall

createList

createListWithHttpInfo

createListAsync

deleteAttributeCall

deleteAttribute

deleteAttributeWithHttpInfo

deleteAttributeAsync

deleteContactCall

deleteContact

deleteContactWithHttpInfo

deleteContactAsync

deleteFolderCall

deleteFolder

deleteFolderWithHttpInfo

deleteFolderAsync

deleteListCall

deleteList

deleteListWithHttpInfo

deleteListAsync

getAttributesCall

getAttributes

getAttributesWithHttpInfo

getAttributesAsync

getContactInfoCall

getContactInfo

getContactInfoWithHttpInfo

getContactInfoAsync

getContactStatsCall

getContactStats

getContactStatsWithHttpInfo

getContactStatsAsync

getContactsCall

getContacts

getContactsWithHttpInfo

getContactsAsync

getContactsFromListCall

getContactsFromList

getContactsFromListWithHttpInfo

getContactsFromListAsync

getFolderCall

getFolder

getFolderWithHttpInfo

getFolderAsync

getFolderListsCall

getFolderLists

getFolderListsWithHttpInfo

getFolderListsAsync

getFoldersCall

getFolders