/** * 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 { ApiKey } from '../ee-api-models'; import type { ApiKeyPayload } from '../ee-api-models'; import type { NewApiKey } from '../ee-api-models'; import type { NewSmtpCredentials } from '../ee-api-models'; import type { SmtpCredentials } from '../ee-api-models'; import type { SmtpCredentialsPayload } from '../ee-api-models'; /** * SecurityApi - axios parameter creator * @export */ export declare const SecurityApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete your existing ApiKey. Required Access Level: ModifyAccessTokens * @summary Delete ApiKey * @param {string} name Name of the ApiKey * @param {string} [subaccount] Email of the subaccount of which ApiKey should be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} */ securityApikeysByNameDelete: (name: string, subaccount?: string, options?: RawAxiosRequestConfig) => Promise; /** * Load your existing ApiKey info. Required Access Level: ViewAccessTokens * @summary Load ApiKey * @param {string} name Name of the ApiKey * @param {string} [subaccount] Email of the subaccount of which ApiKey should be loaded. The default API key created for the subaccount has a 48-hour expiration period. * @param {*} [options] Override http request option. * @throws {RequiredError} */ securityApikeysByNameGet: (name: string, subaccount?: string, options?: RawAxiosRequestConfig) => Promise; /** * Update your existing ApiKey. Required Access Level: ModifyAccessTokens * @summary Update ApiKey * @param {string} name Name of the ApiKey * @param {ApiKeyPayload} apiKeyPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ securityApikeysByNamePut: (name: string, apiKeyPayload: ApiKeyPayload, options?: RawAxiosRequestConfig) => Promise; /** * List all your existing ApiKeys. Required Access Level: ViewAccessTokens * @summary List ApiKeys * @param {string} [subaccount] Email of the subaccount of which ApiKeys should be loaded. The default API key created for the subaccount has a 48-hour expiration period. * @param {*} [options] Override http request option. * @throws {RequiredError} */ securityApikeysGet: (subaccount?: string, options?: RawAxiosRequestConfig) => Promise; /** * Add a new ApiKey. Required Access Level: ModifyAccessTokens * @summary Add ApiKey * @param {ApiKeyPayload} apiKeyPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ securityApikeysPost: (apiKeyPayload: ApiKeyPayload, options?: RawAxiosRequestConfig) => Promise; /** * Delete your existing SMTP Credentials. Required Access Level: ModifyAccessTokens * @summary Delete SMTP Credential * @param {string} name Name of the SMTP Credential * @param {string} [subaccount] Email of the subaccount of which credential should be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} */ securitySmtpByNameDelete: (name: string, subaccount?: string, options?: RawAxiosRequestConfig) => Promise; /** * Load your existing SMTP Credential info. Required Access Level: ViewAccessTokens * @summary Load SMTP Credential * @param {string} name Name of the SMTP Credential * @param {string} [subaccount] Email of the subaccount of which credential should be loaded * @param {*} [options] Override http request option. * @throws {RequiredError} */ securitySmtpByNameGet: (name: string, subaccount?: string, options?: RawAxiosRequestConfig) => Promise; /** * Update your existing SMTP Credentials. Required Access Level: ModifyAccessTokens * @summary Update SMTP Credential * @param {string} name Name of the SMTP Credential * @param {SmtpCredentialsPayload} smtpCredentialsPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ securitySmtpByNamePut: (name: string, smtpCredentialsPayload: SmtpCredentialsPayload, options?: RawAxiosRequestConfig) => Promise; /** * List all your existing SMTP Credentials. Required Access Level: ViewAccessTokens * @summary List SMTP Credentials * @param {string} [subaccount] Email of the subaccount of which credentials should be listed * @param {*} [options] Override http request option. * @throws {RequiredError} */ securitySmtpGet: (subaccount?: string, options?: RawAxiosRequestConfig) => Promise; /** * Add new SMTP Credential. Required Access Level: ModifyAccessTokens * @summary Add SMTP Credential * @param {SmtpCredentialsPayload} smtpCredentialsPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ securitySmtpPost: (smtpCredentialsPayload: SmtpCredentialsPayload, options?: RawAxiosRequestConfig) => Promise; }; /** * SecurityApi - functional programming interface * @export */ export declare const SecurityApiFp: (configuration?: Configuration) => { /** * Delete your existing ApiKey. Required Access Level: ModifyAccessTokens * @summary Delete ApiKey * @param {string} name Name of the ApiKey * @param {string} [subaccount] Email of the subaccount of which ApiKey should be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} */ securityApikeysByNameDelete(name: string, subaccount?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Load your existing ApiKey info. Required Access Level: ViewAccessTokens * @summary Load ApiKey * @param {string} name Name of the ApiKey * @param {string} [subaccount] Email of the subaccount of which ApiKey should be loaded. The default API key created for the subaccount has a 48-hour expiration period. * @param {*} [options] Override http request option. * @throws {RequiredError} */ securityApikeysByNameGet(name: string, subaccount?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update your existing ApiKey. Required Access Level: ModifyAccessTokens * @summary Update ApiKey * @param {string} name Name of the ApiKey * @param {ApiKeyPayload} apiKeyPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ securityApikeysByNamePut(name: string, apiKeyPayload: ApiKeyPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List all your existing ApiKeys. Required Access Level: ViewAccessTokens * @summary List ApiKeys * @param {string} [subaccount] Email of the subaccount of which ApiKeys should be loaded. The default API key created for the subaccount has a 48-hour expiration period. * @param {*} [options] Override http request option. * @throws {RequiredError} */ securityApikeysGet(subaccount?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Add a new ApiKey. Required Access Level: ModifyAccessTokens * @summary Add ApiKey * @param {ApiKeyPayload} apiKeyPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ securityApikeysPost(apiKeyPayload: ApiKeyPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete your existing SMTP Credentials. Required Access Level: ModifyAccessTokens * @summary Delete SMTP Credential * @param {string} name Name of the SMTP Credential * @param {string} [subaccount] Email of the subaccount of which credential should be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} */ securitySmtpByNameDelete(name: string, subaccount?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Load your existing SMTP Credential info. Required Access Level: ViewAccessTokens * @summary Load SMTP Credential * @param {string} name Name of the SMTP Credential * @param {string} [subaccount] Email of the subaccount of which credential should be loaded * @param {*} [options] Override http request option. * @throws {RequiredError} */ securitySmtpByNameGet(name: string, subaccount?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update your existing SMTP Credentials. Required Access Level: ModifyAccessTokens * @summary Update SMTP Credential * @param {string} name Name of the SMTP Credential * @param {SmtpCredentialsPayload} smtpCredentialsPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ securitySmtpByNamePut(name: string, smtpCredentialsPayload: SmtpCredentialsPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List all your existing SMTP Credentials. Required Access Level: ViewAccessTokens * @summary List SMTP Credentials * @param {string} [subaccount] Email of the subaccount of which credentials should be listed * @param {*} [options] Override http request option. * @throws {RequiredError} */ securitySmtpGet(subaccount?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Add new SMTP Credential. Required Access Level: ModifyAccessTokens * @summary Add SMTP Credential * @param {SmtpCredentialsPayload} smtpCredentialsPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ securitySmtpPost(smtpCredentialsPayload: SmtpCredentialsPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SecurityApi - factory interface * @export */ export declare const SecurityApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete your existing ApiKey. Required Access Level: ModifyAccessTokens * @summary Delete ApiKey * @param {string} name Name of the ApiKey * @param {string} [subaccount] Email of the subaccount of which ApiKey should be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} */ securityApikeysByNameDelete(name: string, subaccount?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Load your existing ApiKey info. Required Access Level: ViewAccessTokens * @summary Load ApiKey * @param {string} name Name of the ApiKey * @param {string} [subaccount] Email of the subaccount of which ApiKey should be loaded. The default API key created for the subaccount has a 48-hour expiration period. * @param {*} [options] Override http request option. * @throws {RequiredError} */ securityApikeysByNameGet(name: string, subaccount?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update your existing ApiKey. Required Access Level: ModifyAccessTokens * @summary Update ApiKey * @param {string} name Name of the ApiKey * @param {ApiKeyPayload} apiKeyPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ securityApikeysByNamePut(name: string, apiKeyPayload: ApiKeyPayload, options?: RawAxiosRequestConfig): AxiosPromise; /** * List all your existing ApiKeys. Required Access Level: ViewAccessTokens * @summary List ApiKeys * @param {string} [subaccount] Email of the subaccount of which ApiKeys should be loaded. The default API key created for the subaccount has a 48-hour expiration period. * @param {*} [options] Override http request option. * @throws {RequiredError} */ securityApikeysGet(subaccount?: string, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Add a new ApiKey. Required Access Level: ModifyAccessTokens * @summary Add ApiKey * @param {ApiKeyPayload} apiKeyPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ securityApikeysPost(apiKeyPayload: ApiKeyPayload, options?: RawAxiosRequestConfig): AxiosPromise; /** * Delete your existing SMTP Credentials. Required Access Level: ModifyAccessTokens * @summary Delete SMTP Credential * @param {string} name Name of the SMTP Credential * @param {string} [subaccount] Email of the subaccount of which credential should be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} */ securitySmtpByNameDelete(name: string, subaccount?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Load your existing SMTP Credential info. Required Access Level: ViewAccessTokens * @summary Load SMTP Credential * @param {string} name Name of the SMTP Credential * @param {string} [subaccount] Email of the subaccount of which credential should be loaded * @param {*} [options] Override http request option. * @throws {RequiredError} */ securitySmtpByNameGet(name: string, subaccount?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update your existing SMTP Credentials. Required Access Level: ModifyAccessTokens * @summary Update SMTP Credential * @param {string} name Name of the SMTP Credential * @param {SmtpCredentialsPayload} smtpCredentialsPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ securitySmtpByNamePut(name: string, smtpCredentialsPayload: SmtpCredentialsPayload, options?: RawAxiosRequestConfig): AxiosPromise; /** * List all your existing SMTP Credentials. Required Access Level: ViewAccessTokens * @summary List SMTP Credentials * @param {string} [subaccount] Email of the subaccount of which credentials should be listed * @param {*} [options] Override http request option. * @throws {RequiredError} */ securitySmtpGet(subaccount?: string, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Add new SMTP Credential. Required Access Level: ModifyAccessTokens * @summary Add SMTP Credential * @param {SmtpCredentialsPayload} smtpCredentialsPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ securitySmtpPost(smtpCredentialsPayload: SmtpCredentialsPayload, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * SecurityApi - interface * @export * @interface SecurityApi */ export interface SecurityApiInterface { /** * Delete your existing ApiKey. Required Access Level: ModifyAccessTokens * @summary Delete ApiKey * @param {string} name Name of the ApiKey * @param {string} [subaccount] Email of the subaccount of which ApiKey should be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApiInterface */ securityApikeysByNameDelete(name: string, subaccount?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Load your existing ApiKey info. Required Access Level: ViewAccessTokens * @summary Load ApiKey * @param {string} name Name of the ApiKey * @param {string} [subaccount] Email of the subaccount of which ApiKey should be loaded. The default API key created for the subaccount has a 48-hour expiration period. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApiInterface */ securityApikeysByNameGet(name: string, subaccount?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update your existing ApiKey. Required Access Level: ModifyAccessTokens * @summary Update ApiKey * @param {string} name Name of the ApiKey * @param {ApiKeyPayload} apiKeyPayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApiInterface */ securityApikeysByNamePut(name: string, apiKeyPayload: ApiKeyPayload, options?: RawAxiosRequestConfig): AxiosPromise; /** * List all your existing ApiKeys. Required Access Level: ViewAccessTokens * @summary List ApiKeys * @param {string} [subaccount] Email of the subaccount of which ApiKeys should be loaded. The default API key created for the subaccount has a 48-hour expiration period. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApiInterface */ securityApikeysGet(subaccount?: string, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Add a new ApiKey. Required Access Level: ModifyAccessTokens * @summary Add ApiKey * @param {ApiKeyPayload} apiKeyPayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApiInterface */ securityApikeysPost(apiKeyPayload: ApiKeyPayload, options?: RawAxiosRequestConfig): AxiosPromise; /** * Delete your existing SMTP Credentials. Required Access Level: ModifyAccessTokens * @summary Delete SMTP Credential * @param {string} name Name of the SMTP Credential * @param {string} [subaccount] Email of the subaccount of which credential should be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApiInterface */ securitySmtpByNameDelete(name: string, subaccount?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Load your existing SMTP Credential info. Required Access Level: ViewAccessTokens * @summary Load SMTP Credential * @param {string} name Name of the SMTP Credential * @param {string} [subaccount] Email of the subaccount of which credential should be loaded * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApiInterface */ securitySmtpByNameGet(name: string, subaccount?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update your existing SMTP Credentials. Required Access Level: ModifyAccessTokens * @summary Update SMTP Credential * @param {string} name Name of the SMTP Credential * @param {SmtpCredentialsPayload} smtpCredentialsPayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApiInterface */ securitySmtpByNamePut(name: string, smtpCredentialsPayload: SmtpCredentialsPayload, options?: RawAxiosRequestConfig): AxiosPromise; /** * List all your existing SMTP Credentials. Required Access Level: ViewAccessTokens * @summary List SMTP Credentials * @param {string} [subaccount] Email of the subaccount of which credentials should be listed * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApiInterface */ securitySmtpGet(subaccount?: string, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Add new SMTP Credential. Required Access Level: ModifyAccessTokens * @summary Add SMTP Credential * @param {SmtpCredentialsPayload} smtpCredentialsPayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApiInterface */ securitySmtpPost(smtpCredentialsPayload: SmtpCredentialsPayload, options?: RawAxiosRequestConfig): AxiosPromise; } /** * SecurityApi - object-oriented interface * @export * @class SecurityApi * @extends {BaseAPI} */ export declare class SecurityApi extends BaseAPI implements SecurityApiInterface { /** * Delete your existing ApiKey. Required Access Level: ModifyAccessTokens * @summary Delete ApiKey * @param {string} name Name of the ApiKey * @param {string} [subaccount] Email of the subaccount of which ApiKey should be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApi */ securityApikeysByNameDelete(name: string, subaccount?: string, options?: RawAxiosRequestConfig): Promise>; /** * Load your existing ApiKey info. Required Access Level: ViewAccessTokens * @summary Load ApiKey * @param {string} name Name of the ApiKey * @param {string} [subaccount] Email of the subaccount of which ApiKey should be loaded. The default API key created for the subaccount has a 48-hour expiration period. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApi */ securityApikeysByNameGet(name: string, subaccount?: string, options?: RawAxiosRequestConfig): Promise>; /** * Update your existing ApiKey. Required Access Level: ModifyAccessTokens * @summary Update ApiKey * @param {string} name Name of the ApiKey * @param {ApiKeyPayload} apiKeyPayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApi */ securityApikeysByNamePut(name: string, apiKeyPayload: ApiKeyPayload, options?: RawAxiosRequestConfig): Promise>; /** * List all your existing ApiKeys. Required Access Level: ViewAccessTokens * @summary List ApiKeys * @param {string} [subaccount] Email of the subaccount of which ApiKeys should be loaded. The default API key created for the subaccount has a 48-hour expiration period. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApi */ securityApikeysGet(subaccount?: string, options?: RawAxiosRequestConfig): Promise>; /** * Add a new ApiKey. Required Access Level: ModifyAccessTokens * @summary Add ApiKey * @param {ApiKeyPayload} apiKeyPayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApi */ securityApikeysPost(apiKeyPayload: ApiKeyPayload, options?: RawAxiosRequestConfig): Promise>; /** * Delete your existing SMTP Credentials. Required Access Level: ModifyAccessTokens * @summary Delete SMTP Credential * @param {string} name Name of the SMTP Credential * @param {string} [subaccount] Email of the subaccount of which credential should be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApi */ securitySmtpByNameDelete(name: string, subaccount?: string, options?: RawAxiosRequestConfig): Promise>; /** * Load your existing SMTP Credential info. Required Access Level: ViewAccessTokens * @summary Load SMTP Credential * @param {string} name Name of the SMTP Credential * @param {string} [subaccount] Email of the subaccount of which credential should be loaded * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApi */ securitySmtpByNameGet(name: string, subaccount?: string, options?: RawAxiosRequestConfig): Promise>; /** * Update your existing SMTP Credentials. Required Access Level: ModifyAccessTokens * @summary Update SMTP Credential * @param {string} name Name of the SMTP Credential * @param {SmtpCredentialsPayload} smtpCredentialsPayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApi */ securitySmtpByNamePut(name: string, smtpCredentialsPayload: SmtpCredentialsPayload, options?: RawAxiosRequestConfig): Promise>; /** * List all your existing SMTP Credentials. Required Access Level: ViewAccessTokens * @summary List SMTP Credentials * @param {string} [subaccount] Email of the subaccount of which credentials should be listed * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApi */ securitySmtpGet(subaccount?: string, options?: RawAxiosRequestConfig): Promise>; /** * Add new SMTP Credential. Required Access Level: ModifyAccessTokens * @summary Add SMTP Credential * @param {SmtpCredentialsPayload} smtpCredentialsPayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityApi */ securitySmtpPost(smtpCredentialsPayload: SmtpCredentialsPayload, options?: RawAxiosRequestConfig): Promise>; }