-
public final class GroupControllerApi extends ApiClient
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classGroupControllerApi.Companion
-
Constructor Summary
Constructors Constructor Description GroupControllerApi(String xApiKey, String basePath)
-
Method Summary
Modifier and Type Method Description final StringgetBaseUrl()final GroupContactsDtoaddContactsToGroup(UUID groupId, UpdateGroupContacts updateGroupContacts)Add contacts to a group final RequestConfigaddContactsToGroupRequestConfig(UUID groupId, UpdateGroupContacts updateGroupContacts)To obtain the request config of the operation addContactsToGroup final GroupDtocreateGroup(CreateGroupOptions createGroupOptions)Create a group final RequestConfigcreateGroupRequestConfig(CreateGroupOptions createGroupOptions)To obtain the request config of the operation createGroup final UnitdeleteGroup(UUID groupId)Delete group final RequestConfigdeleteGroupRequestConfig(UUID groupId)To obtain the request config of the operation deleteGroup final PageGroupProjectiongetAllGroups(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)Get all Contact Groups in paginated format final RequestConfiggetAllGroupsRequestConfig(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)To obtain the request config of the operation getAllGroups final GroupDtogetGroup(UUID groupId)Get group final RequestConfiggetGroupRequestConfig(UUID groupId)To obtain the request config of the operation getGroup final GroupContactsDtogetGroupWithContacts(UUID groupId)Get group and contacts belonging to it final RequestConfiggetGroupWithContactsRequestConfig(UUID groupId)To obtain the request config of the operation getGroupWithContacts final PageContactProjectiongetGroupWithContactsPaginated(UUID groupId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)Get group and paginated contacts belonging to it final RequestConfiggetGroupWithContactsPaginatedRequestConfig(UUID groupId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)To obtain the request config of the operation getGroupWithContactsPaginated final List<GroupProjection>getGroups()Get all groups final RequestConfiggetGroupsRequestConfig()To obtain the request config of the operation getGroups final GroupContactsDtoremoveContactsFromGroup(UUID groupId, UpdateGroupContacts updateGroupContacts)Remove contacts from a group final RequestConfigremoveContactsFromGroupRequestConfig(UUID groupId, UpdateGroupContacts updateGroupContacts)To obtain the request config of the operation removeContactsFromGroup -
-
Method Detail
-
getBaseUrl
final String getBaseUrl()
-
addContactsToGroup
final GroupContactsDto addContactsToGroup(UUID groupId, UpdateGroupContacts updateGroupContacts)
Add contacts to a group
-
addContactsToGroupRequestConfig
final RequestConfig addContactsToGroupRequestConfig(UUID groupId, UpdateGroupContacts updateGroupContacts)
To obtain the request config of the operation addContactsToGroup
-
createGroup
final GroupDto createGroup(CreateGroupOptions createGroupOptions)
Create a group
-
createGroupRequestConfig
final RequestConfig createGroupRequestConfig(CreateGroupOptions createGroupOptions)
To obtain the request config of the operation createGroup
-
deleteGroup
final Unit deleteGroup(UUID groupId)
Delete group
-
deleteGroupRequestConfig
final RequestConfig deleteGroupRequestConfig(UUID groupId)
To obtain the request config of the operation deleteGroup
-
getAllGroups
final PageGroupProjection getAllGroups(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)
Get all Contact Groups in paginated format
- Parameters:
page- Optional page index in list pagination (optional, default to 0)size- Optional page size in list pagination (optional, default to 20)sort- Optional createdAt sort direction ASC or DESC (optional, default to ASC)since- Filter by created at after the given timestamp (optional)before- Filter by created at before the given timestamp (optional)
-
getAllGroupsRequestConfig
final RequestConfig getAllGroupsRequestConfig(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)
To obtain the request config of the operation getAllGroups
- Parameters:
page- Optional page index in list pagination (optional, default to 0)size- Optional page size in list pagination (optional, default to 20)sort- Optional createdAt sort direction ASC or DESC (optional, default to ASC)since- Filter by created at after the given timestamp (optional)before- Filter by created at before the given timestamp (optional)
-
getGroupRequestConfig
final RequestConfig getGroupRequestConfig(UUID groupId)
To obtain the request config of the operation getGroup
-
getGroupWithContacts
final GroupContactsDto getGroupWithContacts(UUID groupId)
Get group and contacts belonging to it
-
getGroupWithContactsRequestConfig
final RequestConfig getGroupWithContactsRequestConfig(UUID groupId)
To obtain the request config of the operation getGroupWithContacts
-
getGroupWithContactsPaginated
final PageContactProjection getGroupWithContactsPaginated(UUID groupId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)
Get group and paginated contacts belonging to it
- Parameters:
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)since- Filter by created at after the given timestamp (optional)before- Filter by created at before the given timestamp (optional)
-
getGroupWithContactsPaginatedRequestConfig
final RequestConfig getGroupWithContactsPaginatedRequestConfig(UUID groupId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)
To obtain the request config of the operation getGroupWithContactsPaginated
- Parameters:
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)since- Filter by created at after the given timestamp (optional)before- Filter by created at before the given timestamp (optional)
-
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 updateGroupContacts)
Remove contacts from a group
-
removeContactsFromGroupRequestConfig
final RequestConfig removeContactsFromGroupRequestConfig(UUID groupId, UpdateGroupContacts updateGroupContacts)
To obtain the request config of the operation removeContactsFromGroup
-
-
-
-