io.swagger.client.api

Class ContactsApi

java.lang.Object

io.swagger.client.api.ContactsApi

public class ContactsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ContactsApi()
ContactsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	contactsDelete(String rule, List<String> emails, List<String> listNames) Permanantly deletes the contacts provided.
com.squareup.okhttp.Call	contactsDeleteAsync(String rule, List<String> emails, List<String> listNames, ApiCallback<Void> callback) Permanantly deletes the contacts provided.
com.squareup.okhttp.Call	contactsDeleteCall(String rule, List<String> emails, List<String> listNames, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for contactsDelete
ApiResponse<Void>	contactsDeleteWithHttpInfo(String rule, List<String> emails, List<String> listNames) Permanantly deletes the contacts provided.
Contact	contactsEmailGet(String email) Load detailed contact information
com.squareup.okhttp.Call	contactsEmailGetAsync(String email, ApiCallback<Contact> callback) Load detailed contact information (asynchronously)
com.squareup.okhttp.Call	contactsEmailGetCall(String email, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for contactsEmailGet
ApiResponse<Contact>	contactsEmailGetWithHttpInfo(String email) Load detailed contact information
List<ContactHistory>	contactsEmailHistoryGet(String email, Integer limit, Integer offset) Shows detailed history of chosen Contact.
com.squareup.okhttp.Call	contactsEmailHistoryGetAsync(String email, Integer limit, Integer offset, ApiCallback<List<ContactHistory>> callback) Shows detailed history of chosen Contact.
com.squareup.okhttp.Call	contactsEmailHistoryGetCall(String email, Integer limit, Integer offset, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for contactsEmailHistoryGet
ApiResponse<List<ContactHistory>>	contactsEmailHistoryGetWithHttpInfo(String email, Integer limit, Integer offset) Shows detailed history of chosen Contact.
Contact	contactsEmailPut(String email, ContactUpdatePayload body) Update selected contact.
com.squareup.okhttp.Call	contactsEmailPutAsync(String email, ContactUpdatePayload body, ApiCallback<Contact> callback) Update selected contact.
com.squareup.okhttp.Call	contactsEmailPutCall(String email, ContactUpdatePayload body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for contactsEmailPut
ApiResponse<Contact>	contactsEmailPutWithHttpInfo(String email, ContactUpdatePayload body) Update selected contact.
List<Contact>	contactsGet(String rule, Integer limit, Integer offset) List of all contacts.
com.squareup.okhttp.Call	contactsGetAsync(String rule, Integer limit, Integer offset, ApiCallback<List<Contact>> callback) List of all contacts.
com.squareup.okhttp.Call	contactsGetCall(String rule, Integer limit, Integer offset, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for contactsGet
ApiResponse<List<Contact>>	contactsGetWithHttpInfo(String rule, Integer limit, Integer offset) List of all contacts.
List<Contact>	contactsPost(QuickAddPayload body) Add new Contact to one of your Lists.
com.squareup.okhttp.Call	contactsPostAsync(QuickAddPayload body, ApiCallback<List<Contact>> callback) Add new Contact to one of your Lists.
com.squareup.okhttp.Call	contactsPostCall(QuickAddPayload body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for contactsPost
ApiResponse<List<Contact>>	contactsPostWithHttpInfo(QuickAddPayload body) Add new Contact to one of your Lists.
ContactStats	contactsStatsGet(String rule, List<String> listNames) Returns number of Contacts, RULE specifies contact Status.
com.squareup.okhttp.Call	contactsStatsGetAsync(String rule, List<String> listNames, ApiCallback<ContactStats> callback) Returns number of Contacts, RULE specifies contact Status.
com.squareup.okhttp.Call	contactsStatsGetCall(String rule, List<String> listNames, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for contactsStatsGet
ApiResponse<ContactStats>	contactsStatsGetWithHttpInfo(String rule, List<String> listNames) Returns number of Contacts, RULE specifies contact Status.
ExportLink	contactsTasksExportGet(String fileFormat, String rule, List<String> emails, String compressionFormat, String fileName, List<String> listNames) Export selected Contacts to file.
com.squareup.okhttp.Call	contactsTasksExportGetAsync(String fileFormat, String rule, List<String> emails, String compressionFormat, String fileName, List<String> listNames, ApiCallback<ExportLink> callback) Export selected Contacts to file.
com.squareup.okhttp.Call	contactsTasksExportGetCall(String fileFormat, String rule, List<String> emails, String compressionFormat, String fileName, List<String> listNames, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for contactsTasksExportGet
ApiResponse<ExportLink>	contactsTasksExportGetWithHttpInfo(String fileFormat, String rule, List<String> emails, String compressionFormat, String fileName, List<String> listNames) Export selected Contacts to file.
void	contactsTasksImportPost(File file, Boolean allowUnsubscribe, String listName, String status, String consentDate, String consentIP, String consentTracking) Upload contacts from a file.
com.squareup.okhttp.Call	contactsTasksImportPostAsync(File file, Boolean allowUnsubscribe, String listName, String status, String consentDate, String consentIP, String consentTracking, ApiCallback<Void> callback) Upload contacts from a file.
com.squareup.okhttp.Call	contactsTasksImportPostCall(File file, Boolean allowUnsubscribe, String listName, String status, String consentDate, String consentIP, String consentTracking, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for contactsTasksImportPost
ApiResponse<Void>	contactsTasksImportPostWithHttpInfo(File file, Boolean allowUnsubscribe, String listName, String status, String consentDate, String consentIP, String consentTracking) Upload contacts from a file.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

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)

contactsDeleteCall

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

Build call for contactsDelete

Parameters:

rule - Query used for filtering. (optional)

emails - Comma delimited list of contact emails (optional)

listNames - (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

contactsDelete

public void contactsDelete(String rule,
                           List<String> emails,
                           List<String> listNames)
                    throws ApiException

Permanantly deletes the contacts provided. You can provide either a qualified rule or a list of emails (comma separated string).

Parameters:

rule - Query used for filtering. (optional)

emails - Comma delimited list of contact emails (optional)

listNames - (optional)

Throws:

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

contactsDeleteWithHttpInfo

public ApiResponse<Void> contactsDeleteWithHttpInfo(String rule,
                                                    List<String> emails,
                                                    List<String> listNames)
                                             throws ApiException

Permanantly deletes the contacts provided. You can provide either a qualified rule or a list of emails (comma separated string).

Parameters:

rule - Query used for filtering. (optional)

emails - Comma delimited list of contact emails (optional)

listNames - (optional)

Returns:

ApiResponse<Void>

Throws:

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

contactsDeleteAsync

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

Permanantly deletes the contacts provided. You can provide either a qualified rule or a list of emails (comma separated string). (asynchronously)

Parameters:

rule - Query used for filtering. (optional)

emails - Comma delimited list of contact emails (optional)

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

contactsEmailGetCall

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

Build call for contactsEmailGet

Parameters:

email - Proper email address. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

contactsEmailGet

public Contact contactsEmailGet(String email)
                         throws ApiException

Load detailed contact information

Parameters:

email - Proper email address. (required)

Returns:

Contact

Throws:

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

contactsEmailGetWithHttpInfo

public ApiResponse<Contact> contactsEmailGetWithHttpInfo(String email)
                                                  throws ApiException

Load detailed contact information

Parameters:

email - Proper email address. (required)

Returns:

ApiResponse<Contact>

Throws:

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

contactsEmailGetAsync

public com.squareup.okhttp.Call contactsEmailGetAsync(String email,
                                                      ApiCallback<Contact> callback)
                                               throws ApiException

Load detailed contact information (asynchronously)

Parameters:

email - Proper email address. (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

contactsEmailHistoryGetCall

public com.squareup.okhttp.Call contactsEmailHistoryGetCall(String email,
                                                            Integer limit,
                                                            Integer offset,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for contactsEmailHistoryGet

Parameters:

email - Proper email address. (required)

limit - Maximum of loaded items. (optional, default to 0)

offset - How many items should be loaded ahead. (optional, default to 0)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

contactsEmailHistoryGet

public List<ContactHistory> contactsEmailHistoryGet(String email,
                                                    Integer limit,
                                                    Integer offset)
                                             throws ApiException

Shows detailed history of chosen Contact.

Parameters:

email - Proper email address. (required)

limit - Maximum of loaded items. (optional, default to 0)

offset - How many items should be loaded ahead. (optional, default to 0)

Returns:

List<ContactHistory>

Throws:

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

contactsEmailHistoryGetWithHttpInfo

public ApiResponse<List<ContactHistory>> contactsEmailHistoryGetWithHttpInfo(String email,
                                                                             Integer limit,
                                                                             Integer offset)
                                                                      throws ApiException

Shows detailed history of chosen Contact.

Parameters:

email - Proper email address. (required)

limit - Maximum of loaded items. (optional, default to 0)

offset - How many items should be loaded ahead. (optional, default to 0)

Returns:

ApiResponse<List<ContactHistory>>

Throws:

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

contactsEmailHistoryGetAsync

public com.squareup.okhttp.Call contactsEmailHistoryGetAsync(String email,
                                                             Integer limit,
                                                             Integer offset,
                                                             ApiCallback<List<ContactHistory>> callback)
                                                      throws ApiException

Shows detailed history of chosen Contact. (asynchronously)

Parameters:

email - Proper email address. (required)

limit - Maximum of loaded items. (optional, default to 0)

offset - How many items should be loaded ahead. (optional, default to 0)

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

contactsEmailPutCall

public com.squareup.okhttp.Call contactsEmailPutCall(String email,
                                                     ContactUpdatePayload body,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for contactsEmailPut

Parameters:

email - Proper email address. (required)

body - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

contactsEmailPut

public Contact contactsEmailPut(String email,
                                ContactUpdatePayload body)
                         throws ApiException

Update selected contact. Omitted contact's fields will be reset by default (see the clearRestOfFields parameter)

Parameters:

email - Proper email address. (required)

body - (required)

Returns:

Contact

Throws:

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

contactsEmailPutWithHttpInfo

public ApiResponse<Contact> contactsEmailPutWithHttpInfo(String email,
                                                         ContactUpdatePayload body)
                                                  throws ApiException

Update selected contact. Omitted contact's fields will be reset by default (see the clearRestOfFields parameter)

Parameters:

email - Proper email address. (required)

body - (required)

Returns:

ApiResponse<Contact>

Throws:

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

contactsEmailPutAsync

public com.squareup.okhttp.Call contactsEmailPutAsync(String email,
                                                      ContactUpdatePayload body,
                                                      ApiCallback<Contact> callback)
                                               throws ApiException

Update selected contact. Omitted contact's fields will be reset by default (see the clearRestOfFields parameter) (asynchronously)

Parameters:

email - Proper email address. (required)

body - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

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

contactsGetCall

public com.squareup.okhttp.Call contactsGetCall(String rule,
                                                Integer limit,
                                                Integer offset,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for contactsGet

Parameters:

rule - Query used for filtering. (optional)

limit - Maximum of loaded items. (optional, default to 20)

offset - How many items should be loaded ahead. (optional, default to 0)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

contactsGet

public List<Contact> contactsGet(String rule,
                                 Integer limit,
                                 Integer offset)
                          throws ApiException

List of all contacts. If you have not specified RULE, all Contacts will be listed.

Parameters:

rule - Query used for filtering. (optional)

limit - Maximum of loaded items. (optional, default to 20)

offset - How many items should be loaded ahead. (optional, default to 0)

Returns:

List<Contact>

Throws:

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

contactsGetWithHttpInfo

public ApiResponse<List<Contact>> contactsGetWithHttpInfo(String rule,
                                                          Integer limit,
                                                          Integer offset)
                                                   throws ApiException

List of all contacts. If you have not specified RULE, all Contacts will be listed.

Parameters:

rule - Query used for filtering. (optional)

limit - Maximum of loaded items. (optional, default to 20)

offset - How many items should be loaded ahead. (optional, default to 0)

Returns:

ApiResponse<List<Contact>>

Throws:

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

contactsGetAsync

public com.squareup.okhttp.Call contactsGetAsync(String rule,
                                                 Integer limit,
                                                 Integer offset,
                                                 ApiCallback<List<Contact>> callback)
                                          throws ApiException

List of all contacts. If you have not specified RULE, all Contacts will be listed. (asynchronously)

Parameters:

rule - Query used for filtering. (optional)

limit - Maximum of loaded items. (optional, default to 20)

offset - How many items should be loaded ahead. (optional, default to 0)

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

contactsPostCall

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

Build call for contactsPost

Parameters:

body - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

contactsPost

public List<Contact> contactsPost(QuickAddPayload body)
                           throws ApiException

Add new Contact to one of your Lists.

Parameters:

body - (required)

Returns:

List<Contact>

Throws:

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

contactsPostWithHttpInfo

public ApiResponse<List<Contact>> contactsPostWithHttpInfo(QuickAddPayload body)
                                                    throws ApiException

Add new Contact to one of your Lists.

Parameters:

body - (required)

Returns:

ApiResponse<List<Contact>>

Throws:

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

contactsPostAsync

public com.squareup.okhttp.Call contactsPostAsync(QuickAddPayload body,
                                                  ApiCallback<List<Contact>> callback)
                                           throws ApiException

Add new Contact to one of your Lists. (asynchronously)

Parameters:

body - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

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

contactsStatsGetCall

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

Build call for contactsStatsGet

Parameters:

rule - Query used for filtering. (optional)

listNames - (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

contactsStatsGet

public ContactStats contactsStatsGet(String rule,
                                     List<String> listNames)
                              throws ApiException

Returns number of Contacts, RULE specifies contact Status.

Parameters:

rule - Query used for filtering. (optional)

listNames - (optional)

Returns:

ContactStats

Throws:

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

contactsStatsGetWithHttpInfo

public ApiResponse<ContactStats> contactsStatsGetWithHttpInfo(String rule,
                                                              List<String> listNames)
                                                       throws ApiException

Returns number of Contacts, RULE specifies contact Status.

Parameters:

rule - Query used for filtering. (optional)

listNames - (optional)

Returns:

ApiResponse<ContactStats>

Throws:

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

contactsStatsGetAsync

public com.squareup.okhttp.Call contactsStatsGetAsync(String rule,
                                                      List<String> listNames,
                                                      ApiCallback<ContactStats> callback)
                                               throws ApiException

Returns number of Contacts, RULE specifies contact Status. (asynchronously)

Parameters:

rule - Query used for filtering. (optional)

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

contactsTasksExportGetCall

public com.squareup.okhttp.Call contactsTasksExportGetCall(String fileFormat,
                                                           String rule,
                                                           List<String> emails,
                                                           String compressionFormat,
                                                           String fileName,
                                                           List<String> listNames,
                                                           ProgressResponseBody.ProgressListener progressListener,
                                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                    throws ApiException

Build call for contactsTasksExportGet

Parameters:

fileFormat - Format of the exported file (optional, default to Csv)

rule - Query used for filtering. (optional)

emails - Comma delimited list of contact emails (optional)

compressionFormat - FileResponse compression format. None or Zip. (optional, default to None)

fileName - Name of your file. (optional)

listNames - (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

contactsTasksExportGet

public ExportLink contactsTasksExportGet(String fileFormat,
                                         String rule,
                                         List<String> emails,
                                         String compressionFormat,
                                         String fileName,
                                         List<String> listNames)
                                  throws ApiException

Export selected Contacts to file.

Parameters:

fileFormat - Format of the exported file (optional, default to Csv)

rule - Query used for filtering. (optional)

emails - Comma delimited list of contact emails (optional)

compressionFormat - FileResponse compression format. None or Zip. (optional, default to None)

fileName - Name of your file. (optional)

listNames - (optional)

Returns:

ExportLink

Throws:

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

contactsTasksExportGetWithHttpInfo

public ApiResponse<ExportLink> contactsTasksExportGetWithHttpInfo(String fileFormat,
                                                                  String rule,
                                                                  List<String> emails,
                                                                  String compressionFormat,
                                                                  String fileName,
                                                                  List<String> listNames)
                                                           throws ApiException

Export selected Contacts to file.

Parameters:

fileFormat - Format of the exported file (optional, default to Csv)

rule - Query used for filtering. (optional)

emails - Comma delimited list of contact emails (optional)

compressionFormat - FileResponse compression format. None or Zip. (optional, default to None)

fileName - Name of your file. (optional)

listNames - (optional)

Returns:

ApiResponse<ExportLink>

Throws:

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

contactsTasksExportGetAsync

public com.squareup.okhttp.Call contactsTasksExportGetAsync(String fileFormat,
                                                            String rule,
                                                            List<String> emails,
                                                            String compressionFormat,
                                                            String fileName,
                                                            List<String> listNames,
                                                            ApiCallback<ExportLink> callback)
                                                     throws ApiException

Export selected Contacts to file. (asynchronously)

Parameters:

fileFormat - Format of the exported file (optional, default to Csv)

rule - Query used for filtering. (optional)

emails - Comma delimited list of contact emails (optional)

compressionFormat - FileResponse compression format. None or Zip. (optional, default to None)

fileName - Name of your file. (optional)

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

contactsTasksImportPostCall

public com.squareup.okhttp.Call contactsTasksImportPostCall(File file,
                                                            Boolean allowUnsubscribe,
                                                            String listName,
                                                            String status,
                                                            String consentDate,
                                                            String consentIP,
                                                            String consentTracking,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for contactsTasksImportPost

Parameters:

file - (required)

allowUnsubscribe - True: Allow unsubscribing from this list. Otherwise, false (optional, default to False)

listName - Name of your list. (optional)

status - Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed. (optional, default to Active)

consentDate - Date of consent to send this contact(s) your email. If not provided current date is used for consent. (optional)

consentIP - IP address of consent to send this contact(s) your email. If not provided your current public IP address is used for consent. (optional)

consentTracking - (optional, default to Unknown)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

contactsTasksImportPost

public void contactsTasksImportPost(File file,
                                    Boolean allowUnsubscribe,
                                    String listName,
                                    String status,
                                    String consentDate,
                                    String consentIP,
                                    String consentTracking)
                             throws ApiException

Upload contacts from a file.

Parameters:

file - (required)

allowUnsubscribe - True: Allow unsubscribing from this list. Otherwise, false (optional, default to False)

listName - Name of your list. (optional)

status - Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed. (optional, default to Active)

consentDate - Date of consent to send this contact(s) your email. If not provided current date is used for consent. (optional)

consentIP - IP address of consent to send this contact(s) your email. If not provided your current public IP address is used for consent. (optional)

consentTracking - (optional, default to Unknown)

Throws:

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

contactsTasksImportPostWithHttpInfo

public ApiResponse<Void> contactsTasksImportPostWithHttpInfo(File file,
                                                             Boolean allowUnsubscribe,
                                                             String listName,
                                                             String status,
                                                             String consentDate,
                                                             String consentIP,
                                                             String consentTracking)
                                                      throws ApiException

Upload contacts from a file.

Parameters:

file - (required)

allowUnsubscribe - True: Allow unsubscribing from this list. Otherwise, false (optional, default to False)

listName - Name of your list. (optional)

status - Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed. (optional, default to Active)

consentDate - Date of consent to send this contact(s) your email. If not provided current date is used for consent. (optional)

consentIP - IP address of consent to send this contact(s) your email. If not provided your current public IP address is used for consent. (optional)

consentTracking - (optional, default to Unknown)

Returns:

ApiResponse<Void>

Throws:

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

contactsTasksImportPostAsync

public com.squareup.okhttp.Call contactsTasksImportPostAsync(File file,
                                                             Boolean allowUnsubscribe,
                                                             String listName,
                                                             String status,
                                                             String consentDate,
                                                             String consentIP,
                                                             String consentTracking,
                                                             ApiCallback<Void> callback)
                                                      throws ApiException

Upload contacts from a file. (asynchronously)

Parameters:

file - (required)

allowUnsubscribe - True: Allow unsubscribing from this list. Otherwise, false (optional, default to False)

listName - Name of your list. (optional)

status - Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed. (optional, default to Active)

consentDate - Date of consent to send this contact(s) your email. If not provided current date is used for consent. (optional)

consentIP - IP address of consent to send this contact(s) your email. If not provided your current public IP address is used for consent. (optional)

consentTracking - (optional, default to Unknown)

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