Class GroupControllerApi

Hierarchy

BaseAPI
- GroupControllerApi

Constructors

constructor

new GroupControllerApi(configuration?: Configuration): GroupControllerApi
Parameters
- configuration: Configuration = ...
Returns GroupControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

addContactsToGroup

addContactsToGroup(requestParameters: AddContactsToGroupRequest, initOverrides?: RequestInit): Promise<GroupContactsDto>
Add contacts to a group
Parameters
- requestParameters: AddContactsToGroupRequest
- Optional initOverrides: RequestInit
Returns Promise<GroupContactsDto>

addContactsToGroupRaw

addContactsToGroupRaw(requestParameters: AddContactsToGroupRequest, initOverrides?: RequestInit): Promise<ApiResponse<GroupContactsDto>>
Add contacts to a group
Parameters
- requestParameters: AddContactsToGroupRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<GroupContactsDto>>

createGroup

createGroup(requestParameters: CreateGroupRequest, initOverrides?: RequestInit): Promise<GroupDto>
Create a group
Parameters
- requestParameters: CreateGroupRequest
- Optional initOverrides: RequestInit
Returns Promise<GroupDto>

createGroupRaw

createGroupRaw(requestParameters: CreateGroupRequest, initOverrides?: RequestInit): Promise<ApiResponse<GroupDto>>
Create a group
Parameters
- requestParameters: CreateGroupRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<GroupDto>>

deleteGroup

deleteGroup(requestParameters: DeleteGroupRequest, initOverrides?: RequestInit): Promise<void>
Delete group
Parameters
- requestParameters: DeleteGroupRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteGroupRaw

deleteGroupRaw(requestParameters: DeleteGroupRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete group
Parameters
- requestParameters: DeleteGroupRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

getAllGroups

getAllGroups(requestParameters: GetAllGroupsRequest, initOverrides?: RequestInit): Promise<PageGroupProjection>
Get all Contact Groups in paginated format
Parameters
- requestParameters: GetAllGroupsRequest
- Optional initOverrides: RequestInit
Returns Promise<PageGroupProjection>

getAllGroupsRaw

getAllGroupsRaw(requestParameters: GetAllGroupsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageGroupProjection>>
Get all Contact Groups in paginated format
Parameters
- requestParameters: GetAllGroupsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageGroupProjection>>

getGroup

getGroup(requestParameters: GetGroupRequest, initOverrides?: RequestInit): Promise<GroupDto>
Get group
Parameters
- requestParameters: GetGroupRequest
- Optional initOverrides: RequestInit
Returns Promise<GroupDto>

getGroupRaw

getGroupRaw(requestParameters: GetGroupRequest, initOverrides?: RequestInit): Promise<ApiResponse<GroupDto>>
Get group
Parameters
- requestParameters: GetGroupRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<GroupDto>>

getGroupWithContacts

getGroupWithContacts(requestParameters: GetGroupWithContactsRequest, initOverrides?: RequestInit): Promise<GroupContactsDto>
Get group and contacts belonging to it
Parameters
- requestParameters: GetGroupWithContactsRequest
- Optional initOverrides: RequestInit
Returns Promise<GroupContactsDto>

getGroupWithContactsPaginated

getGroupWithContactsPaginated(requestParameters: GetGroupWithContactsPaginatedRequest, initOverrides?: RequestInit): Promise<PageContactProjection>
Get group and paginated contacts belonging to it
Parameters
- requestParameters: GetGroupWithContactsPaginatedRequest
- Optional initOverrides: RequestInit
Returns Promise<PageContactProjection>

getGroupWithContactsPaginatedRaw

getGroupWithContactsPaginatedRaw(requestParameters: GetGroupWithContactsPaginatedRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageContactProjection>>
Get group and paginated contacts belonging to it
Parameters
- requestParameters: GetGroupWithContactsPaginatedRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageContactProjection>>

getGroupWithContactsRaw

getGroupWithContactsRaw(requestParameters: GetGroupWithContactsRequest, initOverrides?: RequestInit): Promise<ApiResponse<GroupContactsDto>>
Get group and contacts belonging to it
Parameters
- requestParameters: GetGroupWithContactsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<GroupContactsDto>>

getGroups

getGroups(initOverrides?: RequestInit): Promise<GroupProjection[]>
Get all groups
Parameters
- Optional initOverrides: RequestInit
Returns Promise<GroupProjection[]>

getGroupsRaw

getGroupsRaw(initOverrides?: RequestInit): Promise<ApiResponse<GroupProjection[]>>
Get all groups
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<GroupProjection[]>>

removeContactsFromGroup

removeContactsFromGroup(requestParameters: RemoveContactsFromGroupRequest, initOverrides?: RequestInit): Promise<GroupContactsDto>
Remove contacts from a group
Parameters
- requestParameters: RemoveContactsFromGroupRequest
- Optional initOverrides: RequestInit
Returns Promise<GroupContactsDto>

removeContactsFromGroupRaw

removeContactsFromGroupRaw(requestParameters: RemoveContactsFromGroupRequest, initOverrides?: RequestInit): Promise<ApiResponse<GroupContactsDto>>
Remove contacts from a group
Parameters
- requestParameters: RemoveContactsFromGroupRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<GroupContactsDto>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware