/**
* 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 { Template } from '../ee-api-models';
import type { TemplatePayload } from '../ee-api-models';
import type { TemplateScope } from '../ee-api-models';
import type { TemplateType } from '../ee-api-models';
/**
* TemplatesApi - axios parameter creator
* @export
*/
export declare const TemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Delete template with the specified name. Required Access Level: ModifyTemplates
* @summary Delete Template
* @param {string} name Name of template.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
templatesByNameDelete: (name: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Load detailed information of the specified template. Required Access Level: ViewTemplates
* @summary Load Template
* @param {string} name Name of template.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
templatesByNameGet: (name: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Update existing template, overwriting existing data. Required Access Level: ModifyTemplates
* @summary Update Template
* @param {string} name Name of template.
* @param {TemplatePayload} templatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
templatesByNamePut: (name: string, templatePayload: TemplatePayload, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns a list of templates for the specified type. Required Access Level: ViewTemplates
* @summary Load Templates
* @param {Array} scopeType Return templates with specified scope only
* @param {Array} [templateTypes] Return templates with specified type only
* @param {number} [limit] Maximum number of returned items.
* @param {number} [offset] How many items should be returned ahead.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
templatesGet: (scopeType: Array, templateTypes?: Array, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise;
/**
* Add a new Template. Required Access Level: ModifyTemplates
* @summary Add Template
* @param {TemplatePayload} templatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
templatesPost: (templatePayload: TemplatePayload, options?: RawAxiosRequestConfig) => Promise;
};
/**
* TemplatesApi - functional programming interface
* @export
*/
export declare const TemplatesApiFp: (configuration?: Configuration) => {
/**
* Delete template with the specified name. Required Access Level: ModifyTemplates
* @summary Delete Template
* @param {string} name Name of template.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
templatesByNameDelete(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Load detailed information of the specified template. Required Access Level: ViewTemplates
* @summary Load Template
* @param {string} name Name of template.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
templatesByNameGet(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Update existing template, overwriting existing data. Required Access Level: ModifyTemplates
* @summary Update Template
* @param {string} name Name of template.
* @param {TemplatePayload} templatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
templatesByNamePut(name: string, templatePayload: TemplatePayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns a list of templates for the specified type. Required Access Level: ViewTemplates
* @summary Load Templates
* @param {Array} scopeType Return templates with specified scope only
* @param {Array} [templateTypes] Return templates with specified type only
* @param {number} [limit] Maximum number of returned items.
* @param {number} [offset] How many items should be returned ahead.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
templatesGet(scopeType: Array, templateTypes?: Array, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* Add a new Template. Required Access Level: ModifyTemplates
* @summary Add Template
* @param {TemplatePayload} templatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
templatesPost(templatePayload: TemplatePayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* TemplatesApi - factory interface
* @export
*/
export declare const TemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Delete template with the specified name. Required Access Level: ModifyTemplates
* @summary Delete Template
* @param {string} name Name of template.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
templatesByNameDelete(name: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Load detailed information of the specified template. Required Access Level: ViewTemplates
* @summary Load Template
* @param {string} name Name of template.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
templatesByNameGet(name: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Update existing template, overwriting existing data. Required Access Level: ModifyTemplates
* @summary Update Template
* @param {string} name Name of template.
* @param {TemplatePayload} templatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
templatesByNamePut(name: string, templatePayload: TemplatePayload, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns a list of templates for the specified type. Required Access Level: ViewTemplates
* @summary Load Templates
* @param {Array} scopeType Return templates with specified scope only
* @param {Array} [templateTypes] Return templates with specified type only
* @param {number} [limit] Maximum number of returned items.
* @param {number} [offset] How many items should be returned ahead.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
templatesGet(scopeType: Array, templateTypes?: Array, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Add a new Template. Required Access Level: ModifyTemplates
* @summary Add Template
* @param {TemplatePayload} templatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
templatesPost(templatePayload: TemplatePayload, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* TemplatesApi - interface
* @export
* @interface TemplatesApi
*/
export interface TemplatesApiInterface {
/**
* Delete template with the specified name. Required Access Level: ModifyTemplates
* @summary Delete Template
* @param {string} name Name of template.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TemplatesApiInterface
*/
templatesByNameDelete(name: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Load detailed information of the specified template. Required Access Level: ViewTemplates
* @summary Load Template
* @param {string} name Name of template.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TemplatesApiInterface
*/
templatesByNameGet(name: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Update existing template, overwriting existing data. Required Access Level: ModifyTemplates
* @summary Update Template
* @param {string} name Name of template.
* @param {TemplatePayload} templatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TemplatesApiInterface
*/
templatesByNamePut(name: string, templatePayload: TemplatePayload, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns a list of templates for the specified type. Required Access Level: ViewTemplates
* @summary Load Templates
* @param {Array} scopeType Return templates with specified scope only
* @param {Array} [templateTypes] Return templates with specified type only
* @param {number} [limit] Maximum number of returned items.
* @param {number} [offset] How many items should be returned ahead.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TemplatesApiInterface
*/
templatesGet(scopeType: Array, templateTypes?: Array, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Add a new Template. Required Access Level: ModifyTemplates
* @summary Add Template
* @param {TemplatePayload} templatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TemplatesApiInterface
*/
templatesPost(templatePayload: TemplatePayload, options?: RawAxiosRequestConfig): AxiosPromise;
}
/**
* TemplatesApi - object-oriented interface
* @export
* @class TemplatesApi
* @extends {BaseAPI}
*/
export declare class TemplatesApi extends BaseAPI implements TemplatesApiInterface {
/**
* Delete template with the specified name. Required Access Level: ModifyTemplates
* @summary Delete Template
* @param {string} name Name of template.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TemplatesApi
*/
templatesByNameDelete(name: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Load detailed information of the specified template. Required Access Level: ViewTemplates
* @summary Load Template
* @param {string} name Name of template.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TemplatesApi
*/
templatesByNameGet(name: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Update existing template, overwriting existing data. Required Access Level: ModifyTemplates
* @summary Update Template
* @param {string} name Name of template.
* @param {TemplatePayload} templatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TemplatesApi
*/
templatesByNamePut(name: string, templatePayload: TemplatePayload, options?: RawAxiosRequestConfig): Promise>;
/**
* Returns a list of templates for the specified type. Required Access Level: ViewTemplates
* @summary Load Templates
* @param {Array} scopeType Return templates with specified scope only
* @param {Array} [templateTypes] Return templates with specified type only
* @param {number} [limit] Maximum number of returned items.
* @param {number} [offset] How many items should be returned ahead.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TemplatesApi
*/
templatesGet(scopeType: Array, templateTypes?: Array, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise>;
/**
* Add a new Template. Required Access Level: ModifyTemplates
* @summary Add Template
* @param {TemplatePayload} templatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TemplatesApi
*/
templatesPost(templatePayload: TemplatePayload, options?: RawAxiosRequestConfig): Promise>;
}