Package com.boldsign.api

Class GroupContactsApi

java.lang.Object

com.boldsign.api.GroupContactsApi

public class GroupContactsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
GroupContactsApi()
GroupContactsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
CreateGroupContactResponse	createGroupContact(GroupContactDetails groupContactDetails)	Create a new Group Contact.
okhttp3.Call	createGroupContactAsync(GroupContactDetails groupContactDetails, ApiCallback<CreateGroupContactResponse> _callback)	Create a new Group Contact.
okhttp3.Call	createGroupContactCall(GroupContactDetails groupContactDetails, ApiCallback _callback)	Build call for createGroupContact
ApiResponse<CreateGroupContactResponse>	createGroupContactWithHttpInfo(GroupContactDetails groupContactDetails)	Create a new Group Contact.
void	deleteGroupContact(String groupId)	Deletes a Group Contact.
okhttp3.Call	deleteGroupContactAsync(String groupId, ApiCallback<Void> _callback)	Deletes a Group Contact.
okhttp3.Call	deleteGroupContactCall(String groupId, ApiCallback _callback)	Build call for deleteGroupContact
ApiResponse<Void>	deleteGroupContactWithHttpInfo(String groupId)	Deletes a Group Contact.
ApiClient	getApiClient()
String	getCustomBaseUrl()
GetGroupContactDetails	getGroupContact(String groupId)	Get Summary of the Group Contact.
okhttp3.Call	getGroupContactAsync(String groupId, ApiCallback<GetGroupContactDetails> _callback)	Get Summary of the Group Contact.
okhttp3.Call	getGroupContactCall(String groupId, ApiCallback _callback)	Build call for getGroupContact
ApiResponse<GetGroupContactDetails>	getGroupContactWithHttpInfo(String groupId)	Get Summary of the Group Contact.
int	getHostIndex()
GroupContactsList	groupContactList(Integer page, Integer pageSize, String searchKey, String contactType, List<String> directories)	List Group Contacts.
okhttp3.Call	groupContactListAsync(Integer page, Integer pageSize, String searchKey, String contactType, List<String> directories, ApiCallback<GroupContactsList> _callback)	List Group Contacts.
okhttp3.Call	groupContactListCall(Integer page, Integer pageSize, String searchKey, String contactType, List<String> directories, ApiCallback _callback)	Build call for groupContactList
ApiResponse<GroupContactsList>	groupContactListWithHttpInfo(Integer page, Integer pageSize, String searchKey, String contactType, List<String> directories)	List Group Contacts.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
void	updateGroupContact(String groupId, UpdateGroupContact updateGroupContact)	Update the Group Contact.
okhttp3.Call	updateGroupContactAsync(String groupId, UpdateGroupContact updateGroupContact, ApiCallback<Void> _callback)	Update the Group Contact.
okhttp3.Call	updateGroupContactCall(String groupId, UpdateGroupContact updateGroupContact, ApiCallback _callback)	Build call for updateGroupContact
ApiResponse<Void>	updateGroupContactWithHttpInfo(String groupId, UpdateGroupContact updateGroupContact)	Update the Group Contact.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupContactsApi

public GroupContactsApi()

GroupContactsApi

public GroupContactsApi(ApiClient apiClient)

Method Detail

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)

createGroupContactCall

public okhttp3.Call createGroupContactCall(GroupContactDetails groupContactDetails,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for createGroupContact

Parameters:

groupContactDetails - The group 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	-

createGroupContact

public CreateGroupContactResponse createGroupContact(GroupContactDetails groupContactDetails)
                                              throws ApiException

Create a new Group Contact.

Parameters:

groupContactDetails - The group contact details. (optional)

Returns:

CreateGroupContactResponse

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	-

createGroupContactWithHttpInfo

public ApiResponse<CreateGroupContactResponse> createGroupContactWithHttpInfo(GroupContactDetails groupContactDetails)
                                                                       throws ApiException

Create a new Group Contact.

Parameters:

groupContactDetails - The group contact details. (optional)

Returns:

ApiResponse<CreateGroupContactResponse>

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	-

createGroupContactAsync

public okhttp3.Call createGroupContactAsync(GroupContactDetails groupContactDetails,
                                            ApiCallback<CreateGroupContactResponse> _callback)
                                     throws ApiException

Create a new Group Contact. (asynchronously)

Parameters:

groupContactDetails - The group 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	-

deleteGroupContactCall

public okhttp3.Call deleteGroupContactCall(String groupId,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for deleteGroupContact

Parameters:

groupId - The group 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	-

deleteGroupContact

public void deleteGroupContact(String groupId)
                        throws ApiException

Deletes a Group Contact.

Parameters:

groupId - The group 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	-

deleteGroupContactWithHttpInfo

public ApiResponse<Void> deleteGroupContactWithHttpInfo(String groupId)
                                                 throws ApiException

Deletes a Group Contact.

Parameters:

groupId - The group 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	-

deleteGroupContactAsync

public okhttp3.Call deleteGroupContactAsync(String groupId,
                                            ApiCallback<Void> _callback)
                                     throws ApiException

Deletes a Group Contact. (asynchronously)

Parameters:

groupId - The group 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	-

getGroupContactCall

public okhttp3.Call getGroupContactCall(String groupId,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for getGroupContact

Parameters:

groupId - Group 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	-

getGroupContact

public GetGroupContactDetails getGroupContact(String groupId)
                                       throws ApiException

Get Summary of the Group Contact.

Parameters:

groupId - Group Contact Id. (required)

Returns:

GetGroupContactDetails

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	-

getGroupContactWithHttpInfo

public ApiResponse<GetGroupContactDetails> getGroupContactWithHttpInfo(String groupId)
                                                                throws ApiException

Get Summary of the Group Contact.

Parameters:

groupId - Group Contact Id. (required)

Returns:

ApiResponse<GetGroupContactDetails>

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	-

getGroupContactAsync

public okhttp3.Call getGroupContactAsync(String groupId,
                                         ApiCallback<GetGroupContactDetails> _callback)
                                  throws ApiException

Get Summary of the Group Contact. (asynchronously)

Parameters:

groupId - Group 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	-

groupContactListCall

public okhttp3.Call groupContactListCall(Integer page,
                                         Integer pageSize,
                                         String searchKey,
                                         String contactType,
                                         List<String> directories,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for groupContactList

Parameters:

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

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

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

contactType - Group Contact type whether the contact is my contacts or all contacts. Default value is AllContacts. (optional)

directories - Group Contacts can be listed by the search based on the directories (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	-

groupContactList

public GroupContactsList groupContactList(Integer page,
                                          Integer pageSize,
                                          String searchKey,
                                          String contactType,
                                          List<String> directories)
                                   throws ApiException

List Group Contacts.

Parameters:

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

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

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

contactType - Group Contact type whether the contact is my contacts or all contacts. Default value is AllContacts. (optional)

directories - Group Contacts can be listed by the search based on the directories (optional)

Returns:

GroupContactsList

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	-

groupContactListWithHttpInfo

public ApiResponse<GroupContactsList> groupContactListWithHttpInfo(Integer page,
                                                                   Integer pageSize,
                                                                   String searchKey,
                                                                   String contactType,
                                                                   List<String> directories)
                                                            throws ApiException

List Group Contacts.

Parameters:

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

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

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

contactType - Group Contact type whether the contact is my contacts or all contacts. Default value is AllContacts. (optional)

directories - Group Contacts can be listed by the search based on the directories (optional)

Returns:

ApiResponse<GroupContactsList>

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	-

groupContactListAsync

public okhttp3.Call groupContactListAsync(Integer page,
                                          Integer pageSize,
                                          String searchKey,
                                          String contactType,
                                          List<String> directories,
                                          ApiCallback<GroupContactsList> _callback)
                                   throws ApiException

List Group Contacts. (asynchronously)

Parameters:

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

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

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

contactType - Group Contact type whether the contact is my contacts or all contacts. Default value is AllContacts. (optional)

directories - Group Contacts can be listed by the search based on the directories (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	-

updateGroupContactCall

public okhttp3.Call updateGroupContactCall(String groupId,
                                           UpdateGroupContact updateGroupContact,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for updateGroupContact

Parameters:

groupId - The group contact ID. (required)

updateGroupContact - The group contact details. (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	-
400	Bad Request	-

updateGroupContact

public void updateGroupContact(String groupId,
                               UpdateGroupContact updateGroupContact)
                        throws ApiException

Update the Group Contact.

Parameters:

groupId - The group contact ID. (required)

updateGroupContact - The group contact details. (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
200	OK	-
401	Unauthorized	-
400	Bad Request	-

updateGroupContactWithHttpInfo

public ApiResponse<Void> updateGroupContactWithHttpInfo(String groupId,
                                                        UpdateGroupContact updateGroupContact)
                                                 throws ApiException

Update the Group Contact.

Parameters:

groupId - The group contact ID. (required)

updateGroupContact - The group contact details. (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
200	OK	-
401	Unauthorized	-
400	Bad Request	-

updateGroupContactAsync

public okhttp3.Call updateGroupContactAsync(String groupId,
                                            UpdateGroupContact updateGroupContact,
                                            ApiCallback<Void> _callback)
                                     throws ApiException

Update the Group Contact. (asynchronously)

Parameters:

groupId - The group contact ID. (required)

updateGroupContact - The group contact details. (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	-
400	Bad Request	-