
public final class GroupControllerApi
extends ApiClient

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`GroupControllerApi.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`baseUrl`

Constructor Summary

Constructors
Constructor	Description
`GroupControllerApi(String xApiKey, String basePath)`

Method Summary

Modifier and Type	Method	Description
`final String`	`getBaseUrl()`
`final GroupContactsDto`	`addContactsToGroup(UUID groupId, UpdateGroupContacts updateGroupContactsOption)`	Add contacts to a group
`final RequestConfig`	`addContactsToGroupRequestConfig(UUID groupId, UpdateGroupContacts updateGroupContactsOption)`	To obtain the request config of the operation addContactsToGroup
`final GroupDto`	`createGroup(CreateGroupOptions createGroupOptions)`	Create a group
`final RequestConfig`	`createGroupRequestConfig(CreateGroupOptions createGroupOptions)`	To obtain the request config of the operation createGroup
`final Unit`	`deleteGroup(UUID groupId)`	Delete group
`final RequestConfig`	`deleteGroupRequestConfig(UUID groupId)`	To obtain the request config of the operation deleteGroup
`final PageGroupProjection`	`getAllGroups(Integer page, Integer size, String sort)`	Get all Contact Groups in paginated format
`final RequestConfig`	`getAllGroupsRequestConfig(Integer page, Integer size, String sort)`	To obtain the request config of the operation getAllGroups
`final GroupDto`	`getGroup(UUID groupId)`	Get group
`final RequestConfig`	`getGroupRequestConfig(UUID groupId)`	To obtain the request config of the operation getGroup
`final GroupContactsDto`	`getGroupWithContacts(UUID groupId)`	Get group and contacts belonging to it
`final RequestConfig`	`getGroupWithContactsRequestConfig(UUID groupId)`	To obtain the request config of the operation getGroupWithContacts
`final PageContactProjection`	`getGroupWithContactsPaginated(UUID groupId, Integer page, Integer size, String sort)`	Get group and paginated contacts belonging to it
`final RequestConfig`	`getGroupWithContactsPaginatedRequestConfig(UUID groupId, Integer page, Integer size, String sort)`	To obtain the request config of the operation getGroupWithContactsPaginated
`final List<GroupProjection>`	`getGroups()`	Get all groups
`final RequestConfig`	`getGroupsRequestConfig()`	To obtain the request config of the operation getGroups
`final GroupContactsDto`	`removeContactsFromGroup(UUID groupId, UpdateGroupContacts updateGroupContactsOption)`	Remove contacts from a group
`final RequestConfig`	`removeContactsFromGroupRequestConfig(UUID groupId, UpdateGroupContacts updateGroupContactsOption)`	To obtain the request config of the operation removeContactsFromGroup

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GroupControllerApi
```
GroupControllerApi(String xApiKey, String basePath)
```
- Method Detail
  - getBaseUrl
```
 final String getBaseUrl()
```
  - addContactsToGroup
```
 final GroupContactsDto addContactsToGroup(UUID groupId, UpdateGroupContacts updateGroupContactsOption)
```
    Add contacts to a group
    
    Parameters:
    
    groupId - groupId
    
    updateGroupContactsOption - updateGroupContactsOption
  - addContactsToGroupRequestConfig
```
 final RequestConfig addContactsToGroupRequestConfig(UUID groupId, UpdateGroupContacts updateGroupContactsOption)
```
    To obtain the request config of the operation addContactsToGroup
    
    Parameters:
    
    groupId - groupId
    
    updateGroupContactsOption - updateGroupContactsOption
  - createGroup
```
 final GroupDto createGroup(CreateGroupOptions createGroupOptions)
```
    Create a group
    
    Parameters:
    
    createGroupOptions - createGroupOptions
  - createGroupRequestConfig
```
 final RequestConfig createGroupRequestConfig(CreateGroupOptions createGroupOptions)
```
    To obtain the request config of the operation createGroup
    
    Parameters:
    
    createGroupOptions - createGroupOptions
  - deleteGroup
```
 final Unit deleteGroup(UUID groupId)
```
    Delete group
    
    Parameters:
    
    groupId - groupId
  - deleteGroupRequestConfig
```
 final RequestConfig deleteGroupRequestConfig(UUID groupId)
```
    To obtain the request config of the operation deleteGroup
    
    Parameters:
    
    groupId - groupId
  - getAllGroups
```
 final PageGroupProjection getAllGroups(Integer page, Integer size, String sort)
```
    Get all Contact Groups in paginated format
    
    Parameters:
    
    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)
  - getAllGroupsRequestConfig
```
 final RequestConfig getAllGroupsRequestConfig(Integer page, Integer size, String sort)
```
    To obtain the request config of the operation getAllGroups
    
    Parameters:
    
    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)
  - getGroup
```
 final GroupDto getGroup(UUID groupId)
```
    Get group
    
    Parameters:
    
    groupId - groupId
  - getGroupRequestConfig
```
 final RequestConfig getGroupRequestConfig(UUID groupId)
```
    To obtain the request config of the operation getGroup
    
    Parameters:
    
    groupId - groupId
  - getGroupWithContacts
```
 final GroupContactsDto getGroupWithContacts(UUID groupId)
```
    Get group and contacts belonging to it
    
    Parameters:
    
    groupId - groupId
  - getGroupWithContactsRequestConfig
```
 final RequestConfig getGroupWithContactsRequestConfig(UUID groupId)
```
    To obtain the request config of the operation getGroupWithContacts
    
    Parameters:
    
    groupId - groupId
  - getGroupWithContactsPaginated
```
 final PageContactProjection getGroupWithContactsPaginated(UUID groupId, Integer page, Integer size, String sort)
```
    Get group and paginated contacts belonging to it
    
    Parameters:
    
    groupId - groupId
    
    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)
  - getGroupWithContactsPaginatedRequestConfig
```
 final RequestConfig getGroupWithContactsPaginatedRequestConfig(UUID groupId, Integer page, Integer size, String sort)
```
    To obtain the request config of the operation getGroupWithContactsPaginated
    
    Parameters:
    
    groupId - groupId
    
    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)
  - getGroups
```
 final List<GroupProjection> getGroups()
```
    Get all groups
  - getGroupsRequestConfig
```
 final RequestConfig getGroupsRequestConfig()
```
    To obtain the request config of the operation getGroups
  - removeContactsFromGroup
```
 final GroupContactsDto removeContactsFromGroup(UUID groupId, UpdateGroupContacts updateGroupContactsOption)
```
    Remove contacts from a group
    
    Parameters:
    
    groupId - groupId
    
    updateGroupContactsOption - updateGroupContactsOption
  - removeContactsFromGroupRequestConfig
```
 final RequestConfig removeContactsFromGroupRequestConfig(UUID groupId, UpdateGroupContacts updateGroupContactsOption)
```
    To obtain the request config of the operation removeContactsFromGroup
    
    Parameters:
    
    groupId - groupId
    
    updateGroupContactsOption - updateGroupContactsOption

Class GroupControllerApi

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GroupControllerApi

Method Detail

getBaseUrl

addContactsToGroup

addContactsToGroupRequestConfig

createGroup

createGroupRequestConfig

deleteGroup

deleteGroupRequestConfig

getAllGroups

getAllGroupsRequestConfig

getGroup

getGroupRequestConfig

getGroupWithContacts

getGroupWithContactsRequestConfig

getGroupWithContactsPaginated

getGroupWithContactsPaginatedRequestConfig

getGroups

getGroupsRequestConfig

removeContactsFromGroup

removeContactsFromGroupRequestConfig