/* tslint:disable */ /* eslint-disable */ /** * 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 globalAxios from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; // @ts-ignore import type { Contact } from '../ee-api-models'; // @ts-ignore import type { ContactsList } from '../ee-api-models'; // @ts-ignore import type { EmailsPayload } from '../ee-api-models'; // @ts-ignore import type { ListPayload } from '../ee-api-models'; // @ts-ignore import type { ListUpdatePayload } from '../ee-api-models'; /** * ListsApi - axios parameter creator * @export */ export const ListsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * 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: async (listname: string, limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'listname' is not null or undefined assertParamExists('listsByListnameContactsGet', 'listname', listname) const localVarPath = `/lists/{listname}/contacts` .replace(`{${"listname"}}`, encodeURIComponent(String(listname))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication apikey required await setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration) if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * 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: async (name: string, emailsPayload: EmailsPayload, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('listsByNameContactsPost', 'name', name) // verify required parameter 'emailsPayload' is not null or undefined assertParamExists('listsByNameContactsPost', 'emailsPayload', emailsPayload) const localVarPath = `/lists/{name}/contacts` .replace(`{${"name"}}`, encodeURIComponent(String(name))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication apikey required await setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration) localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(emailsPayload, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * 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: async (name: string, emailsPayload: EmailsPayload, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('listsByNameContactsRemovePost', 'name', name) // verify required parameter 'emailsPayload' is not null or undefined assertParamExists('listsByNameContactsRemovePost', 'emailsPayload', emailsPayload) const localVarPath = `/lists/{name}/contacts/remove` .replace(`{${"name"}}`, encodeURIComponent(String(name))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication apikey required await setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration) localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(emailsPayload, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * 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: async (name: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('listsByNameDelete', 'name', name) const localVarPath = `/lists/{name}` .replace(`{${"name"}}`, encodeURIComponent(String(name))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication apikey required await setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration) setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * 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: async (name: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('listsByNameGet', 'name', name) const localVarPath = `/lists/{name}` .replace(`{${"name"}}`, encodeURIComponent(String(name))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication apikey required await setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration) setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * 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: async (name: string, listUpdatePayload: ListUpdatePayload, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('listsByNamePut', 'name', name) // verify required parameter 'listUpdatePayload' is not null or undefined assertParamExists('listsByNamePut', 'listUpdatePayload', listUpdatePayload) const localVarPath = `/lists/{name}` .replace(`{${"name"}}`, encodeURIComponent(String(name))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication apikey required await setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration) localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(listUpdatePayload, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * 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: async (limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/lists`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication apikey required await setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration) if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Add a new list. Required Access Level: ModifyContacts * @summary Add List * @param {ListPayload} listPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ listsPost: async (listPayload: ListPayload, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'listPayload' is not null or undefined assertParamExists('listsPost', 'listPayload', listPayload) const localVarPath = `/lists`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication apikey required await setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration) localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(listPayload, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, } }; /** * ListsApi - functional programming interface * @export */ export const ListsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = ListsApiAxiosParamCreator(configuration) return { /** * 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} */ async listsByListnameContactsGet(listname: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listsByListnameContactsGet(listname, limit, offset, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ListsApi.listsByListnameContactsGet']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * 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} */ async listsByNameContactsPost(name: string, emailsPayload: EmailsPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.listsByNameContactsPost(name, emailsPayload, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ListsApi.listsByNameContactsPost']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * 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} */ async listsByNameContactsRemovePost(name: string, emailsPayload: EmailsPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.listsByNameContactsRemovePost(name, emailsPayload, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ListsApi.listsByNameContactsRemovePost']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * 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} */ async listsByNameDelete(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.listsByNameDelete(name, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ListsApi.listsByNameDelete']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * 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} */ async listsByNameGet(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.listsByNameGet(name, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ListsApi.listsByNameGet']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * 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} */ async listsByNamePut(name: string, listUpdatePayload: ListUpdatePayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.listsByNamePut(name, listUpdatePayload, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ListsApi.listsByNamePut']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * 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} */ async listsGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listsGet(limit, offset, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ListsApi.listsGet']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Add a new list. Required Access Level: ModifyContacts * @summary Add List * @param {ListPayload} listPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ async listsPost(listPayload: ListPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.listsPost(listPayload, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ListsApi.listsPost']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * ListsApi - factory interface * @export */ export const ListsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = ListsApiFp(configuration) return { /** * 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> { return localVarFp.listsByListnameContactsGet(listname, limit, offset, options).then((request) => request(axios, basePath)); }, /** * 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 { return localVarFp.listsByNameContactsPost(name, emailsPayload, options).then((request) => request(axios, basePath)); }, /** * 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 { return localVarFp.listsByNameContactsRemovePost(name, emailsPayload, options).then((request) => request(axios, basePath)); }, /** * 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 { return localVarFp.listsByNameDelete(name, options).then((request) => request(axios, basePath)); }, /** * 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 { return localVarFp.listsByNameGet(name, options).then((request) => request(axios, basePath)); }, /** * 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 { return localVarFp.listsByNamePut(name, listUpdatePayload, options).then((request) => request(axios, basePath)); }, /** * 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> { return localVarFp.listsGet(limit, offset, options).then((request) => request(axios, basePath)); }, /** * 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 { return localVarFp.listsPost(listPayload, options).then((request) => request(axios, basePath)); }, }; }; /** * 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 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 */ public listsByListnameContactsGet(listname: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) { return ListsApiFp(this.configuration).listsByListnameContactsGet(listname, limit, offset, options).then((request) => request(this.axios, this.basePath)); } /** * 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 */ public listsByNameContactsPost(name: string, emailsPayload: EmailsPayload, options?: RawAxiosRequestConfig) { return ListsApiFp(this.configuration).listsByNameContactsPost(name, emailsPayload, options).then((request) => request(this.axios, this.basePath)); } /** * 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 */ public listsByNameContactsRemovePost(name: string, emailsPayload: EmailsPayload, options?: RawAxiosRequestConfig) { return ListsApiFp(this.configuration).listsByNameContactsRemovePost(name, emailsPayload, options).then((request) => request(this.axios, this.basePath)); } /** * 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 */ public listsByNameDelete(name: string, options?: RawAxiosRequestConfig) { return ListsApiFp(this.configuration).listsByNameDelete(name, options).then((request) => request(this.axios, this.basePath)); } /** * 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 */ public listsByNameGet(name: string, options?: RawAxiosRequestConfig) { return ListsApiFp(this.configuration).listsByNameGet(name, options).then((request) => request(this.axios, this.basePath)); } /** * 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 */ public listsByNamePut(name: string, listUpdatePayload: ListUpdatePayload, options?: RawAxiosRequestConfig) { return ListsApiFp(this.configuration).listsByNamePut(name, listUpdatePayload, options).then((request) => request(this.axios, this.basePath)); } /** * 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 */ public listsGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig) { return ListsApiFp(this.configuration).listsGet(limit, offset, options).then((request) => request(this.axios, this.basePath)); } /** * Add a new list. Required Access Level: ModifyContacts * @summary Add List * @param {ListPayload} listPayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListsApi */ public listsPost(listPayload: ListPayload, options?: RawAxiosRequestConfig) { return ListsApiFp(this.configuration).listsPost(listPayload, options).then((request) => request(this.axios, this.basePath)); } }