MailSlurp JS

Globals / GroupControllerApi

Class: GroupControllerApi

GroupControllerApi - object-oriented interface

export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Inherited from BaseAPI.constructor

Defined in src/generated/api.ts:57

Parameters:

NameTypeDefault value
configuration?Configuration-
basePathstringBASE_PATH
fetchFetchAPIportableFetch

Returns: GroupControllerApi

Properties

basePath

Protected basePath: string

Inherited from BaseAPI.basePath

Defined in src/generated/api.ts:61


configuration

Protected configuration: Configuration

Inherited from BaseAPI.configuration

Defined in src/generated/api.ts:57


fetch

Protected 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:18114

summary Add contacts to a group

throws {RequiredError}

memberof GroupControllerApi

Parameters:

NameTypeDescription
groupIdstringgroupId
updateGroupContactsOptionUpdateGroupContactsupdateGroupContactsOption
options?any-

Returns: Promise<GroupContactsDto>


createGroup

createGroup(createGroupOptions: CreateGroupOptions, options?: any): Promise<GroupDto>

Defined in src/generated/api.ts:18134

summary Create a group

throws {RequiredError}

memberof GroupControllerApi

Parameters:

NameTypeDescription
createGroupOptionsCreateGroupOptionscreateGroupOptions
options?any-

Returns: Promise<GroupDto>


deleteGroup

deleteGroup(groupId: string, options?: any): Promise

Defined in src/generated/api.ts:18149

summary Delete group

throws {RequiredError}

memberof GroupControllerApi

Parameters:

NameTypeDescription
groupIdstringgroupId
options?any-

Returns: Promise


getAllGroups

getAllGroups(page?: number, size?: number, sort?: “ASC” | “DESC”, options?: any): Promise<PageGroupProjection>

Defined in src/generated/api.ts:18166

summary Get all Contact Groups in paginated format

throws {RequiredError}

memberof GroupControllerApi

Parameters:

NameType
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:18188

summary Get group

throws {RequiredError}

memberof GroupControllerApi

Parameters:

NameTypeDescription
groupIdstringgroupId
options?any-

Returns: Promise<GroupDto>


getGroupWithContacts

getGroupWithContacts(groupId: string, options?: any): Promise<GroupContactsDto>

Defined in src/generated/api.ts:18203

summary Get group and contacts belonging to it

throws {RequiredError}

memberof GroupControllerApi

Parameters:

NameTypeDescription
groupIdstringgroupId
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:18221

summary Get group and paginated contacts belonging to it

throws {RequiredError}

memberof GroupControllerApi

Parameters:

NameTypeDescription
groupIdstringgroupId
page?number-
size?number-
sort?“ASC”“DESC”
options?any-

Returns: Promise<PageContactProjection>


getGroups

getGroups(options?: any): Promise<GroupProjection[]>

Defined in src/generated/api.ts:18243

summary Get all groups

throws {RequiredError}

memberof GroupControllerApi

Parameters:

NameType
options?any

Returns: Promise<GroupProjection[]>


removeContactsFromGroup

removeContactsFromGroup(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options?: any): Promise<GroupContactsDto>

Defined in src/generated/api.ts:18259

summary Remove contacts from a group

throws {RequiredError}

memberof GroupControllerApi

Parameters:

NameTypeDescription
groupIdstringgroupId
updateGroupContactsOptionUpdateGroupContactsupdateGroupContactsOption
options?any-

Returns: Promise<GroupContactsDto>