public class GroupControllerApi extends Object
| Constructor and Description |
|---|
GroupControllerApi() |
GroupControllerApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
GroupContactsDto |
addContactsToGroup(UUID groupId,
UpdateGroupContacts updateGroupContactsOption)
Add contacts to a group
|
okhttp3.Call |
addContactsToGroupAsync(UUID groupId,
UpdateGroupContacts updateGroupContactsOption,
ApiCallback<GroupContactsDto> _callback)
Add contacts to a group (asynchronously)
|
okhttp3.Call |
addContactsToGroupCall(UUID groupId,
UpdateGroupContacts updateGroupContactsOption,
ApiCallback _callback)
Build call for addContactsToGroup
|
ApiResponse<GroupContactsDto> |
addContactsToGroupWithHttpInfo(UUID groupId,
UpdateGroupContacts updateGroupContactsOption)
Add contacts to a group
|
GroupDto |
createGroup(CreateGroupOptions createGroupOptions)
Create a group
|
okhttp3.Call |
createGroupAsync(CreateGroupOptions createGroupOptions,
ApiCallback<GroupDto> _callback)
Create a group (asynchronously)
|
okhttp3.Call |
createGroupCall(CreateGroupOptions createGroupOptions,
ApiCallback _callback)
Build call for createGroup
|
ApiResponse<GroupDto> |
createGroupWithHttpInfo(CreateGroupOptions createGroupOptions)
Create a group
|
void |
deleteGroup(UUID groupId)
Delete group
|
okhttp3.Call |
deleteGroupAsync(UUID groupId,
ApiCallback<Void> _callback)
Delete group (asynchronously)
|
okhttp3.Call |
deleteGroupCall(UUID groupId,
ApiCallback _callback)
Build call for deleteGroup
|
ApiResponse<Void> |
deleteGroupWithHttpInfo(UUID groupId)
Delete group
|
PageGroupProjection |
getAllGroups(Integer page,
Integer size,
String sort)
Get all Contact Groups in paginated format
|
okhttp3.Call |
getAllGroupsAsync(Integer page,
Integer size,
String sort,
ApiCallback<PageGroupProjection> _callback)
Get all Contact Groups in paginated format (asynchronously)
|
okhttp3.Call |
getAllGroupsCall(Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getAllGroups
|
ApiResponse<PageGroupProjection> |
getAllGroupsWithHttpInfo(Integer page,
Integer size,
String sort)
Get all Contact Groups in paginated format
|
ApiClient |
getApiClient() |
GroupDto |
getGroup(UUID groupId)
Get group
|
okhttp3.Call |
getGroupAsync(UUID groupId,
ApiCallback<GroupDto> _callback)
Get group (asynchronously)
|
okhttp3.Call |
getGroupCall(UUID groupId,
ApiCallback _callback)
Build call for getGroup
|
List<GroupProjection> |
getGroups()
Get all groups
|
okhttp3.Call |
getGroupsAsync(ApiCallback<List<GroupProjection>> _callback)
Get all groups (asynchronously)
|
okhttp3.Call |
getGroupsCall(ApiCallback _callback)
Build call for getGroups
|
ApiResponse<List<GroupProjection>> |
getGroupsWithHttpInfo()
Get all groups
|
GroupContactsDto |
getGroupWithContacts(UUID groupId)
Get group and contacts belonging to it
|
okhttp3.Call |
getGroupWithContactsAsync(UUID groupId,
ApiCallback<GroupContactsDto> _callback)
Get group and contacts belonging to it (asynchronously)
|
okhttp3.Call |
getGroupWithContactsCall(UUID groupId,
ApiCallback _callback)
Build call for getGroupWithContacts
|
PageContactProjection |
getGroupWithContactsPaginated(UUID groupId,
Integer page,
Integer size,
String sort)
Get group and paginated contacts belonging to it
|
okhttp3.Call |
getGroupWithContactsPaginatedAsync(UUID groupId,
Integer page,
Integer size,
String sort,
ApiCallback<PageContactProjection> _callback)
Get group and paginated contacts belonging to it (asynchronously)
|
okhttp3.Call |
getGroupWithContactsPaginatedCall(UUID groupId,
Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getGroupWithContactsPaginated
|
ApiResponse<PageContactProjection> |
getGroupWithContactsPaginatedWithHttpInfo(UUID groupId,
Integer page,
Integer size,
String sort)
Get group and paginated contacts belonging to it
|
ApiResponse<GroupContactsDto> |
getGroupWithContactsWithHttpInfo(UUID groupId)
Get group and contacts belonging to it
|
ApiResponse<GroupDto> |
getGroupWithHttpInfo(UUID groupId)
Get group
|
GroupContactsDto |
removeContactsFromGroup(UUID groupId,
UpdateGroupContacts updateGroupContactsOption)
Remove contacts from a group
|
okhttp3.Call |
removeContactsFromGroupAsync(UUID groupId,
UpdateGroupContacts updateGroupContactsOption,
ApiCallback<GroupContactsDto> _callback)
Remove contacts from a group (asynchronously)
|
okhttp3.Call |
removeContactsFromGroupCall(UUID groupId,
UpdateGroupContacts updateGroupContactsOption,
ApiCallback _callback)
Build call for removeContactsFromGroup
|
ApiResponse<GroupContactsDto> |
removeContactsFromGroupWithHttpInfo(UUID groupId,
UpdateGroupContacts updateGroupContactsOption)
Remove contacts from a group
|
void |
setApiClient(ApiClient apiClient) |
public GroupControllerApi()
public GroupControllerApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public okhttp3.Call addContactsToGroupCall(UUID groupId, UpdateGroupContacts updateGroupContactsOption, ApiCallback _callback) throws ApiException
groupId - groupId (required)updateGroupContactsOption - updateGroupContactsOption (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public GroupContactsDto addContactsToGroup(UUID groupId, UpdateGroupContacts updateGroupContactsOption) throws ApiException
groupId - groupId (required)updateGroupContactsOption - updateGroupContactsOption (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<GroupContactsDto> addContactsToGroupWithHttpInfo(UUID groupId, UpdateGroupContacts updateGroupContactsOption) throws ApiException
groupId - groupId (required)updateGroupContactsOption - updateGroupContactsOption (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call addContactsToGroupAsync(UUID groupId, UpdateGroupContacts updateGroupContactsOption, ApiCallback<GroupContactsDto> _callback) throws ApiException
groupId - groupId (required)updateGroupContactsOption - updateGroupContactsOption (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call createGroupCall(CreateGroupOptions createGroupOptions, ApiCallback _callback) throws ApiException
createGroupOptions - createGroupOptions (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public GroupDto createGroup(CreateGroupOptions createGroupOptions) throws ApiException
createGroupOptions - createGroupOptions (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<GroupDto> createGroupWithHttpInfo(CreateGroupOptions createGroupOptions) throws ApiException
createGroupOptions - createGroupOptions (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call createGroupAsync(CreateGroupOptions createGroupOptions, ApiCallback<GroupDto> _callback) throws ApiException
createGroupOptions - createGroupOptions (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call deleteGroupCall(UUID groupId, ApiCallback _callback) throws ApiException
groupId - groupId (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public void deleteGroup(UUID groupId) throws ApiException
groupId - groupId (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public ApiResponse<Void> deleteGroupWithHttpInfo(UUID groupId) throws ApiException
groupId - groupId (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public okhttp3.Call deleteGroupAsync(UUID groupId, ApiCallback<Void> _callback) throws ApiException
groupId - groupId (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public okhttp3.Call getAllGroupsCall(Integer page, Integer size, String sort, ApiCallback _callback) throws ApiException
page - Optional page index in inbox list pagination (optional, default to 0)size - Optional page size in inbox list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public PageGroupProjection getAllGroups(Integer page, Integer size, String sort) throws ApiException
page - Optional page index in inbox list pagination (optional, default to 0)size - Optional page size in inbox list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<PageGroupProjection> getAllGroupsWithHttpInfo(Integer page, Integer size, String sort) throws ApiException
page - Optional page index in inbox list pagination (optional, default to 0)size - Optional page size in inbox list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getAllGroupsAsync(Integer page, Integer size, String sort, ApiCallback<PageGroupProjection> _callback) throws ApiException
page - Optional page index in inbox list pagination (optional, default to 0)size - Optional page size in inbox list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getGroupCall(UUID groupId, ApiCallback _callback) throws ApiException
groupId - groupId (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public GroupDto getGroup(UUID groupId) throws ApiException
groupId - groupId (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<GroupDto> getGroupWithHttpInfo(UUID groupId) throws ApiException
groupId - groupId (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getGroupAsync(UUID groupId, ApiCallback<GroupDto> _callback) throws ApiException
groupId - groupId (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getGroupWithContactsCall(UUID groupId, ApiCallback _callback) throws ApiException
groupId - groupId (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public GroupContactsDto getGroupWithContacts(UUID groupId) throws ApiException
groupId - groupId (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<GroupContactsDto> getGroupWithContactsWithHttpInfo(UUID groupId) throws ApiException
groupId - groupId (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getGroupWithContactsAsync(UUID groupId, ApiCallback<GroupContactsDto> _callback) throws ApiException
groupId - groupId (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getGroupWithContactsPaginatedCall(UUID groupId, Integer page, Integer size, String sort, ApiCallback _callback) throws ApiException
groupId - groupId (required)page - Optional page index in group contact pagination (optional, default to 0)size - Optional page size in group contact pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public PageContactProjection getGroupWithContactsPaginated(UUID groupId, Integer page, Integer size, String sort) throws ApiException
groupId - groupId (required)page - Optional page index in group contact pagination (optional, default to 0)size - Optional page size in group contact pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<PageContactProjection> getGroupWithContactsPaginatedWithHttpInfo(UUID groupId, Integer page, Integer size, String sort) throws ApiException
groupId - groupId (required)page - Optional page index in group contact pagination (optional, default to 0)size - Optional page size in group contact pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getGroupWithContactsPaginatedAsync(UUID groupId, Integer page, Integer size, String sort, ApiCallback<PageContactProjection> _callback) throws ApiException
groupId - groupId (required)page - Optional page index in group contact pagination (optional, default to 0)size - Optional page size in group contact pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getGroupsCall(ApiCallback _callback) throws ApiException
_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public List<GroupProjection> getGroups() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<List<GroupProjection>> getGroupsWithHttpInfo() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getGroupsAsync(ApiCallback<List<GroupProjection>> _callback) throws ApiException
_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call removeContactsFromGroupCall(UUID groupId, UpdateGroupContacts updateGroupContactsOption, ApiCallback _callback) throws ApiException
groupId - groupId (required)updateGroupContactsOption - updateGroupContactsOption (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public GroupContactsDto removeContactsFromGroup(UUID groupId, UpdateGroupContacts updateGroupContactsOption) throws ApiException
groupId - groupId (required)updateGroupContactsOption - updateGroupContactsOption (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public ApiResponse<GroupContactsDto> removeContactsFromGroupWithHttpInfo(UUID groupId, UpdateGroupContacts updateGroupContactsOption) throws ApiException
groupId - groupId (required)updateGroupContactsOption - updateGroupContactsOption (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public okhttp3.Call removeContactsFromGroupAsync(UUID groupId, UpdateGroupContacts updateGroupContactsOption, ApiCallback<GroupContactsDto> _callback) throws ApiException
groupId - groupId (required)updateGroupContactsOption - updateGroupContactsOption (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
Copyright © 2021. All rights reserved.