/**
* 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 { DomainData } from '../ee-api-models';
import type { DomainDetail } from '../ee-api-models';
import type { DomainPayload } from '../ee-api-models';
import type { DomainUpdatePayload } from '../ee-api-models';
/**
* DomainsApi - axios parameter creator
* @export
*/
export declare const DomainsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Deletes configured domain from Account. Required Access Level: ModifySettings
* @summary Delete Domain
* @param {string} domain Name of the given domain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByDomainDelete: (domain: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Retrieve a domain configured for this Account. Required Access Level: ViewSettings
* @summary Load Domain
* @param {string} domain Name of the given domain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByDomainGet: (domain: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Updates the specified domain. Required Access Level: ModifySettings
* @summary Update Domain
* @param {string} domain Name of the given domain
* @param {DomainUpdatePayload} domainUpdatePayload Updated Domain resource
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByDomainPut: (domain: string, domainUpdatePayload: DomainUpdatePayload, options?: RawAxiosRequestConfig) => Promise;
/**
* Checking if domain is from free provider, or restricted. Required Access Level: ViewSettings
* @summary Check for domain restriction
* @param {string} domain Name of the given domain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByDomainRestrictedGet: (domain: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Verifies that required DNS records exist for specified domain. Required Access Level: ModifySettings
* @summary Verify Domain
* @param {string} domain Name of the given domain
* @param {string} body Tracking type used in the Tracking verification
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByDomainVerificationPut: (domain: string, body: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Sets a verified email address as default sender. Required Access Level: ModifySettings
* @summary Set Default
* @param {string} email Default email sender, example: mail@yourdomain.com
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByEmailDefaultPatch: (email: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns a list of all domains configured for this Account. Required Access Level: ViewSettings
* @summary Load Domains
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsGet: (options?: RawAxiosRequestConfig) => Promise;
/**
* Add new domain to Account. Required Access Level: ModifySettings
* @summary Add Domain
* @param {DomainPayload} domainPayload Domain to add
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsPost: (domainPayload: DomainPayload, options?: RawAxiosRequestConfig) => Promise;
};
/**
* DomainsApi - functional programming interface
* @export
*/
export declare const DomainsApiFp: (configuration?: Configuration) => {
/**
* Deletes configured domain from Account. Required Access Level: ModifySettings
* @summary Delete Domain
* @param {string} domain Name of the given domain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByDomainDelete(domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Retrieve a domain configured for this Account. Required Access Level: ViewSettings
* @summary Load Domain
* @param {string} domain Name of the given domain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByDomainGet(domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Updates the specified domain. Required Access Level: ModifySettings
* @summary Update Domain
* @param {string} domain Name of the given domain
* @param {DomainUpdatePayload} domainUpdatePayload Updated Domain resource
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByDomainPut(domain: string, domainUpdatePayload: DomainUpdatePayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Checking if domain is from free provider, or restricted. Required Access Level: ViewSettings
* @summary Check for domain restriction
* @param {string} domain Name of the given domain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByDomainRestrictedGet(domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Verifies that required DNS records exist for specified domain. Required Access Level: ModifySettings
* @summary Verify Domain
* @param {string} domain Name of the given domain
* @param {string} body Tracking type used in the Tracking verification
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByDomainVerificationPut(domain: string, body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Sets a verified email address as default sender. Required Access Level: ModifySettings
* @summary Set Default
* @param {string} email Default email sender, example: mail@yourdomain.com
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByEmailDefaultPatch(email: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns a list of all domains configured for this Account. Required Access Level: ViewSettings
* @summary Load Domains
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* Add new domain to Account. Required Access Level: ModifySettings
* @summary Add Domain
* @param {DomainPayload} domainPayload Domain to add
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsPost(domainPayload: DomainPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* DomainsApi - factory interface
* @export
*/
export declare const DomainsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Deletes configured domain from Account. Required Access Level: ModifySettings
* @summary Delete Domain
* @param {string} domain Name of the given domain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByDomainDelete(domain: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Retrieve a domain configured for this Account. Required Access Level: ViewSettings
* @summary Load Domain
* @param {string} domain Name of the given domain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByDomainGet(domain: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Updates the specified domain. Required Access Level: ModifySettings
* @summary Update Domain
* @param {string} domain Name of the given domain
* @param {DomainUpdatePayload} domainUpdatePayload Updated Domain resource
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByDomainPut(domain: string, domainUpdatePayload: DomainUpdatePayload, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Checking if domain is from free provider, or restricted. Required Access Level: ViewSettings
* @summary Check for domain restriction
* @param {string} domain Name of the given domain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByDomainRestrictedGet(domain: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Verifies that required DNS records exist for specified domain. Required Access Level: ModifySettings
* @summary Verify Domain
* @param {string} domain Name of the given domain
* @param {string} body Tracking type used in the Tracking verification
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByDomainVerificationPut(domain: string, body: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Sets a verified email address as default sender. Required Access Level: ModifySettings
* @summary Set Default
* @param {string} email Default email sender, example: mail@yourdomain.com
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsByEmailDefaultPatch(email: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns a list of all domains configured for this Account. Required Access Level: ViewSettings
* @summary Load Domains
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsGet(options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Add new domain to Account. Required Access Level: ModifySettings
* @summary Add Domain
* @param {DomainPayload} domainPayload Domain to add
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
domainsPost(domainPayload: DomainPayload, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* DomainsApi - interface
* @export
* @interface DomainsApi
*/
export interface DomainsApiInterface {
/**
* Deletes configured domain from Account. Required Access Level: ModifySettings
* @summary Delete Domain
* @param {string} domain Name of the given domain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DomainsApiInterface
*/
domainsByDomainDelete(domain: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Retrieve a domain configured for this Account. Required Access Level: ViewSettings
* @summary Load Domain
* @param {string} domain Name of the given domain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DomainsApiInterface
*/
domainsByDomainGet(domain: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Updates the specified domain. Required Access Level: ModifySettings
* @summary Update Domain
* @param {string} domain Name of the given domain
* @param {DomainUpdatePayload} domainUpdatePayload Updated Domain resource
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DomainsApiInterface
*/
domainsByDomainPut(domain: string, domainUpdatePayload: DomainUpdatePayload, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Checking if domain is from free provider, or restricted. Required Access Level: ViewSettings
* @summary Check for domain restriction
* @param {string} domain Name of the given domain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DomainsApiInterface
*/
domainsByDomainRestrictedGet(domain: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Verifies that required DNS records exist for specified domain. Required Access Level: ModifySettings
* @summary Verify Domain
* @param {string} domain Name of the given domain
* @param {string} body Tracking type used in the Tracking verification
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DomainsApiInterface
*/
domainsByDomainVerificationPut(domain: string, body: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Sets a verified email address as default sender. Required Access Level: ModifySettings
* @summary Set Default
* @param {string} email Default email sender, example: mail@yourdomain.com
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DomainsApiInterface
*/
domainsByEmailDefaultPatch(email: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns a list of all domains configured for this Account. Required Access Level: ViewSettings
* @summary Load Domains
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DomainsApiInterface
*/
domainsGet(options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Add new domain to Account. Required Access Level: ModifySettings
* @summary Add Domain
* @param {DomainPayload} domainPayload Domain to add
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DomainsApiInterface
*/
domainsPost(domainPayload: DomainPayload, options?: RawAxiosRequestConfig): AxiosPromise;
}
/**
* DomainsApi - object-oriented interface
* @export
* @class DomainsApi
* @extends {BaseAPI}
*/
export declare class DomainsApi extends BaseAPI implements DomainsApiInterface {
/**
* Deletes configured domain from Account. Required Access Level: ModifySettings
* @summary Delete Domain
* @param {string} domain Name of the given domain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DomainsApi
*/
domainsByDomainDelete(domain: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Retrieve a domain configured for this Account. Required Access Level: ViewSettings
* @summary Load Domain
* @param {string} domain Name of the given domain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DomainsApi
*/
domainsByDomainGet(domain: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Updates the specified domain. Required Access Level: ModifySettings
* @summary Update Domain
* @param {string} domain Name of the given domain
* @param {DomainUpdatePayload} domainUpdatePayload Updated Domain resource
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DomainsApi
*/
domainsByDomainPut(domain: string, domainUpdatePayload: DomainUpdatePayload, options?: RawAxiosRequestConfig): Promise>;
/**
* Checking if domain is from free provider, or restricted. Required Access Level: ViewSettings
* @summary Check for domain restriction
* @param {string} domain Name of the given domain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DomainsApi
*/
domainsByDomainRestrictedGet(domain: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Verifies that required DNS records exist for specified domain. Required Access Level: ModifySettings
* @summary Verify Domain
* @param {string} domain Name of the given domain
* @param {string} body Tracking type used in the Tracking verification
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DomainsApi
*/
domainsByDomainVerificationPut(domain: string, body: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Sets a verified email address as default sender. Required Access Level: ModifySettings
* @summary Set Default
* @param {string} email Default email sender, example: mail@yourdomain.com
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DomainsApi
*/
domainsByEmailDefaultPatch(email: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Returns a list of all domains configured for this Account. Required Access Level: ViewSettings
* @summary Load Domains
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DomainsApi
*/
domainsGet(options?: RawAxiosRequestConfig): Promise>;
/**
* Add new domain to Account. Required Access Level: ModifySettings
* @summary Add Domain
* @param {DomainPayload} domainPayload Domain to add
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DomainsApi
*/
domainsPost(domainPayload: DomainPayload, options?: RawAxiosRequestConfig): Promise>;
}