MailSlurp JS

Globals / GroupControllerApi

# Class: GroupControllerApi

GroupControllerApi - object-oriented interface

export

# Hierarchy

# Index

# Constructors

# Properties

# Methods

# 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

Inherited from BaseAPI.fetch

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:9707 (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:9727 (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:9742 (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:9759 (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:9781 (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:9796 (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:9814 (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:9836 (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:9852 (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>