Globals / GroupControllerApi
# Class: GroupControllerApi
GroupControllerApi - object-oriented interface
export
# Hierarchy
-
↳ GroupControllerApi
# Index
# Constructors
# Properties
# Methods
- addContactsToGroup
- createGroup
- deleteGroup
- getAllGroups
- getGroup
- getGroupWithContacts
- getGroupWithContactsPaginated
- getGroups
- removeContactsFromGroup
# Constructors
# constructor
+ new GroupControllerApi(configuration?: Configuration, basePath?: string, fetch?: FetchAPI): GroupControllerApi
Inherited from BaseAPI.constructor
Defined in src/generated/api.ts:57 (opens new window)
# Parameters:
| Name | Type | Default value |
|---|---|---|
configuration? | Configuration | - |
basePath | string | BASE_PATH |
fetch | FetchAPI | portableFetch |
Returns: GroupControllerApi
# Properties
# basePath
• Protected basePath: string
Inherited from BaseAPI.basePath
Defined in src/generated/api.ts:61 (opens new window)
# configuration
• Protected configuration: Configuration
Inherited from BaseAPI.configuration
Defined in src/generated/api.ts:57 (opens new window)
# fetch
• Protected fetch: FetchAPI
Defined in src/generated/api.ts:62 (opens new window)
# Methods
# addContactsToGroup
▸ addContactsToGroup(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options?: any): Promise<GroupContactsDto>
Defined in src/generated/api.ts:12261 (opens new window)
summary Add contacts to a group
throws {RequiredError}
memberof GroupControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
groupId | string | groupId |
updateGroupContactsOption | UpdateGroupContacts | updateGroupContactsOption |
options? | any | - |
Returns: Promise<GroupContactsDto>
# createGroup
▸ createGroup(createGroupOptions: CreateGroupOptions, options?: any): Promise<GroupDto>
Defined in src/generated/api.ts:12281 (opens new window)
summary Create a group
throws {RequiredError}
memberof GroupControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
createGroupOptions | CreateGroupOptions | createGroupOptions |
options? | any | - |
Returns: Promise<GroupDto>
# deleteGroup
▸ deleteGroup(groupId: string, options?: any): Promise<Response>
Defined in src/generated/api.ts:12296 (opens new window)
summary Delete group
throws {RequiredError}
memberof GroupControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
groupId | string | groupId |
options? | any | - |
Returns: Promise<Response>
# getAllGroups
▸ getAllGroups(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any): Promise<PageGroupProjection>
Defined in src/generated/api.ts:12313 (opens new window)
summary Get all Contact Groups in paginated format
throws {RequiredError}
memberof GroupControllerApi
# Parameters:
| Name | Type |
|---|---|
page? | number |
size? | number |
sort? | "ASC" |
options? | any |
Returns: Promise<PageGroupProjection>
# getGroup
▸ getGroup(groupId: string, options?: any): Promise<GroupDto>
Defined in src/generated/api.ts:12335 (opens new window)
summary Get group
throws {RequiredError}
memberof GroupControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
groupId | string | groupId |
options? | any | - |
Returns: Promise<GroupDto>
# getGroupWithContacts
▸ getGroupWithContacts(groupId: string, options?: any): Promise<GroupContactsDto>
Defined in src/generated/api.ts:12350 (opens new window)
summary Get group and contacts belonging to it
throws {RequiredError}
memberof GroupControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
groupId | string | groupId |
options? | any | - |
Returns: Promise<GroupContactsDto>
# getGroupWithContactsPaginated
▸ getGroupWithContactsPaginated(groupId: string, page?: number, size?: number, sort?: "ASC" | "DESC", options?: any): Promise<PageContactProjection>
Defined in src/generated/api.ts:12368 (opens new window)
summary Get group and paginated contacts belonging to it
throws {RequiredError}
memberof GroupControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
groupId | string | groupId |
page? | number | - |
size? | number | - |
sort? | "ASC" | "DESC" |
options? | any | - |
Returns: Promise<PageContactProjection>
# getGroups
▸ getGroups(options?: any): Promise<GroupProjection[]>
Defined in src/generated/api.ts:12390 (opens new window)
summary Get all groups
throws {RequiredError}
memberof GroupControllerApi
# Parameters:
| Name | Type |
|---|---|
options? | any |
Returns: Promise<GroupProjection[]>
# removeContactsFromGroup
▸ removeContactsFromGroup(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options?: any): Promise<GroupContactsDto>
Defined in src/generated/api.ts:12406 (opens new window)
summary Remove contacts from a group
throws {RequiredError}
memberof GroupControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
groupId | string | groupId |
updateGroupContactsOption | UpdateGroupContacts | updateGroupContactsOption |
options? | any | - |
Returns: Promise<GroupContactsDto>
