/** * 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 { Segment } from '../ee-api-models'; import type { SegmentPayload } from '../ee-api-models'; /** * SegmentsApi - axios parameter creator * @export */ export declare const SegmentsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete an existing segment. Required Access Level: ModifyContacts * @summary Delete Segment * @param {string} name Name of your segment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ segmentsByNameDelete: (name: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns details for the specified segment. Required Access Level: ViewContacts * @summary Load Segment * @param {string} name Name of the segment you want to load. Will load all contacts if the \'All Contacts\' name has been provided * @param {*} [options] Override http request option. * @throws {RequiredError} */ segmentsByNameGet: (name: string, options?: RawAxiosRequestConfig) => Promise; /** * Rename or change RULE for your segment. Required Access Level: ModifyContacts * @summary Update Segment * @param {string} name Name of your segment. * @param {SegmentPayload} segmentPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ segmentsByNamePut: (name: string, segmentPayload: SegmentPayload, options?: RawAxiosRequestConfig) => Promise; /** * Returns a list of all your available Segments. Required Access Level: ViewContacts * @summary Load Segments * @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} */ segmentsGet: (limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise; /** * Add a new segment, based on specified RULE. Required Access Level: ModifyContacts * @summary Add Segment * @param {SegmentPayload} segmentPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ segmentsPost: (segmentPayload: SegmentPayload, options?: RawAxiosRequestConfig) => Promise; }; /** * SegmentsApi - functional programming interface * @export */ export declare const SegmentsApiFp: (configuration?: Configuration) => { /** * Delete an existing segment. Required Access Level: ModifyContacts * @summary Delete Segment * @param {string} name Name of your segment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ segmentsByNameDelete(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns details for the specified segment. Required Access Level: ViewContacts * @summary Load Segment * @param {string} name Name of the segment you want to load. Will load all contacts if the \'All Contacts\' name has been provided * @param {*} [options] Override http request option. * @throws {RequiredError} */ segmentsByNameGet(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Rename or change RULE for your segment. Required Access Level: ModifyContacts * @summary Update Segment * @param {string} name Name of your segment. * @param {SegmentPayload} segmentPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ segmentsByNamePut(name: string, segmentPayload: SegmentPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of all your available Segments. Required Access Level: ViewContacts * @summary Load Segments * @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} */ segmentsGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Add a new segment, based on specified RULE. Required Access Level: ModifyContacts * @summary Add Segment * @param {SegmentPayload} segmentPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ segmentsPost(segmentPayload: SegmentPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SegmentsApi - factory interface * @export */ export declare const SegmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete an existing segment. Required Access Level: ModifyContacts * @summary Delete Segment * @param {string} name Name of your segment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ segmentsByNameDelete(name: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns details for the specified segment. Required Access Level: ViewContacts * @summary Load Segment * @param {string} name Name of the segment you want to load. Will load all contacts if the \'All Contacts\' name has been provided * @param {*} [options] Override http request option. * @throws {RequiredError} */ segmentsByNameGet(name: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Rename or change RULE for your segment. Required Access Level: ModifyContacts * @summary Update Segment * @param {string} name Name of your segment. * @param {SegmentPayload} segmentPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ segmentsByNamePut(name: string, segmentPayload: SegmentPayload, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a list of all your available Segments. Required Access Level: ViewContacts * @summary Load Segments * @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} */ segmentsGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Add a new segment, based on specified RULE. Required Access Level: ModifyContacts * @summary Add Segment * @param {SegmentPayload} segmentPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ segmentsPost(segmentPayload: SegmentPayload, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * SegmentsApi - interface * @export * @interface SegmentsApi */ export interface SegmentsApiInterface { /** * Delete an existing segment. Required Access Level: ModifyContacts * @summary Delete Segment * @param {string} name Name of your segment. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApiInterface */ segmentsByNameDelete(name: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns details for the specified segment. Required Access Level: ViewContacts * @summary Load Segment * @param {string} name Name of the segment you want to load. Will load all contacts if the \'All Contacts\' name has been provided * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApiInterface */ segmentsByNameGet(name: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Rename or change RULE for your segment. Required Access Level: ModifyContacts * @summary Update Segment * @param {string} name Name of your segment. * @param {SegmentPayload} segmentPayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApiInterface */ segmentsByNamePut(name: string, segmentPayload: SegmentPayload, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a list of all your available Segments. Required Access Level: ViewContacts * @summary Load Segments * @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 SegmentsApiInterface */ segmentsGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Add a new segment, based on specified RULE. Required Access Level: ModifyContacts * @summary Add Segment * @param {SegmentPayload} segmentPayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApiInterface */ segmentsPost(segmentPayload: SegmentPayload, options?: RawAxiosRequestConfig): AxiosPromise; } /** * SegmentsApi - object-oriented interface * @export * @class SegmentsApi * @extends {BaseAPI} */ export declare class SegmentsApi extends BaseAPI implements SegmentsApiInterface { /** * Delete an existing segment. Required Access Level: ModifyContacts * @summary Delete Segment * @param {string} name Name of your segment. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ segmentsByNameDelete(name: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns details for the specified segment. Required Access Level: ViewContacts * @summary Load Segment * @param {string} name Name of the segment you want to load. Will load all contacts if the \'All Contacts\' name has been provided * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ segmentsByNameGet(name: string, options?: RawAxiosRequestConfig): Promise>; /** * Rename or change RULE for your segment. Required Access Level: ModifyContacts * @summary Update Segment * @param {string} name Name of your segment. * @param {SegmentPayload} segmentPayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ segmentsByNamePut(name: string, segmentPayload: SegmentPayload, options?: RawAxiosRequestConfig): Promise>; /** * Returns a list of all your available Segments. Required Access Level: ViewContacts * @summary Load Segments * @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 SegmentsApi */ segmentsGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise>; /** * Add a new segment, based on specified RULE. Required Access Level: ModifyContacts * @summary Add Segment * @param {SegmentPayload} segmentPayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ segmentsPost(segmentPayload: SegmentPayload, options?: RawAxiosRequestConfig): Promise>; }