# Class: GroupControllerApi

GroupControllerApi - object-oriented interface

export

class GroupControllerApi

extends {BaseAPI}

# Hierarchy

# Constructors

# constructor

+ new GroupControllerApi(configuration?: Configuration, basePath: string, fetch: FetchAPI): GroupControllerApi

Inherited from BaseAPI.constructor

Defined in src/generated/api.ts:57

Parameters:

Name Type Default
configuration? Configuration -
basePath string BASE_PATH
fetch FetchAPI portableFetch

Returns: GroupControllerApi

# Properties

# Protected basePath

basePath: string

Inherited from BaseAPI.basePath

Defined in src/generated/api.ts:61


# Protected configuration

configuration: Configuration

Inherited from BaseAPI.configuration

Defined in src/generated/api.ts:57


# Protected fetch

fetch: FetchAPI

Inherited from BaseAPI.fetch

Defined in src/generated/api.ts:62

# Methods

# addContactsToGroup

addContactsToGroup(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options?: any): Promise‹GroupContactsDto

Defined in src/generated/api.ts:8665

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:8685

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:8700

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:8717

summary Get all Contact Groups in paginated format

throws {RequiredError}

memberof GroupControllerApi

Parameters:

Name Type
page? number
size? number
sort? "ASC" | "DESC"
options? any

Returns: Promise‹PageGroupProjection


# getGroup

getGroup(groupId: string, options?: any): Promise‹GroupDto

Defined in src/generated/api.ts:8739

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:8754

summary Get group and contacts belonging to it

throws {RequiredError}

memberof GroupControllerApi

Parameters:

Name Type Description
groupId string groupId
options? any -

Returns: Promise‹GroupContactsDto


# getGroups

getGroups(options?: any): Promise‹GroupProjection[]›

Defined in src/generated/api.ts:8768

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:8784

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