/**
* 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 { SubAccountInfo } from '../ee-api-models';
import type { SubaccountEmailCreditsPayload } from '../ee-api-models';
import type { SubaccountEmailSettings } from '../ee-api-models';
import type { SubaccountPayload } from '../ee-api-models';
/**
* SubAccountsApi - axios parameter creator
* @export
*/
export declare const SubAccountsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Returns API key token for the specified SubAccount. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
* @summary Get SubAccount ApiKey
* @param {string} email Email address of Sub-Account
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsByEmailApikeyGet: (email: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Update email credits of a subaccount by the given amount. Required Access Level: ModifySubAccounts
* @summary Add, Subtract Email Credits
* @param {string} email Email address of Sub-Account
* @param {SubaccountEmailCreditsPayload} subaccountEmailCreditsPayload Amount of email credits to add or subtract from the current SubAccount email credits pool (positive or negative value)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsByEmailCreditsPatch: (email: string, subaccountEmailCreditsPayload: SubaccountEmailCreditsPayload, options?: RawAxiosRequestConfig) => Promise;
/**
* Deletes specified SubAccount. An email will be sent to confirm this change. Required Access Level: ModifySubAccounts
* @summary Delete SubAccount
* @param {string} email Email address of Sub-Account
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsByEmailDelete: (email: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns details for the specified SubAccount. Required Access Level: ViewSubAccounts
* @summary Load SubAccount
* @param {string} email Email address of Sub-Account
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsByEmailGet: (email: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Update SubAccount email settings. Required Access Level: ModifySubAccounts
* @summary Update SubAccount Email Settings
* @param {string} email
* @param {SubaccountEmailSettings} subaccountEmailSettings Updated Email Settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsByEmailSettingsEmailPut: (email: string, subaccountEmailSettings: SubaccountEmailSettings, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns a list of all your SubAccounts. Required Access Level: ViewSubAccounts
* @summary Load SubAccounts
* @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}
*/
subaccountsGet: (limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise;
/**
* Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the \'subaccount\' parameter. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
* @summary Add SubAccount
* @param {SubaccountPayload} subaccountPayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsPost: (subaccountPayload: SubaccountPayload, options?: RawAxiosRequestConfig) => Promise;
};
/**
* SubAccountsApi - functional programming interface
* @export
*/
export declare const SubAccountsApiFp: (configuration?: Configuration) => {
/**
* Returns API key token for the specified SubAccount. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
* @summary Get SubAccount ApiKey
* @param {string} email Email address of Sub-Account
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsByEmailApikeyGet(email: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Update email credits of a subaccount by the given amount. Required Access Level: ModifySubAccounts
* @summary Add, Subtract Email Credits
* @param {string} email Email address of Sub-Account
* @param {SubaccountEmailCreditsPayload} subaccountEmailCreditsPayload Amount of email credits to add or subtract from the current SubAccount email credits pool (positive or negative value)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsByEmailCreditsPatch(email: string, subaccountEmailCreditsPayload: SubaccountEmailCreditsPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Deletes specified SubAccount. An email will be sent to confirm this change. Required Access Level: ModifySubAccounts
* @summary Delete SubAccount
* @param {string} email Email address of Sub-Account
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsByEmailDelete(email: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns details for the specified SubAccount. Required Access Level: ViewSubAccounts
* @summary Load SubAccount
* @param {string} email Email address of Sub-Account
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsByEmailGet(email: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Update SubAccount email settings. Required Access Level: ModifySubAccounts
* @summary Update SubAccount Email Settings
* @param {string} email
* @param {SubaccountEmailSettings} subaccountEmailSettings Updated Email Settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsByEmailSettingsEmailPut(email: string, subaccountEmailSettings: SubaccountEmailSettings, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns a list of all your SubAccounts. Required Access Level: ViewSubAccounts
* @summary Load SubAccounts
* @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}
*/
subaccountsGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the \'subaccount\' parameter. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
* @summary Add SubAccount
* @param {SubaccountPayload} subaccountPayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsPost(subaccountPayload: SubaccountPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* SubAccountsApi - factory interface
* @export
*/
export declare const SubAccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Returns API key token for the specified SubAccount. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
* @summary Get SubAccount ApiKey
* @param {string} email Email address of Sub-Account
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsByEmailApikeyGet(email: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Update email credits of a subaccount by the given amount. Required Access Level: ModifySubAccounts
* @summary Add, Subtract Email Credits
* @param {string} email Email address of Sub-Account
* @param {SubaccountEmailCreditsPayload} subaccountEmailCreditsPayload Amount of email credits to add or subtract from the current SubAccount email credits pool (positive or negative value)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsByEmailCreditsPatch(email: string, subaccountEmailCreditsPayload: SubaccountEmailCreditsPayload, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Deletes specified SubAccount. An email will be sent to confirm this change. Required Access Level: ModifySubAccounts
* @summary Delete SubAccount
* @param {string} email Email address of Sub-Account
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsByEmailDelete(email: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns details for the specified SubAccount. Required Access Level: ViewSubAccounts
* @summary Load SubAccount
* @param {string} email Email address of Sub-Account
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsByEmailGet(email: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Update SubAccount email settings. Required Access Level: ModifySubAccounts
* @summary Update SubAccount Email Settings
* @param {string} email
* @param {SubaccountEmailSettings} subaccountEmailSettings Updated Email Settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsByEmailSettingsEmailPut(email: string, subaccountEmailSettings: SubaccountEmailSettings, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns a list of all your SubAccounts. Required Access Level: ViewSubAccounts
* @summary Load SubAccounts
* @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}
*/
subaccountsGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the \'subaccount\' parameter. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
* @summary Add SubAccount
* @param {SubaccountPayload} subaccountPayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
subaccountsPost(subaccountPayload: SubaccountPayload, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* SubAccountsApi - interface
* @export
* @interface SubAccountsApi
*/
export interface SubAccountsApiInterface {
/**
* Returns API key token for the specified SubAccount. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
* @summary Get SubAccount ApiKey
* @param {string} email Email address of Sub-Account
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubAccountsApiInterface
*/
subaccountsByEmailApikeyGet(email: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Update email credits of a subaccount by the given amount. Required Access Level: ModifySubAccounts
* @summary Add, Subtract Email Credits
* @param {string} email Email address of Sub-Account
* @param {SubaccountEmailCreditsPayload} subaccountEmailCreditsPayload Amount of email credits to add or subtract from the current SubAccount email credits pool (positive or negative value)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubAccountsApiInterface
*/
subaccountsByEmailCreditsPatch(email: string, subaccountEmailCreditsPayload: SubaccountEmailCreditsPayload, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Deletes specified SubAccount. An email will be sent to confirm this change. Required Access Level: ModifySubAccounts
* @summary Delete SubAccount
* @param {string} email Email address of Sub-Account
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubAccountsApiInterface
*/
subaccountsByEmailDelete(email: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns details for the specified SubAccount. Required Access Level: ViewSubAccounts
* @summary Load SubAccount
* @param {string} email Email address of Sub-Account
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubAccountsApiInterface
*/
subaccountsByEmailGet(email: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Update SubAccount email settings. Required Access Level: ModifySubAccounts
* @summary Update SubAccount Email Settings
* @param {string} email
* @param {SubaccountEmailSettings} subaccountEmailSettings Updated Email Settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubAccountsApiInterface
*/
subaccountsByEmailSettingsEmailPut(email: string, subaccountEmailSettings: SubaccountEmailSettings, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns a list of all your SubAccounts. Required Access Level: ViewSubAccounts
* @summary Load SubAccounts
* @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 SubAccountsApiInterface
*/
subaccountsGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the \'subaccount\' parameter. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
* @summary Add SubAccount
* @param {SubaccountPayload} subaccountPayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubAccountsApiInterface
*/
subaccountsPost(subaccountPayload: SubaccountPayload, options?: RawAxiosRequestConfig): AxiosPromise;
}
/**
* SubAccountsApi - object-oriented interface
* @export
* @class SubAccountsApi
* @extends {BaseAPI}
*/
export declare class SubAccountsApi extends BaseAPI implements SubAccountsApiInterface {
/**
* Returns API key token for the specified SubAccount. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
* @summary Get SubAccount ApiKey
* @param {string} email Email address of Sub-Account
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubAccountsApi
*/
subaccountsByEmailApikeyGet(email: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Update email credits of a subaccount by the given amount. Required Access Level: ModifySubAccounts
* @summary Add, Subtract Email Credits
* @param {string} email Email address of Sub-Account
* @param {SubaccountEmailCreditsPayload} subaccountEmailCreditsPayload Amount of email credits to add or subtract from the current SubAccount email credits pool (positive or negative value)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubAccountsApi
*/
subaccountsByEmailCreditsPatch(email: string, subaccountEmailCreditsPayload: SubaccountEmailCreditsPayload, options?: RawAxiosRequestConfig): Promise>;
/**
* Deletes specified SubAccount. An email will be sent to confirm this change. Required Access Level: ModifySubAccounts
* @summary Delete SubAccount
* @param {string} email Email address of Sub-Account
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubAccountsApi
*/
subaccountsByEmailDelete(email: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Returns details for the specified SubAccount. Required Access Level: ViewSubAccounts
* @summary Load SubAccount
* @param {string} email Email address of Sub-Account
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubAccountsApi
*/
subaccountsByEmailGet(email: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Update SubAccount email settings. Required Access Level: ModifySubAccounts
* @summary Update SubAccount Email Settings
* @param {string} email
* @param {SubaccountEmailSettings} subaccountEmailSettings Updated Email Settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubAccountsApi
*/
subaccountsByEmailSettingsEmailPut(email: string, subaccountEmailSettings: SubaccountEmailSettings, options?: RawAxiosRequestConfig): Promise>;
/**
* Returns a list of all your SubAccounts. Required Access Level: ViewSubAccounts
* @summary Load SubAccounts
* @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 SubAccountsApi
*/
subaccountsGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise>;
/**
* Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the \'subaccount\' parameter. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
* @summary Add SubAccount
* @param {SubaccountPayload} subaccountPayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubAccountsApi
*/
subaccountsPost(subaccountPayload: SubaccountPayload, options?: RawAxiosRequestConfig): Promise>;
}