/**
* 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 { EmailData } from '../ee-api-models';
import type { EmailJobStatus } from '../ee-api-models';
import type { EmailMessageData } from '../ee-api-models';
import type { EmailSend } from '../ee-api-models';
import type { EmailTransactionalMessageData } from '../ee-api-models';
import type { MergeEmailPayload } from '../ee-api-models';
/**
* EmailsApi - axios parameter creator
* @export
*/
export declare const EmailsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Returns email details for viewing or rendering. Required Access Level: None
* @summary View Email
* @param {string} msgid Message identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
emailsByMsgidViewGet: (msgid: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Get status details of an email transaction. Required Access Level: ViewReports
* @summary Get Status
* @param {string} transactionid Transaction identifier
* @param {boolean} [showFailed] Include Bounced email addresses.
* @param {boolean} [showSent] Include Sent email addresses.
* @param {boolean} [showDelivered] Include all delivered email addresses.
* @param {boolean} [showPending] Include Ready to send email addresses.
* @param {boolean} [showOpened] Include Opened email addresses.
* @param {boolean} [showClicked] Include Clicked email addresses.
* @param {boolean} [showAbuse] Include Reported as abuse email addresses.
* @param {boolean} [showUnsubscribed] Include Unsubscribed email addresses.
* @param {boolean} [showErrors] Include error messages for bounced emails.
* @param {boolean} [showMessageIDs] Include all MessageIDs for this transaction
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
emailsByTransactionidStatusGet: (transactionid: string, showFailed?: boolean, showSent?: boolean, showDelivered?: boolean, showPending?: boolean, showOpened?: boolean, showClicked?: boolean, showAbuse?: boolean, showUnsubscribed?: boolean, showErrors?: boolean, showMessageIDs?: boolean, options?: RawAxiosRequestConfig) => Promise;
/**
* Send to a list of contacts submitted in a CSV data file. The first column in the CSV must be the email address and the CSV must contain a header row. Additional fields can be included with a named header row and can be merged with the template using {merge} tags in the content. Example CSV: email, firstname, lastname test1@gmail.com, michael, smith test2@gmail.com, janet, smith Merge file must not be empty. Required Access Level: SendHttp
* @summary Send Bulk Emails CSV
* @param {MergeEmailPayload} mergeEmailPayload Email data
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
emailsMergefilePost: (mergeEmailPayload: MergeEmailPayload, options?: RawAxiosRequestConfig) => Promise;
/**
* Send bulk merge email. Required Access Level: SendHttp
* @summary Send Bulk Emails
* @param {EmailMessageData} emailMessageData Email data
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
emailsPost: (emailMessageData: EmailMessageData, options?: RawAxiosRequestConfig) => Promise;
/**
* Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp
* @summary Send Transactional Email
* @param {EmailTransactionalMessageData} emailTransactionalMessageData Email data
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
emailsTransactionalPost: (emailTransactionalMessageData: EmailTransactionalMessageData, options?: RawAxiosRequestConfig) => Promise;
};
/**
* EmailsApi - functional programming interface
* @export
*/
export declare const EmailsApiFp: (configuration?: Configuration) => {
/**
* Returns email details for viewing or rendering. Required Access Level: None
* @summary View Email
* @param {string} msgid Message identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
emailsByMsgidViewGet(msgid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get status details of an email transaction. Required Access Level: ViewReports
* @summary Get Status
* @param {string} transactionid Transaction identifier
* @param {boolean} [showFailed] Include Bounced email addresses.
* @param {boolean} [showSent] Include Sent email addresses.
* @param {boolean} [showDelivered] Include all delivered email addresses.
* @param {boolean} [showPending] Include Ready to send email addresses.
* @param {boolean} [showOpened] Include Opened email addresses.
* @param {boolean} [showClicked] Include Clicked email addresses.
* @param {boolean} [showAbuse] Include Reported as abuse email addresses.
* @param {boolean} [showUnsubscribed] Include Unsubscribed email addresses.
* @param {boolean} [showErrors] Include error messages for bounced emails.
* @param {boolean} [showMessageIDs] Include all MessageIDs for this transaction
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
emailsByTransactionidStatusGet(transactionid: string, showFailed?: boolean, showSent?: boolean, showDelivered?: boolean, showPending?: boolean, showOpened?: boolean, showClicked?: boolean, showAbuse?: boolean, showUnsubscribed?: boolean, showErrors?: boolean, showMessageIDs?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Send to a list of contacts submitted in a CSV data file. The first column in the CSV must be the email address and the CSV must contain a header row. Additional fields can be included with a named header row and can be merged with the template using {merge} tags in the content. Example CSV: email, firstname, lastname test1@gmail.com, michael, smith test2@gmail.com, janet, smith Merge file must not be empty. Required Access Level: SendHttp
* @summary Send Bulk Emails CSV
* @param {MergeEmailPayload} mergeEmailPayload Email data
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
emailsMergefilePost(mergeEmailPayload: MergeEmailPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Send bulk merge email. Required Access Level: SendHttp
* @summary Send Bulk Emails
* @param {EmailMessageData} emailMessageData Email data
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
emailsPost(emailMessageData: EmailMessageData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp
* @summary Send Transactional Email
* @param {EmailTransactionalMessageData} emailTransactionalMessageData Email data
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
emailsTransactionalPost(emailTransactionalMessageData: EmailTransactionalMessageData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* EmailsApi - factory interface
* @export
*/
export declare const EmailsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Returns email details for viewing or rendering. Required Access Level: None
* @summary View Email
* @param {string} msgid Message identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
emailsByMsgidViewGet(msgid: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get status details of an email transaction. Required Access Level: ViewReports
* @summary Get Status
* @param {string} transactionid Transaction identifier
* @param {boolean} [showFailed] Include Bounced email addresses.
* @param {boolean} [showSent] Include Sent email addresses.
* @param {boolean} [showDelivered] Include all delivered email addresses.
* @param {boolean} [showPending] Include Ready to send email addresses.
* @param {boolean} [showOpened] Include Opened email addresses.
* @param {boolean} [showClicked] Include Clicked email addresses.
* @param {boolean} [showAbuse] Include Reported as abuse email addresses.
* @param {boolean} [showUnsubscribed] Include Unsubscribed email addresses.
* @param {boolean} [showErrors] Include error messages for bounced emails.
* @param {boolean} [showMessageIDs] Include all MessageIDs for this transaction
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
emailsByTransactionidStatusGet(transactionid: string, showFailed?: boolean, showSent?: boolean, showDelivered?: boolean, showPending?: boolean, showOpened?: boolean, showClicked?: boolean, showAbuse?: boolean, showUnsubscribed?: boolean, showErrors?: boolean, showMessageIDs?: boolean, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Send to a list of contacts submitted in a CSV data file. The first column in the CSV must be the email address and the CSV must contain a header row. Additional fields can be included with a named header row and can be merged with the template using {merge} tags in the content. Example CSV: email, firstname, lastname test1@gmail.com, michael, smith test2@gmail.com, janet, smith Merge file must not be empty. Required Access Level: SendHttp
* @summary Send Bulk Emails CSV
* @param {MergeEmailPayload} mergeEmailPayload Email data
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
emailsMergefilePost(mergeEmailPayload: MergeEmailPayload, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Send bulk merge email. Required Access Level: SendHttp
* @summary Send Bulk Emails
* @param {EmailMessageData} emailMessageData Email data
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
emailsPost(emailMessageData: EmailMessageData, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp
* @summary Send Transactional Email
* @param {EmailTransactionalMessageData} emailTransactionalMessageData Email data
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
emailsTransactionalPost(emailTransactionalMessageData: EmailTransactionalMessageData, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* EmailsApi - interface
* @export
* @interface EmailsApi
*/
export interface EmailsApiInterface {
/**
* Returns email details for viewing or rendering. Required Access Level: None
* @summary View Email
* @param {string} msgid Message identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof EmailsApiInterface
*/
emailsByMsgidViewGet(msgid: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get status details of an email transaction. Required Access Level: ViewReports
* @summary Get Status
* @param {string} transactionid Transaction identifier
* @param {boolean} [showFailed] Include Bounced email addresses.
* @param {boolean} [showSent] Include Sent email addresses.
* @param {boolean} [showDelivered] Include all delivered email addresses.
* @param {boolean} [showPending] Include Ready to send email addresses.
* @param {boolean} [showOpened] Include Opened email addresses.
* @param {boolean} [showClicked] Include Clicked email addresses.
* @param {boolean} [showAbuse] Include Reported as abuse email addresses.
* @param {boolean} [showUnsubscribed] Include Unsubscribed email addresses.
* @param {boolean} [showErrors] Include error messages for bounced emails.
* @param {boolean} [showMessageIDs] Include all MessageIDs for this transaction
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof EmailsApiInterface
*/
emailsByTransactionidStatusGet(transactionid: string, showFailed?: boolean, showSent?: boolean, showDelivered?: boolean, showPending?: boolean, showOpened?: boolean, showClicked?: boolean, showAbuse?: boolean, showUnsubscribed?: boolean, showErrors?: boolean, showMessageIDs?: boolean, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Send to a list of contacts submitted in a CSV data file. The first column in the CSV must be the email address and the CSV must contain a header row. Additional fields can be included with a named header row and can be merged with the template using {merge} tags in the content. Example CSV: email, firstname, lastname test1@gmail.com, michael, smith test2@gmail.com, janet, smith Merge file must not be empty. Required Access Level: SendHttp
* @summary Send Bulk Emails CSV
* @param {MergeEmailPayload} mergeEmailPayload Email data
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof EmailsApiInterface
*/
emailsMergefilePost(mergeEmailPayload: MergeEmailPayload, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Send bulk merge email. Required Access Level: SendHttp
* @summary Send Bulk Emails
* @param {EmailMessageData} emailMessageData Email data
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof EmailsApiInterface
*/
emailsPost(emailMessageData: EmailMessageData, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp
* @summary Send Transactional Email
* @param {EmailTransactionalMessageData} emailTransactionalMessageData Email data
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof EmailsApiInterface
*/
emailsTransactionalPost(emailTransactionalMessageData: EmailTransactionalMessageData, options?: RawAxiosRequestConfig): AxiosPromise;
}
/**
* EmailsApi - object-oriented interface
* @export
* @class EmailsApi
* @extends {BaseAPI}
*/
export declare class EmailsApi extends BaseAPI implements EmailsApiInterface {
/**
* Returns email details for viewing or rendering. Required Access Level: None
* @summary View Email
* @param {string} msgid Message identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof EmailsApi
*/
emailsByMsgidViewGet(msgid: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Get status details of an email transaction. Required Access Level: ViewReports
* @summary Get Status
* @param {string} transactionid Transaction identifier
* @param {boolean} [showFailed] Include Bounced email addresses.
* @param {boolean} [showSent] Include Sent email addresses.
* @param {boolean} [showDelivered] Include all delivered email addresses.
* @param {boolean} [showPending] Include Ready to send email addresses.
* @param {boolean} [showOpened] Include Opened email addresses.
* @param {boolean} [showClicked] Include Clicked email addresses.
* @param {boolean} [showAbuse] Include Reported as abuse email addresses.
* @param {boolean} [showUnsubscribed] Include Unsubscribed email addresses.
* @param {boolean} [showErrors] Include error messages for bounced emails.
* @param {boolean} [showMessageIDs] Include all MessageIDs for this transaction
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof EmailsApi
*/
emailsByTransactionidStatusGet(transactionid: string, showFailed?: boolean, showSent?: boolean, showDelivered?: boolean, showPending?: boolean, showOpened?: boolean, showClicked?: boolean, showAbuse?: boolean, showUnsubscribed?: boolean, showErrors?: boolean, showMessageIDs?: boolean, options?: RawAxiosRequestConfig): Promise>;
/**
* Send to a list of contacts submitted in a CSV data file. The first column in the CSV must be the email address and the CSV must contain a header row. Additional fields can be included with a named header row and can be merged with the template using {merge} tags in the content. Example CSV: email, firstname, lastname test1@gmail.com, michael, smith test2@gmail.com, janet, smith Merge file must not be empty. Required Access Level: SendHttp
* @summary Send Bulk Emails CSV
* @param {MergeEmailPayload} mergeEmailPayload Email data
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof EmailsApi
*/
emailsMergefilePost(mergeEmailPayload: MergeEmailPayload, options?: RawAxiosRequestConfig): Promise>;
/**
* Send bulk merge email. Required Access Level: SendHttp
* @summary Send Bulk Emails
* @param {EmailMessageData} emailMessageData Email data
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof EmailsApi
*/
emailsPost(emailMessageData: EmailMessageData, options?: RawAxiosRequestConfig): Promise>;
/**
* Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp
* @summary Send Transactional Email
* @param {EmailTransactionalMessageData} emailTransactionalMessageData Email data
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof EmailsApi
*/
emailsTransactionalPost(emailTransactionalMessageData: EmailTransactionalMessageData, options?: RawAxiosRequestConfig): Promise>;
}