mailslurp-client/dist/generated/apis/ConnectorControllerApi.d.ts

Official client for MailSlurp Email and SMS API. Create email addresses and phone numbers in Javascript without a mail server. Send and receive real emails in applications or tests.

/**
 * MailSlurp API
 * MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. 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://docs.mailslurp.com/) - [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 { ConnectorDto, ConnectorEventDto, ConnectorImapConnectionDto, ConnectorImapConnectionTestResult, ConnectorProviderSettingsDto, ConnectorSmtpConnectionDto, ConnectorSmtpConnectionTestResult, ConnectorSyncRequestResult, ConnectorSyncSettingsDto, CreateConnectorImapConnectionOptions, CreateConnectorOptions, CreateConnectorSmtpConnectionOptions, CreateConnectorSyncSettingsOptions, CreateConnectorWithOptions, OptionalConnectorDto, OptionalConnectorImapConnectionDto, OptionalConnectorSmtpConnectionDto, OptionalConnectorSyncSettingsDto, PageConnector, PageConnectorEvents, SendEmailOptions, SentEmailDto } from '../models';
export interface CreateConnectorRequest {
    createConnectorOptions: CreateConnectorOptions;
    inboxId?: string;
}
export interface CreateConnectorImapConnectionRequest {
    id: string;
    createConnectorImapConnectionOptions: CreateConnectorImapConnectionOptions;
}
export interface CreateConnectorSmtpConnectionRequest {
    id: string;
    createConnectorSmtpConnectionOptions: CreateConnectorSmtpConnectionOptions;
}
export interface CreateConnectorSyncSettingsRequest {
    id: string;
    createConnectorSyncSettingsOptions: CreateConnectorSyncSettingsOptions;
}
export interface CreateConnectorWithOptionsRequest {
    createConnectorWithOptions: CreateConnectorWithOptions;
    inboxId?: string;
}
export interface DeleteConnectorRequest {
    id: string;
}
export interface DeleteConnectorImapConnectionRequest {
    id: string;
}
export interface DeleteConnectorSmtpConnectionRequest {
    id: string;
}
export interface DeleteConnectorSyncSettingsRequest {
    id: string;
}
export interface GetAllConnectorEventsRequest {
    id?: string;
    page?: number;
    size?: number;
    sort?: GetAllConnectorEventsSortEnum;
    since?: Date;
    before?: Date;
    eventType?: GetAllConnectorEventsEventTypeEnum;
}
export interface GetConnectorRequest {
    id: string;
}
export interface GetConnectorByEmailAddressRequest {
    emailAddress: string;
}
export interface GetConnectorByInboxIdRequest {
    inboxId: string;
}
export interface GetConnectorByNameRequest {
    name: string;
}
export interface GetConnectorEventRequest {
    id: string;
}
export interface GetConnectorEventsRequest {
    id: string;
    page?: number;
    size?: number;
    sort?: GetConnectorEventsSortEnum;
    since?: Date;
    before?: Date;
    eventType?: GetConnectorEventsEventTypeEnum;
}
export interface GetConnectorImapConnectionRequest {
    id: string;
}
export interface GetConnectorSmtpConnectionRequest {
    id: string;
}
export interface GetConnectorSyncSettingsRequest {
    id: string;
}
export interface GetConnectorsRequest {
    page?: number;
    size?: number;
    sort?: GetConnectorsSortEnum;
    since?: Date;
    before?: Date;
}
export interface SendEmailFromConnectorRequest {
    id: string;
    sendEmailOptions: SendEmailOptions;
    useFallback?: boolean;
}
export interface SyncConnectorRequest {
    id: string;
    since?: Date;
    folder?: string;
    logging?: boolean;
}
export interface TestConnectorImapConnectionRequest {
    id: string;
    createConnectorImapConnectionOptions?: CreateConnectorImapConnectionOptions;
}
export interface TestConnectorImapConnectionOptionsRequest {
    createConnectorImapConnectionOptions: CreateConnectorImapConnectionOptions;
}
export interface TestConnectorSmtpConnectionRequest {
    id: string;
    createConnectorSmtpConnectionOptions?: CreateConnectorSmtpConnectionOptions;
}
export interface TestConnectorSmtpConnectionOptionsRequest {
    createConnectorSmtpConnectionOptions: CreateConnectorSmtpConnectionOptions;
}
export interface UpdateConnectorRequest {
    id: string;
    createConnectorOptions: CreateConnectorOptions;
}
export interface UpdateConnectorImapConnectionRequest {
    id: string;
    createConnectorImapConnectionOptions: CreateConnectorImapConnectionOptions;
}
export interface UpdateConnectorSmtpConnectionRequest {
    id: string;
    createConnectorSmtpConnectionOptions: CreateConnectorSmtpConnectionOptions;
}
/**
 *
 */
export declare class ConnectorControllerApi extends runtime.BaseAPI {
    /**
     * Sync emails between external mailboxes and MailSlurp inboxes
     * Create an inbox connector
     */
    createConnectorRaw(requestParameters: CreateConnectorRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ConnectorDto>>;
    /**
     * Sync emails between external mailboxes and MailSlurp inboxes
     * Create an inbox connector
     */
    createConnector(requestParameters: CreateConnectorRequest, initOverrides?: RequestInit): Promise<ConnectorDto>;
    /**
     * Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox
     * Create an inbox connector IMAP connection
     */
    createConnectorImapConnectionRaw(requestParameters: CreateConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ConnectorImapConnectionDto>>;
    /**
     * Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox
     * Create an inbox connector IMAP connection
     */
    createConnectorImapConnection(requestParameters: CreateConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<ConnectorImapConnectionDto>;
    /**
     * Allows sending via connector and email is routed to connected inbox and sent via SMTP
     * Create an inbox connector SMTP connection
     */
    createConnectorSmtpConnectionRaw(requestParameters: CreateConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ConnectorSmtpConnectionDto>>;
    /**
     * Allows sending via connector and email is routed to connected inbox and sent via SMTP
     * Create an inbox connector SMTP connection
     */
    createConnectorSmtpConnection(requestParameters: CreateConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<ConnectorSmtpConnectionDto>;
    /**
     * Configure automatic pull or emails from external inboxes using an interval or schedule
     * Create an inbox connector sync settings
     */
    createConnectorSyncSettingsRaw(requestParameters: CreateConnectorSyncSettingsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ConnectorSyncSettingsDto>>;
    /**
     * Configure automatic pull or emails from external inboxes using an interval or schedule
     * Create an inbox connector sync settings
     */
    createConnectorSyncSettings(requestParameters: CreateConnectorSyncSettingsRequest, initOverrides?: RequestInit): Promise<ConnectorSyncSettingsDto>;
    /**
     * Sync emails between external mailboxes and MailSlurp inboxes
     * Create an inbox connector with options
     */
    createConnectorWithOptionsRaw(requestParameters: CreateConnectorWithOptionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ConnectorDto>>;
    /**
     * Sync emails between external mailboxes and MailSlurp inboxes
     * Create an inbox connector with options
     */
    createConnectorWithOptions(requestParameters: CreateConnectorWithOptionsRequest, initOverrides?: RequestInit): Promise<ConnectorDto>;
    /**
     * Delete all inbox connectors
     */
    deleteAllConnectorRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Delete all inbox connectors
     */
    deleteAllConnector(initOverrides?: RequestInit): Promise<void>;
    /**
     * Delete an inbox connector
     */
    deleteConnectorRaw(requestParameters: DeleteConnectorRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Delete an inbox connector
     */
    deleteConnector(requestParameters: DeleteConnectorRequest, initOverrides?: RequestInit): Promise<void>;
    /**
     * Delete IMAP connection for external inbox
     * Delete an inbox connector IMAP connection
     */
    deleteConnectorImapConnectionRaw(requestParameters: DeleteConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Delete IMAP connection for external inbox
     * Delete an inbox connector IMAP connection
     */
    deleteConnectorImapConnection(requestParameters: DeleteConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<void>;
    /**
     * Delete SMTP connection for external inbox
     * Delete an inbox connector SMTP connection
     */
    deleteConnectorSmtpConnectionRaw(requestParameters: DeleteConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Delete SMTP connection for external inbox
     * Delete an inbox connector SMTP connection
     */
    deleteConnectorSmtpConnection(requestParameters: DeleteConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<void>;
    /**
     * Configure automatic pull or emails from external inboxes using an interval or schedule
     * Create an inbox connector sync settings
     */
    deleteConnectorSyncSettingsRaw(requestParameters: DeleteConnectorSyncSettingsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Configure automatic pull or emails from external inboxes using an interval or schedule
     * Create an inbox connector sync settings
     */
    deleteConnectorSyncSettings(requestParameters: DeleteConnectorSyncSettingsRequest, initOverrides?: RequestInit): Promise<void>;
    /**
     * Get all inbox connector events
     */
    getAllConnectorEventsRaw(requestParameters: GetAllConnectorEventsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PageConnectorEvents>>;
    /**
     * Get all inbox connector events
     */
    getAllConnectorEvents(requestParameters: GetAllConnectorEventsRequest, initOverrides?: RequestInit): Promise<PageConnectorEvents>;
    /**
     * Get an inbox connector
     */
    getConnectorRaw(requestParameters: GetConnectorRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ConnectorDto>>;
    /**
     * Get an inbox connector
     */
    getConnector(requestParameters: GetConnectorRequest, initOverrides?: RequestInit): Promise<ConnectorDto>;
    /**
     * Find an inbox connector by email address
     * Get connector by email address
     */
    getConnectorByEmailAddressRaw(requestParameters: GetConnectorByEmailAddressRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<OptionalConnectorDto>>;
    /**
     * Find an inbox connector by email address
     * Get connector by email address
     */
    getConnectorByEmailAddress(requestParameters: GetConnectorByEmailAddressRequest, initOverrides?: RequestInit): Promise<OptionalConnectorDto>;
    /**
     * Find an inbox connector by inbox ID
     * Get connector by inbox ID
     */
    getConnectorByInboxIdRaw(requestParameters: GetConnectorByInboxIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<OptionalConnectorDto>>;
    /**
     * Find an inbox connector by inbox ID
     * Get connector by inbox ID
     */
    getConnectorByInboxId(requestParameters: GetConnectorByInboxIdRequest, initOverrides?: RequestInit): Promise<OptionalConnectorDto>;
    /**
     * Find an inbox connector by name
     * Get connector by name
     */
    getConnectorByNameRaw(requestParameters: GetConnectorByNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<OptionalConnectorDto>>;
    /**
     * Find an inbox connector by name
     * Get connector by name
     */
    getConnectorByName(requestParameters: GetConnectorByNameRequest, initOverrides?: RequestInit): Promise<OptionalConnectorDto>;
    /**
     * Get an inbox connector event
     */
    getConnectorEventRaw(requestParameters: GetConnectorEventRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ConnectorEventDto>>;
    /**
     * Get an inbox connector event
     */
    getConnectorEvent(requestParameters: GetConnectorEventRequest, initOverrides?: RequestInit): Promise<ConnectorEventDto>;
    /**
     * Get an inbox connector events
     */
    getConnectorEventsRaw(requestParameters: GetConnectorEventsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PageConnectorEvents>>;
    /**
     * Get an inbox connector events
     */
    getConnectorEvents(requestParameters: GetConnectorEventsRequest, initOverrides?: RequestInit): Promise<PageConnectorEvents>;
    /**
     * Get IMAP connection for external inbox
     * Get an inbox connector IMAP connection
     */
    getConnectorImapConnectionRaw(requestParameters: GetConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<OptionalConnectorImapConnectionDto>>;
    /**
     * Get IMAP connection for external inbox
     * Get an inbox connector IMAP connection
     */
    getConnectorImapConnection(requestParameters: GetConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<OptionalConnectorImapConnectionDto>;
    /**
     * Get common mail provider SMTP and IMAP connection settings
     * Get SMTP and IMAP connection settings for common mail providers
     */
    getConnectorProviderSettingsRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<ConnectorProviderSettingsDto>>;
    /**
     * Get common mail provider SMTP and IMAP connection settings
     * Get SMTP and IMAP connection settings for common mail providers
     */
    getConnectorProviderSettings(initOverrides?: RequestInit): Promise<ConnectorProviderSettingsDto>;
    /**
     * Get SMTP connection for external inbox
     * Get an inbox connector SMTP connection
     */
    getConnectorSmtpConnectionRaw(requestParameters: GetConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<OptionalConnectorSmtpConnectionDto>>;
    /**
     * Get SMTP connection for external inbox
     * Get an inbox connector SMTP connection
     */
    getConnectorSmtpConnection(requestParameters: GetConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<OptionalConnectorSmtpConnectionDto>;
    /**
     * Get sync settings for connection with external inbox
     * Get an inbox connector sync settings
     */
    getConnectorSyncSettingsRaw(requestParameters: GetConnectorSyncSettingsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<OptionalConnectorSyncSettingsDto>>;
    /**
     * Get sync settings for connection with external inbox
     * Get an inbox connector sync settings
     */
    getConnectorSyncSettings(requestParameters: GetConnectorSyncSettingsRequest, initOverrides?: RequestInit): Promise<OptionalConnectorSyncSettingsDto>;
    /**
     * List inbox connectors that sync external emails to MailSlurp inboxes
     * Get inbox connectors
     */
    getConnectorsRaw(requestParameters: GetConnectorsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PageConnector>>;
    /**
     * List inbox connectors that sync external emails to MailSlurp inboxes
     * Get inbox connectors
     */
    getConnectors(requestParameters: GetConnectorsRequest, initOverrides?: RequestInit): Promise<PageConnector>;
    /**
     * Send from an inbox connector
     */
    sendEmailFromConnectorRaw(requestParameters: SendEmailFromConnectorRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SentEmailDto>>;
    /**
     * Send from an inbox connector
     */
    sendEmailFromConnector(requestParameters: SendEmailFromConnectorRequest, initOverrides?: RequestInit): Promise<SentEmailDto>;
    /**
     * Sync an inbox connector
     */
    syncConnectorRaw(requestParameters: SyncConnectorRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ConnectorSyncRequestResult>>;
    /**
     * Sync an inbox connector
     */
    syncConnector(requestParameters: SyncConnectorRequest, initOverrides?: RequestInit): Promise<ConnectorSyncRequestResult>;
    /**
     * Test the IMAP connection for a connector
     * Test an inbox connector IMAP connection
     */
    testConnectorImapConnectionRaw(requestParameters: TestConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ConnectorImapConnectionTestResult>>;
    /**
     * Test the IMAP connection for a connector
     * Test an inbox connector IMAP connection
     */
    testConnectorImapConnection(requestParameters: TestConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<ConnectorImapConnectionTestResult>;
    /**
     * Test the IMAP connection options for a connector
     * Test an inbox connector IMAP connection options
     */
    testConnectorImapConnectionOptionsRaw(requestParameters: TestConnectorImapConnectionOptionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ConnectorImapConnectionTestResult>>;
    /**
     * Test the IMAP connection options for a connector
     * Test an inbox connector IMAP connection options
     */
    testConnectorImapConnectionOptions(requestParameters: TestConnectorImapConnectionOptionsRequest, initOverrides?: RequestInit): Promise<ConnectorImapConnectionTestResult>;
    /**
     * Test the SMTP connection for a connector
     * Test an inbox connector SMTP connection
     */
    testConnectorSmtpConnectionRaw(requestParameters: TestConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ConnectorSmtpConnectionTestResult>>;
    /**
     * Test the SMTP connection for a connector
     * Test an inbox connector SMTP connection
     */
    testConnectorSmtpConnection(requestParameters: TestConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<ConnectorSmtpConnectionTestResult>;
    /**
     * Test the SMTP connection options for a connector
     * Test an inbox connector SMTP connection options
     */
    testConnectorSmtpConnectionOptionsRaw(requestParameters: TestConnectorSmtpConnectionOptionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ConnectorSmtpConnectionTestResult>>;
    /**
     * Test the SMTP connection options for a connector
     * Test an inbox connector SMTP connection options
     */
    testConnectorSmtpConnectionOptions(requestParameters: TestConnectorSmtpConnectionOptionsRequest, initOverrides?: RequestInit): Promise<ConnectorSmtpConnectionTestResult>;
    /**
     * Update an inbox connector
     */
    updateConnectorRaw(requestParameters: UpdateConnectorRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ConnectorDto>>;
    /**
     * Update an inbox connector
     */
    updateConnector(requestParameters: UpdateConnectorRequest, initOverrides?: RequestInit): Promise<ConnectorDto>;
    /**
     * Update IMAP connection for external inbox
     * Update an inbox connector IMAP connection
     */
    updateConnectorImapConnectionRaw(requestParameters: UpdateConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ConnectorImapConnectionDto>>;
    /**
     * Update IMAP connection for external inbox
     * Update an inbox connector IMAP connection
     */
    updateConnectorImapConnection(requestParameters: UpdateConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<ConnectorImapConnectionDto>;
    /**
     * Update SMTP connection for external inbox
     * Update an inbox connector SMTP connection
     */
    updateConnectorSmtpConnectionRaw(requestParameters: UpdateConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ConnectorSmtpConnectionDto>>;
    /**
     * Update SMTP connection for external inbox
     * Update an inbox connector SMTP connection
     */
    updateConnectorSmtpConnection(requestParameters: UpdateConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<ConnectorSmtpConnectionDto>;
}
/**
 * @export
 * @enum {string}
 */
export declare enum GetAllConnectorEventsSortEnum {
    ASC = "ASC",
    DESC = "DESC"
}
/**
 * @export
 * @enum {string}
 */
export declare enum GetAllConnectorEventsEventTypeEnum {
    SEND = "SEND",
    SYNC = "SYNC"
}
/**
 * @export
 * @enum {string}
 */
export declare enum GetConnectorEventsSortEnum {
    ASC = "ASC",
    DESC = "DESC"
}
/**
 * @export
 * @enum {string}
 */
export declare enum GetConnectorEventsEventTypeEnum {
    SEND = "SEND",
    SYNC = "SYNC"
}
/**
 * @export
 * @enum {string}
 */
export declare enum GetConnectorsSortEnum {
    ASC = "ASC",
    DESC = "DESC"
}