/**
* Elastic Email REST API
* This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available here). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository here
*
* The version of the OpenAPI document: 4.0.0
* Contact: support@elasticemail.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { InboundPayload } from '../ee-api-models';
import type { InboundRoute } from '../ee-api-models';
import type { SortOrderItem } from '../ee-api-models';
/**
* InboundRouteApi - axios parameter creator
* @export
*/
export declare const InboundRouteApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Deletes the Inbound Route. Required Access Level: ModifySettings
* @summary Delete Route
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundrouteByIdDelete: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Load an Inbound Route. Required Access Level: ViewSettings
* @summary Get Route
* @param {string} id ID number of your attachment
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundrouteByIdGet: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Update the Inbound Route. Required Access Level: ModifySettings
* @summary Update Route
* @param {string} id
* @param {InboundPayload} inboundPayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundrouteByIdPut: (id: string, inboundPayload: InboundPayload, options?: RawAxiosRequestConfig) => Promise;
/**
* Get all your Inbound Routes. Required Access Level: ViewSettings
* @summary Get Routes
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundrouteGet: (options?: RawAxiosRequestConfig) => Promise;
/**
* Required Access Level: ViewSettings
* @summary Update Sorting
* @param {Array} sortOrderItem Change the ordering of inbound routes for when matching the inbound
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundrouteOrderPut: (sortOrderItem: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* Create new Inbound Route. Required Access Level: ModifySettings
* @summary Create Route
* @param {InboundPayload} inboundPayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundroutePost: (inboundPayload: InboundPayload, options?: RawAxiosRequestConfig) => Promise;
};
/**
* InboundRouteApi - functional programming interface
* @export
*/
export declare const InboundRouteApiFp: (configuration?: Configuration) => {
/**
* Deletes the Inbound Route. Required Access Level: ModifySettings
* @summary Delete Route
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundrouteByIdDelete(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Load an Inbound Route. Required Access Level: ViewSettings
* @summary Get Route
* @param {string} id ID number of your attachment
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundrouteByIdGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Update the Inbound Route. Required Access Level: ModifySettings
* @summary Update Route
* @param {string} id
* @param {InboundPayload} inboundPayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundrouteByIdPut(id: string, inboundPayload: InboundPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get all your Inbound Routes. Required Access Level: ViewSettings
* @summary Get Routes
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundrouteGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* Required Access Level: ViewSettings
* @summary Update Sorting
* @param {Array} sortOrderItem Change the ordering of inbound routes for when matching the inbound
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundrouteOrderPut(sortOrderItem: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* Create new Inbound Route. Required Access Level: ModifySettings
* @summary Create Route
* @param {InboundPayload} inboundPayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundroutePost(inboundPayload: InboundPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* InboundRouteApi - factory interface
* @export
*/
export declare const InboundRouteApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Deletes the Inbound Route. Required Access Level: ModifySettings
* @summary Delete Route
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundrouteByIdDelete(id: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Load an Inbound Route. Required Access Level: ViewSettings
* @summary Get Route
* @param {string} id ID number of your attachment
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundrouteByIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Update the Inbound Route. Required Access Level: ModifySettings
* @summary Update Route
* @param {string} id
* @param {InboundPayload} inboundPayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundrouteByIdPut(id: string, inboundPayload: InboundPayload, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get all your Inbound Routes. Required Access Level: ViewSettings
* @summary Get Routes
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundrouteGet(options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Required Access Level: ViewSettings
* @summary Update Sorting
* @param {Array} sortOrderItem Change the ordering of inbound routes for when matching the inbound
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundrouteOrderPut(sortOrderItem: Array, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Create new Inbound Route. Required Access Level: ModifySettings
* @summary Create Route
* @param {InboundPayload} inboundPayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundroutePost(inboundPayload: InboundPayload, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* InboundRouteApi - interface
* @export
* @interface InboundRouteApi
*/
export interface InboundRouteApiInterface {
/**
* Deletes the Inbound Route. Required Access Level: ModifySettings
* @summary Delete Route
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InboundRouteApiInterface
*/
inboundrouteByIdDelete(id: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Load an Inbound Route. Required Access Level: ViewSettings
* @summary Get Route
* @param {string} id ID number of your attachment
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InboundRouteApiInterface
*/
inboundrouteByIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Update the Inbound Route. Required Access Level: ModifySettings
* @summary Update Route
* @param {string} id
* @param {InboundPayload} inboundPayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InboundRouteApiInterface
*/
inboundrouteByIdPut(id: string, inboundPayload: InboundPayload, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get all your Inbound Routes. Required Access Level: ViewSettings
* @summary Get Routes
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InboundRouteApiInterface
*/
inboundrouteGet(options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Required Access Level: ViewSettings
* @summary Update Sorting
* @param {Array} sortOrderItem Change the ordering of inbound routes for when matching the inbound
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InboundRouteApiInterface
*/
inboundrouteOrderPut(sortOrderItem: Array, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Create new Inbound Route. Required Access Level: ModifySettings
* @summary Create Route
* @param {InboundPayload} inboundPayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InboundRouteApiInterface
*/
inboundroutePost(inboundPayload: InboundPayload, options?: RawAxiosRequestConfig): AxiosPromise;
}
/**
* InboundRouteApi - object-oriented interface
* @export
* @class InboundRouteApi
* @extends {BaseAPI}
*/
export declare class InboundRouteApi extends BaseAPI implements InboundRouteApiInterface {
/**
* Deletes the Inbound Route. Required Access Level: ModifySettings
* @summary Delete Route
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InboundRouteApi
*/
inboundrouteByIdDelete(id: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Load an Inbound Route. Required Access Level: ViewSettings
* @summary Get Route
* @param {string} id ID number of your attachment
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InboundRouteApi
*/
inboundrouteByIdGet(id: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Update the Inbound Route. Required Access Level: ModifySettings
* @summary Update Route
* @param {string} id
* @param {InboundPayload} inboundPayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InboundRouteApi
*/
inboundrouteByIdPut(id: string, inboundPayload: InboundPayload, options?: RawAxiosRequestConfig): Promise>;
/**
* Get all your Inbound Routes. Required Access Level: ViewSettings
* @summary Get Routes
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InboundRouteApi
*/
inboundrouteGet(options?: RawAxiosRequestConfig): Promise>;
/**
* Required Access Level: ViewSettings
* @summary Update Sorting
* @param {Array} sortOrderItem Change the ordering of inbound routes for when matching the inbound
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InboundRouteApi
*/
inboundrouteOrderPut(sortOrderItem: Array, options?: RawAxiosRequestConfig): Promise>;
/**
* Create new Inbound Route. Required Access Level: ModifySettings
* @summary Create Route
* @param {InboundPayload} inboundPayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InboundRouteApi
*/
inboundroutePost(inboundPayload: InboundPayload, options?: RawAxiosRequestConfig): Promise>;
}