/** * 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 { CreateInboxForwarderOptions, InboxForwarderDto, InboxForwarderTestOptions, InboxForwarderTestResult, PageInboxForwarderDto, TestNewInboxForwarderOptions } from '../models'; export interface CreateNewInboxForwarderRequest { inboxId: string; createInboxForwarderOptions: CreateInboxForwarderOptions; } export interface DeleteInboxForwarderRequest { id: string; } export interface DeleteInboxForwardersRequest { inboxId?: string; } export interface GetInboxForwarderRequest { id: string; } export interface GetInboxForwardersRequest { inboxId?: string; page?: number; size?: number; sort?: GetInboxForwardersSortEnum; searchFilter?: string; since?: Date; before?: Date; } export interface TestInboxForwarderRequest { id: string; inboxForwarderTestOptions: InboxForwarderTestOptions; } export interface TestInboxForwardersForInboxRequest { inboxId: string; inboxForwarderTestOptions: InboxForwarderTestOptions; } export interface TestNewInboxForwarderRequest { testNewInboxForwarderOptions: TestNewInboxForwarderOptions; } /** * InboxForwarderControllerApi - interface * * @export * @interface InboxForwarderControllerApiInterface */ export interface InboxForwarderControllerApiInterface { /** * Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving * @summary Create an inbox forwarder * @param {string} inboxId Inbox id to attach forwarder to * @param {CreateInboxForwarderOptions} createInboxForwarderOptions * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InboxForwarderControllerApiInterface */ createNewInboxForwarderRaw(requestParameters: CreateNewInboxForwarderRequest): Promise>; /** * Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving * Create an inbox forwarder */ createNewInboxForwarder(requestParameters: CreateNewInboxForwarderRequest): Promise; /** * Delete inbox forwarder * @summary Delete an inbox forwarder * @param {string} id ID of inbox forwarder * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InboxForwarderControllerApiInterface */ deleteInboxForwarderRaw(requestParameters: DeleteInboxForwarderRequest): Promise>; /** * Delete inbox forwarder * Delete an inbox forwarder */ deleteInboxForwarder(requestParameters: DeleteInboxForwarderRequest): Promise; /** * Delete inbox forwarders. Accepts optional inboxId filter. * @summary Delete inbox forwarders * @param {string} [inboxId] Optional inbox id to attach forwarder to * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InboxForwarderControllerApiInterface */ deleteInboxForwardersRaw(requestParameters: DeleteInboxForwardersRequest): Promise>; /** * Delete inbox forwarders. Accepts optional inboxId filter. * Delete inbox forwarders */ deleteInboxForwarders(requestParameters: DeleteInboxForwardersRequest): Promise; /** * Get inbox ruleset * @summary Get an inbox forwarder * @param {string} id ID of inbox forwarder * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InboxForwarderControllerApiInterface */ getInboxForwarderRaw(requestParameters: GetInboxForwarderRequest): Promise>; /** * Get inbox ruleset * Get an inbox forwarder */ getInboxForwarder(requestParameters: GetInboxForwarderRequest): Promise; /** * List all forwarders attached to an inbox * @summary List inbox forwarders * @param {string} [inboxId] Optional inbox id to get forwarders from * @param {number} [page] Optional page index in inbox forwarder list pagination * @param {number} [size] Optional page size in inbox forwarder list pagination * @param {'ASC' | 'DESC'} [sort] Optional createdAt sort direction ASC or DESC * @param {string} [searchFilter] Optional search filter * @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 InboxForwarderControllerApiInterface */ getInboxForwardersRaw(requestParameters: GetInboxForwardersRequest): Promise>; /** * List all forwarders attached to an inbox * List inbox forwarders */ getInboxForwarders(requestParameters: GetInboxForwardersRequest): Promise; /** * Test an inbox forwarder * @summary Test an inbox forwarder * @param {string} id ID of inbox forwarder * @param {InboxForwarderTestOptions} inboxForwarderTestOptions * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InboxForwarderControllerApiInterface */ testInboxForwarderRaw(requestParameters: TestInboxForwarderRequest): Promise>; /** * Test an inbox forwarder * Test an inbox forwarder */ testInboxForwarder(requestParameters: TestInboxForwarderRequest): Promise; /** * Test inbox forwarders for inbox * @summary Test inbox forwarders for inbox * @param {string} inboxId ID of inbox * @param {InboxForwarderTestOptions} inboxForwarderTestOptions * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InboxForwarderControllerApiInterface */ testInboxForwardersForInboxRaw(requestParameters: TestInboxForwardersForInboxRequest): Promise>; /** * Test inbox forwarders for inbox * Test inbox forwarders for inbox */ testInboxForwardersForInbox(requestParameters: TestInboxForwardersForInboxRequest): Promise; /** * Test new inbox forwarder * @summary Test new inbox forwarder * @param {TestNewInboxForwarderOptions} testNewInboxForwarderOptions * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InboxForwarderControllerApiInterface */ testNewInboxForwarderRaw(requestParameters: TestNewInboxForwarderRequest): Promise>; /** * Test new inbox forwarder * Test new inbox forwarder */ testNewInboxForwarder(requestParameters: TestNewInboxForwarderRequest): Promise; } /** * */ export declare class InboxForwarderControllerApi extends runtime.BaseAPI implements InboxForwarderControllerApiInterface { /** * Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving * Create an inbox forwarder */ createNewInboxForwarderRaw(requestParameters: CreateNewInboxForwarderRequest): Promise>; /** * Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving * Create an inbox forwarder */ createNewInboxForwarder(requestParameters: CreateNewInboxForwarderRequest): Promise; /** * Delete inbox forwarder * Delete an inbox forwarder */ deleteInboxForwarderRaw(requestParameters: DeleteInboxForwarderRequest): Promise>; /** * Delete inbox forwarder * Delete an inbox forwarder */ deleteInboxForwarder(requestParameters: DeleteInboxForwarderRequest): Promise; /** * Delete inbox forwarders. Accepts optional inboxId filter. * Delete inbox forwarders */ deleteInboxForwardersRaw(requestParameters: DeleteInboxForwardersRequest): Promise>; /** * Delete inbox forwarders. Accepts optional inboxId filter. * Delete inbox forwarders */ deleteInboxForwarders(requestParameters: DeleteInboxForwardersRequest): Promise; /** * Get inbox ruleset * Get an inbox forwarder */ getInboxForwarderRaw(requestParameters: GetInboxForwarderRequest): Promise>; /** * Get inbox ruleset * Get an inbox forwarder */ getInboxForwarder(requestParameters: GetInboxForwarderRequest): Promise; /** * List all forwarders attached to an inbox * List inbox forwarders */ getInboxForwardersRaw(requestParameters: GetInboxForwardersRequest): Promise>; /** * List all forwarders attached to an inbox * List inbox forwarders */ getInboxForwarders(requestParameters: GetInboxForwardersRequest): Promise; /** * Test an inbox forwarder * Test an inbox forwarder */ testInboxForwarderRaw(requestParameters: TestInboxForwarderRequest): Promise>; /** * Test an inbox forwarder * Test an inbox forwarder */ testInboxForwarder(requestParameters: TestInboxForwarderRequest): Promise; /** * Test inbox forwarders for inbox * Test inbox forwarders for inbox */ testInboxForwardersForInboxRaw(requestParameters: TestInboxForwardersForInboxRequest): Promise>; /** * Test inbox forwarders for inbox * Test inbox forwarders for inbox */ testInboxForwardersForInbox(requestParameters: TestInboxForwardersForInboxRequest): Promise; /** * Test new inbox forwarder * Test new inbox forwarder */ testNewInboxForwarderRaw(requestParameters: TestNewInboxForwarderRequest): Promise>; /** * Test new inbox forwarder * Test new inbox forwarder */ testNewInboxForwarder(requestParameters: TestNewInboxForwarderRequest): Promise; } /** * @export * @enum {string} */ export declare enum GetInboxForwardersSortEnum { ASC = "ASC", DESC = "DESC" }