Class ContactsApi

java.lang.Object

com.boldsign.api.ContactsApi

public class ContactsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ContactsApi()
ContactsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ContactsList	contactUserList(Integer page, Integer pageSize, String searchKey, String contactType)	List Contact document.
okhttp3.Call	contactUserListAsync(Integer page, Integer pageSize, String searchKey, String contactType, ApiCallback<ContactsList> _callback)	List Contact document.
okhttp3.Call	contactUserListCall(Integer page, Integer pageSize, String searchKey, String contactType, ApiCallback _callback)	Build call for contactUserList
ApiResponse<ContactsList>	contactUserListWithHttpInfo(Integer page, Integer pageSize, String searchKey, String contactType)	List Contact document.
CreateContactResponse	createContact(List<ContactDetails> contactDetails)	Create the new Contact.
okhttp3.Call	createContactAsync(List<ContactDetails> contactDetails, ApiCallback<CreateContactResponse> _callback)	Create the new Contact.
okhttp3.Call	createContactCall(List<ContactDetails> contactDetails, ApiCallback _callback)	Build call for createContact
ApiResponse<CreateContactResponse>	createContactWithHttpInfo(List<ContactDetails> contactDetails)	Create the new Contact.
void	deleteContacts(String id)	Deletes a contact.
okhttp3.Call	deleteContactsAsync(String id, ApiCallback<Void> _callback)	Deletes a contact.
okhttp3.Call	deleteContactsCall(String id, ApiCallback _callback)	Build call for deleteContacts
ApiResponse<Void>	deleteContactsWithHttpInfo(String id)	Deletes a contact.
ApiClient	getApiClient()
ContactsDetails	getContact(String id)	Get summary of the contact.
okhttp3.Call	getContactAsync(String id, ApiCallback<ContactsDetails> _callback)	Get summary of the contact.
okhttp3.Call	getContactCall(String id, ApiCallback _callback)	Build call for getContact
ApiResponse<ContactsDetails>	getContactWithHttpInfo(String id)	Get summary of the contact.
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
void	updateContact(String id, ContactDetails contactDetails)	Update the contact.
okhttp3.Call	updateContactAsync(String id, ContactDetails contactDetails, ApiCallback<Void> _callback)	Update the contact.
okhttp3.Call	updateContactCall(String id, ContactDetails contactDetails, ApiCallback _callback)	Build call for updateContact
ApiResponse<Void>	updateContactWithHttpInfo(String id, ContactDetails contactDetails)	Update the contact.

Methods inherited from class java.lang.Object

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

Constructor Details

ContactsApi

public ContactsApi()

ContactsApi

public ContactsApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

contactUserListCall

public okhttp3.Call contactUserListCall(Integer page,
 Integer pageSize,
 String searchKey,
 String contactType,
 ApiCallback _callback)
                                 throws ApiException

Build call for contactUserList

Parameters:

page - Page index specified in get user contact list request. Default value is 1. (required)

pageSize - Page size specified in get user contact list request. Default value is 10. (optional, default to 10)

searchKey - Contacts can be listed by the search based on the Name or Email (optional)

contactType - Contact type whether the contact is My Contacts or All Contacts. Default value is AllContacts. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
400	Bad Request	-

contactUserList

public ContactsList contactUserList(Integer page,
 Integer pageSize,
 String searchKey,
 String contactType)
                             throws ApiException

List Contact document.

Parameters:

page - Page index specified in get user contact list request. Default value is 1. (required)

pageSize - Page size specified in get user contact list request. Default value is 10. (optional, default to 10)

searchKey - Contacts can be listed by the search based on the Name or Email (optional)

contactType - Contact type whether the contact is My Contacts or All Contacts. Default value is AllContacts. (optional)

Returns:

ContactsList

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
400	Bad Request	-

contactUserListWithHttpInfo

public ApiResponse<ContactsList> contactUserListWithHttpInfo(Integer page,
 Integer pageSize,
 String searchKey,
 String contactType)
                                                      throws ApiException

List Contact document.

Parameters:

page - Page index specified in get user contact list request. Default value is 1. (required)

pageSize - Page size specified in get user contact list request. Default value is 10. (optional, default to 10)

searchKey - Contacts can be listed by the search based on the Name or Email (optional)

contactType - Contact type whether the contact is My Contacts or All Contacts. Default value is AllContacts. (optional)

Returns:

ApiResponse<ContactsList>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
400	Bad Request	-

contactUserListAsync

public okhttp3.Call contactUserListAsync(Integer page,
 Integer pageSize,
 String searchKey,
 String contactType,
 ApiCallback<ContactsList> _callback)
                                  throws ApiException

List Contact document. (asynchronously)

Parameters:

page - Page index specified in get user contact list request. Default value is 1. (required)

pageSize - Page size specified in get user contact list request. Default value is 10. (optional, default to 10)

searchKey - Contacts can be listed by the search based on the Name or Email (optional)

contactType - Contact type whether the contact is My Contacts or All Contacts. Default value is AllContacts. (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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
400	Bad Request	-

createContactCall

public okhttp3.Call createContactCall(List<ContactDetails> contactDetails,
 ApiCallback _callback)
                               throws ApiException

Build call for createContact

Parameters:

contactDetails - The contact details. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
400	Bad Request	-

createContact

public CreateContactResponse createContact(List<ContactDetails> contactDetails)
                                    throws ApiException

Create the new Contact.

Parameters:

contactDetails - The contact details. (optional)

Returns:

CreateContactResponse

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
400	Bad Request	-

createContactWithHttpInfo

public ApiResponse<CreateContactResponse> createContactWithHttpInfo(List<ContactDetails> contactDetails)
                                                             throws ApiException

Create the new Contact.

Parameters:

contactDetails - The contact details. (optional)

Returns:

ApiResponse<CreateContactResponse>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
400	Bad Request	-

createContactAsync

public okhttp3.Call createContactAsync(List<ContactDetails> contactDetails,
 ApiCallback<CreateContactResponse> _callback)
                                throws ApiException

Create the new Contact. (asynchronously)

Parameters:

contactDetails - The contact details. (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

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
400	Bad Request	-

deleteContactsCall

public okhttp3.Call deleteContactsCall(String id,
 ApiCallback _callback)
                                throws ApiException

Build call for deleteContacts

Parameters:

id - The contact id. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

deleteContacts

public void deleteContacts(String id)
                    throws ApiException

Deletes a contact.

Parameters:

id - The contact id. (required)

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

deleteContactsWithHttpInfo

public ApiResponse<Void> deleteContactsWithHttpInfo(String id)
                                             throws ApiException

Deletes a contact.

Parameters:

id - The contact id. (required)

Returns:

ApiResponse<Void>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

deleteContactsAsync

public okhttp3.Call deleteContactsAsync(String id,
 ApiCallback<Void> _callback)
                                 throws ApiException

Deletes a contact. (asynchronously)

Parameters:

id - The contact id. (required)

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

Returns:

The request call

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

getContactCall

public okhttp3.Call getContactCall(String id,
 ApiCallback _callback)
                            throws ApiException

Build call for getContact

Parameters:

id - Contact Id. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

getContact

public ContactsDetails getContact(String id)
                           throws ApiException

Get summary of the contact.

Parameters:

id - Contact Id. (required)

Returns:

ContactsDetails

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

getContactWithHttpInfo

public ApiResponse<ContactsDetails> getContactWithHttpInfo(String id)
                                                    throws ApiException

Get summary of the contact.

Parameters:

id - Contact Id. (required)

Returns:

ApiResponse<ContactsDetails>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

getContactAsync

public okhttp3.Call getContactAsync(String id,
 ApiCallback<ContactsDetails> _callback)
                             throws ApiException

Get summary of the contact. (asynchronously)

Parameters:

id - Contact Id. (required)

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

Returns:

The request call

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

updateContactCall

public okhttp3.Call updateContactCall(String id,
 ContactDetails contactDetails,
 ApiCallback _callback)
                               throws ApiException

Build call for updateContact

Parameters:

id - The contactId. (optional)

contactDetails - The contact details. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
400	Bad Request	-

updateContact

public void updateContact(String id,
 ContactDetails contactDetails)
                   throws ApiException

Update the contact.

Parameters:

id - The contactId. (optional)

contactDetails - The contact details. (optional)

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
400	Bad Request	-

updateContactWithHttpInfo

public ApiResponse<Void> updateContactWithHttpInfo(String id,
 ContactDetails contactDetails)
                                            throws ApiException

Update the contact.

Parameters:

id - The contactId. (optional)

contactDetails - The contact details. (optional)

Returns:

ApiResponse<Void>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
400	Bad Request	-

updateContactAsync

public okhttp3.Call updateContactAsync(String id,
 ContactDetails contactDetails,
 ApiCallback<Void> _callback)
                                throws ApiException

Update the contact. (asynchronously)

Parameters:

id - The contactId. (optional)

contactDetails - The contact details. (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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
400	Bad Request	-