/** * MailSlurp API * MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It\'s designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository * * The version of the OpenAPI document: 6.5.2 * Contact: contact@mailslurp.dev * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { CreateGroupOptions, GroupContactsDto, GroupDto, GroupProjection, PageContactProjection, PageGroupProjection, UpdateGroupContacts } from '../models'; export interface AddContactsToGroupRequest { groupId: string; updateGroupContacts: UpdateGroupContacts; } export interface CreateGroupRequest { createGroupOptions: CreateGroupOptions; } export interface DeleteGroupRequest { groupId: string; } export interface GetAllGroupsRequest { page?: number; size?: number; sort?: GetAllGroupsSortEnum; since?: Date; before?: Date; } export interface GetGroupRequest { groupId: string; } export interface GetGroupWithContactsRequest { groupId: string; } export interface GetGroupWithContactsPaginatedRequest { groupId: string; page?: number; size?: number; sort?: GetGroupWithContactsPaginatedSortEnum; since?: Date; before?: Date; } export interface RemoveContactsFromGroupRequest { groupId: string; updateGroupContacts: UpdateGroupContacts; } /** * GroupControllerApi - interface * * @export * @interface GroupControllerApiInterface */ export interface GroupControllerApiInterface { /** * * @summary Add contacts to a group * @param {string} groupId * @param {UpdateGroupContacts} updateGroupContacts * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupControllerApiInterface */ addContactsToGroupRaw(requestParameters: AddContactsToGroupRequest): Promise>; /** * Add contacts to a group */ addContactsToGroup(requestParameters: AddContactsToGroupRequest): Promise; /** * * @summary Create a group * @param {CreateGroupOptions} createGroupOptions * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupControllerApiInterface */ createGroupRaw(requestParameters: CreateGroupRequest): Promise>; /** * Create a group */ createGroup(requestParameters: CreateGroupRequest): Promise; /** * * @summary Delete group * @param {string} groupId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupControllerApiInterface */ deleteGroupRaw(requestParameters: DeleteGroupRequest): Promise>; /** * Delete group */ deleteGroup(requestParameters: DeleteGroupRequest): Promise; /** * * @summary Get all Contact Groups in paginated format * @param {number} [page] Optional page index in list pagination * @param {number} [size] Optional page size in list pagination * @param {'ASC' | 'DESC'} [sort] Optional createdAt sort direction ASC or DESC * @param {Date} [since] Filter by created at after the given timestamp * @param {Date} [before] Filter by created at before the given timestamp * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupControllerApiInterface */ getAllGroupsRaw(requestParameters: GetAllGroupsRequest): Promise>; /** * Get all Contact Groups in paginated format */ getAllGroups(requestParameters: GetAllGroupsRequest): Promise; /** * * @summary Get group * @param {string} groupId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupControllerApiInterface */ getGroupRaw(requestParameters: GetGroupRequest): Promise>; /** * Get group */ getGroup(requestParameters: GetGroupRequest): Promise; /** * * @summary Get group and contacts belonging to it * @param {string} groupId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupControllerApiInterface */ getGroupWithContactsRaw(requestParameters: GetGroupWithContactsRequest): Promise>; /** * Get group and contacts belonging to it */ getGroupWithContacts(requestParameters: GetGroupWithContactsRequest): Promise; /** * Get group and paginated contacts belonging to it * @param {string} groupId * @param {number} [page] Optional page index in group contact pagination * @param {number} [size] Optional page size in group contact pagination * @param {'ASC' | 'DESC'} [sort] Optional createdAt sort direction ASC or DESC * @param {Date} [since] Filter by created at after the given timestamp * @param {Date} [before] Filter by created at before the given timestamp * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupControllerApiInterface */ getGroupWithContactsPaginatedRaw(requestParameters: GetGroupWithContactsPaginatedRequest): Promise>; /** * Get group and paginated contacts belonging to it */ getGroupWithContactsPaginated(requestParameters: GetGroupWithContactsPaginatedRequest): Promise; /** * * @summary Get all groups * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupControllerApiInterface */ getGroupsRaw(): Promise>>; /** * Get all groups */ getGroups(): Promise>; /** * * @summary Remove contacts from a group * @param {string} groupId * @param {UpdateGroupContacts} updateGroupContacts * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupControllerApiInterface */ removeContactsFromGroupRaw(requestParameters: RemoveContactsFromGroupRequest): Promise>; /** * Remove contacts from a group */ removeContactsFromGroup(requestParameters: RemoveContactsFromGroupRequest): Promise; } /** * */ export declare class GroupControllerApi extends runtime.BaseAPI implements GroupControllerApiInterface { /** * Add contacts to a group */ addContactsToGroupRaw(requestParameters: AddContactsToGroupRequest): Promise>; /** * Add contacts to a group */ addContactsToGroup(requestParameters: AddContactsToGroupRequest): Promise; /** * Create a group */ createGroupRaw(requestParameters: CreateGroupRequest): Promise>; /** * Create a group */ createGroup(requestParameters: CreateGroupRequest): Promise; /** * Delete group */ deleteGroupRaw(requestParameters: DeleteGroupRequest): Promise>; /** * Delete group */ deleteGroup(requestParameters: DeleteGroupRequest): Promise; /** * Get all Contact Groups in paginated format */ getAllGroupsRaw(requestParameters: GetAllGroupsRequest): Promise>; /** * Get all Contact Groups in paginated format */ getAllGroups(requestParameters: GetAllGroupsRequest): Promise; /** * Get group */ getGroupRaw(requestParameters: GetGroupRequest): Promise>; /** * Get group */ getGroup(requestParameters: GetGroupRequest): Promise; /** * Get group and contacts belonging to it */ getGroupWithContactsRaw(requestParameters: GetGroupWithContactsRequest): Promise>; /** * Get group and contacts belonging to it */ getGroupWithContacts(requestParameters: GetGroupWithContactsRequest): Promise; /** * Get group and paginated contacts belonging to it */ getGroupWithContactsPaginatedRaw(requestParameters: GetGroupWithContactsPaginatedRequest): Promise>; /** * Get group and paginated contacts belonging to it */ getGroupWithContactsPaginated(requestParameters: GetGroupWithContactsPaginatedRequest): Promise; /** * Get all groups */ getGroupsRaw(): Promise>>; /** * Get all groups */ getGroups(): Promise>; /** * Remove contacts from a group */ removeContactsFromGroupRaw(requestParameters: RemoveContactsFromGroupRequest): Promise>; /** * Remove contacts from a group */ removeContactsFromGroup(requestParameters: RemoveContactsFromGroupRequest): Promise; } /** * @export * @enum {string} */ export declare enum GetAllGroupsSortEnum { ASC = "ASC", DESC = "DESC" } /** * @export * @enum {string} */ export declare enum GetGroupWithContactsPaginatedSortEnum { ASC = "ASC", DESC = "DESC" }