/** * 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 { Contact } from '../ee-api-models'; import type { ContactsList } from '../ee-api-models'; import type { EmailsPayload } from '../ee-api-models'; import type { ListPayload } from '../ee-api-models'; import type { ListUpdatePayload } from '../ee-api-models'; /** * ListsApi - axios parameter creator * @export */ export declare const ListsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns a list of contacts. Required Access Level: ViewContacts * @summary Load Contacts in List * @param {string} listname Name of your list. * @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} */ listsByListnameContactsGet: (listname: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise; /** * Add existing Contacts to specified list. Required Access Level: ModifyContacts * @summary Add Contacts to List * @param {string} name Name of your list. * @param {EmailsPayload} emailsPayload Provide either rule or a list of emails, not both. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsByNameContactsPost: (name: string, emailsPayload: EmailsPayload, options?: RawAxiosRequestConfig) => Promise; /** * Remove specified Contacts from your list. Required Access Level: ModifyContacts * @summary Remove Contacts from List * @param {string} name Name of your list. * @param {EmailsPayload} emailsPayload Provide either rule or a list of emails, not both. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsByNameContactsRemovePost: (name: string, emailsPayload: EmailsPayload, options?: RawAxiosRequestConfig) => Promise; /** * Deletes List and removes all the Contacts from it (does not delete Contacts). Required Access Level: ModifyContacts * @summary Delete List * @param {string} name Name of your list. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsByNameDelete: (name: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns detailed information about specified list. Required Access Level: ViewContacts * @summary Load List * @param {string} name Name of your list. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsByNameGet: (name: string, options?: RawAxiosRequestConfig) => Promise; /** * Update existing list. Required Access Level: ModifyContacts * @summary Update List * @param {string} name Name of your list. * @param {ListUpdatePayload} listUpdatePayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsByNamePut: (name: string, listUpdatePayload: ListUpdatePayload, options?: RawAxiosRequestConfig) => Promise; /** * Returns all your existing lists. Required Access Level: ViewContacts * @summary Load Lists * @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} */ listsGet: (limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise; /** * Add a new list. Required Access Level: ModifyContacts * @summary Add List * @param {ListPayload} listPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsPost: (listPayload: ListPayload, options?: RawAxiosRequestConfig) => Promise; }; /** * ListsApi - functional programming interface * @export */ export declare const ListsApiFp: (configuration?: Configuration) => { /** * Returns a list of contacts. Required Access Level: ViewContacts * @summary Load Contacts in List * @param {string} listname Name of your list. * @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} */ listsByListnameContactsGet(listname: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Add existing Contacts to specified list. Required Access Level: ModifyContacts * @summary Add Contacts to List * @param {string} name Name of your list. * @param {EmailsPayload} emailsPayload Provide either rule or a list of emails, not both. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsByNameContactsPost(name: string, emailsPayload: EmailsPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Remove specified Contacts from your list. Required Access Level: ModifyContacts * @summary Remove Contacts from List * @param {string} name Name of your list. * @param {EmailsPayload} emailsPayload Provide either rule or a list of emails, not both. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsByNameContactsRemovePost(name: string, emailsPayload: EmailsPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes List and removes all the Contacts from it (does not delete Contacts). Required Access Level: ModifyContacts * @summary Delete List * @param {string} name Name of your list. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsByNameDelete(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns detailed information about specified list. Required Access Level: ViewContacts * @summary Load List * @param {string} name Name of your list. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsByNameGet(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update existing list. Required Access Level: ModifyContacts * @summary Update List * @param {string} name Name of your list. * @param {ListUpdatePayload} listUpdatePayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsByNamePut(name: string, listUpdatePayload: ListUpdatePayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns all your existing lists. Required Access Level: ViewContacts * @summary Load Lists * @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} */ listsGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Add a new list. Required Access Level: ModifyContacts * @summary Add List * @param {ListPayload} listPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsPost(listPayload: ListPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ListsApi - factory interface * @export */ export declare const ListsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns a list of contacts. Required Access Level: ViewContacts * @summary Load Contacts in List * @param {string} listname Name of your list. * @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} */ listsByListnameContactsGet(listname: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Add existing Contacts to specified list. Required Access Level: ModifyContacts * @summary Add Contacts to List * @param {string} name Name of your list. * @param {EmailsPayload} emailsPayload Provide either rule or a list of emails, not both. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsByNameContactsPost(name: string, emailsPayload: EmailsPayload, options?: RawAxiosRequestConfig): AxiosPromise; /** * Remove specified Contacts from your list. Required Access Level: ModifyContacts * @summary Remove Contacts from List * @param {string} name Name of your list. * @param {EmailsPayload} emailsPayload Provide either rule or a list of emails, not both. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsByNameContactsRemovePost(name: string, emailsPayload: EmailsPayload, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes List and removes all the Contacts from it (does not delete Contacts). Required Access Level: ModifyContacts * @summary Delete List * @param {string} name Name of your list. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsByNameDelete(name: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns detailed information about specified list. Required Access Level: ViewContacts * @summary Load List * @param {string} name Name of your list. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsByNameGet(name: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update existing list. Required Access Level: ModifyContacts * @summary Update List * @param {string} name Name of your list. * @param {ListUpdatePayload} listUpdatePayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsByNamePut(name: string, listUpdatePayload: ListUpdatePayload, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns all your existing lists. Required Access Level: ViewContacts * @summary Load Lists * @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} */ listsGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Add a new list. Required Access Level: ModifyContacts * @summary Add List * @param {ListPayload} listPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsPost(listPayload: ListPayload, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ListsApi - interface * @export * @interface ListsApi */ export interface ListsApiInterface { /** * Returns a list of contacts. Required Access Level: ViewContacts * @summary Load Contacts in List * @param {string} listname Name of your list. * @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 ListsApiInterface */ listsByListnameContactsGet(listname: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Add existing Contacts to specified list. Required Access Level: ModifyContacts * @summary Add Contacts to List * @param {string} name Name of your list. * @param {EmailsPayload} emailsPayload Provide either rule or a list of emails, not both. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListsApiInterface */ listsByNameContactsPost(name: string, emailsPayload: EmailsPayload, options?: RawAxiosRequestConfig): AxiosPromise; /** * Remove specified Contacts from your list. Required Access Level: ModifyContacts * @summary Remove Contacts from List * @param {string} name Name of your list. * @param {EmailsPayload} emailsPayload Provide either rule or a list of emails, not both. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListsApiInterface */ listsByNameContactsRemovePost(name: string, emailsPayload: EmailsPayload, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes List and removes all the Contacts from it (does not delete Contacts). Required Access Level: ModifyContacts * @summary Delete List * @param {string} name Name of your list. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListsApiInterface */ listsByNameDelete(name: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns detailed information about specified list. Required Access Level: ViewContacts * @summary Load List * @param {string} name Name of your list. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListsApiInterface */ listsByNameGet(name: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update existing list. Required Access Level: ModifyContacts * @summary Update List * @param {string} name Name of your list. * @param {ListUpdatePayload} listUpdatePayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListsApiInterface */ listsByNamePut(name: string, listUpdatePayload: ListUpdatePayload, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns all your existing lists. Required Access Level: ViewContacts * @summary Load Lists * @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 ListsApiInterface */ listsGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Add a new list. Required Access Level: ModifyContacts * @summary Add List * @param {ListPayload} listPayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListsApiInterface */ listsPost(listPayload: ListPayload, options?: RawAxiosRequestConfig): AxiosPromise; } /** * ListsApi - object-oriented interface * @export * @class ListsApi * @extends {BaseAPI} */ export declare class ListsApi extends BaseAPI implements ListsApiInterface { /** * Returns a list of contacts. Required Access Level: ViewContacts * @summary Load Contacts in List * @param {string} listname Name of your list. * @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 ListsApi */ listsByListnameContactsGet(listname: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise>; /** * Add existing Contacts to specified list. Required Access Level: ModifyContacts * @summary Add Contacts to List * @param {string} name Name of your list. * @param {EmailsPayload} emailsPayload Provide either rule or a list of emails, not both. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListsApi */ listsByNameContactsPost(name: string, emailsPayload: EmailsPayload, options?: RawAxiosRequestConfig): Promise>; /** * Remove specified Contacts from your list. Required Access Level: ModifyContacts * @summary Remove Contacts from List * @param {string} name Name of your list. * @param {EmailsPayload} emailsPayload Provide either rule or a list of emails, not both. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListsApi */ listsByNameContactsRemovePost(name: string, emailsPayload: EmailsPayload, options?: RawAxiosRequestConfig): Promise>; /** * Deletes List and removes all the Contacts from it (does not delete Contacts). Required Access Level: ModifyContacts * @summary Delete List * @param {string} name Name of your list. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListsApi */ listsByNameDelete(name: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns detailed information about specified list. Required Access Level: ViewContacts * @summary Load List * @param {string} name Name of your list. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListsApi */ listsByNameGet(name: string, options?: RawAxiosRequestConfig): Promise>; /** * Update existing list. Required Access Level: ModifyContacts * @summary Update List * @param {string} name Name of your list. * @param {ListUpdatePayload} listUpdatePayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListsApi */ listsByNamePut(name: string, listUpdatePayload: ListUpdatePayload, options?: RawAxiosRequestConfig): Promise>; /** * Returns all your existing lists. Required Access Level: ViewContacts * @summary Load Lists * @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 ListsApi */ listsGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise>; /** * Add a new list. Required Access Level: ModifyContacts * @summary Add List * @param {ListPayload} listPayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListsApi */ listsPost(listPayload: ListPayload, options?: RawAxiosRequestConfig): Promise>; }