Skip to content

Class: GroupControllerApi

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new GroupControllerApi(configuration?)

Parameters

Name Type
configuration Configuration

Inherited from

BaseAPI.constructor

Properties

configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

addContactsToGroup

addContactsToGroup(requestParameters, initOverrides?): Promise<GroupContactsDto>

Add contacts to a group

Parameters

Name Type
requestParameters AddContactsToGroupRequest
initOverrides? RequestInit

Returns

Promise<GroupContactsDto>


addContactsToGroupRaw

addContactsToGroupRaw(requestParameters, initOverrides?): Promise<ApiResponse<GroupContactsDto>>

Add contacts to a group

Parameters

Name Type
requestParameters AddContactsToGroupRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<GroupContactsDto>>


createGroup

createGroup(requestParameters, initOverrides?): Promise<GroupDto>

Create a group

Parameters

Name Type
requestParameters CreateGroupRequest
initOverrides? RequestInit

Returns

Promise<GroupDto>


createGroupRaw

createGroupRaw(requestParameters, initOverrides?): Promise<ApiResponse<GroupDto>>

Create a group

Parameters

Name Type
requestParameters CreateGroupRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<GroupDto>>


deleteGroup

deleteGroup(requestParameters, initOverrides?): Promise<void>

Delete group

Parameters

Name Type
requestParameters DeleteGroupRequest
initOverrides? RequestInit

Returns

Promise<void>


deleteGroupRaw

deleteGroupRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Delete group

Parameters

Name Type
requestParameters DeleteGroupRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<void>>


getAllGroups

getAllGroups(requestParameters, initOverrides?): Promise<PageGroupProjection>

Get all Contact Groups in paginated format

Parameters

Name Type
requestParameters GetAllGroupsRequest
initOverrides? RequestInit

Returns

Promise<PageGroupProjection>


getAllGroupsRaw

getAllGroupsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageGroupProjection>>

Get all Contact Groups in paginated format

Parameters

Name Type
requestParameters GetAllGroupsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageGroupProjection>>


getGroup

getGroup(requestParameters, initOverrides?): Promise<GroupDto>

Get group

Parameters

Name Type
requestParameters GetGroupRequest
initOverrides? RequestInit

Returns

Promise<GroupDto>


getGroupRaw

getGroupRaw(requestParameters, initOverrides?): Promise<ApiResponse<GroupDto>>

Get group

Parameters

Name Type
requestParameters GetGroupRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<GroupDto>>


getGroupWithContacts

getGroupWithContacts(requestParameters, initOverrides?): Promise<GroupContactsDto>

Get group and contacts belonging to it

Parameters

Name Type
requestParameters GetGroupWithContactsRequest
initOverrides? RequestInit

Returns

Promise<GroupContactsDto>


getGroupWithContactsPaginated

getGroupWithContactsPaginated(requestParameters, initOverrides?): Promise<PageContactProjection>

Get group and paginated contacts belonging to it

Parameters

Name Type
requestParameters GetGroupWithContactsPaginatedRequest
initOverrides? RequestInit

Returns

Promise<PageContactProjection>


getGroupWithContactsPaginatedRaw

getGroupWithContactsPaginatedRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageContactProjection>>

Get group and paginated contacts belonging to it

Parameters

Name Type
requestParameters GetGroupWithContactsPaginatedRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageContactProjection>>


getGroupWithContactsRaw

getGroupWithContactsRaw(requestParameters, initOverrides?): Promise<ApiResponse<GroupContactsDto>>

Get group and contacts belonging to it

Parameters

Name Type
requestParameters GetGroupWithContactsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<GroupContactsDto>>


getGroups

getGroups(initOverrides?): Promise<GroupProjection[]>

Get all groups

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<GroupProjection[]>


getGroupsRaw

getGroupsRaw(initOverrides?): Promise<ApiResponse<GroupProjection[]>>

Get all groups

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<ApiResponse<GroupProjection[]>>


removeContactsFromGroup

removeContactsFromGroup(requestParameters, initOverrides?): Promise<GroupContactsDto>

Remove contacts from a group

Parameters

Name Type
requestParameters RemoveContactsFromGroupRequest
initOverrides? RequestInit

Returns

Promise<GroupContactsDto>


removeContactsFromGroupRaw

removeContactsFromGroupRaw(requestParameters, initOverrides?): Promise<ApiResponse<GroupContactsDto>>

Remove contacts from a group

Parameters

Name Type
requestParameters RemoveContactsFromGroupRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<GroupContactsDto>>


request

Protected request(context, initOverrides?): Promise<Response>

Parameters

Name Type
context RequestOpts
initOverrides? RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request


withMiddleware

withMiddleware<T>(this, ...middlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...middlewares Middleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware


withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...postMiddlewares (context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware


withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...preMiddlewares (context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware