/** * Webitel API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 24.04.0 * Contact: support@webitel.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 { AxiosPromise, AxiosInstance } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { WebitelContactsInputLabel } from '../api'; import { WebitelContactsLabelList } from '../api'; import { WebitelContactsLabelTags } from '../api'; /** * LabelsApi - axios parameter creator * @export */ export declare const LabelsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Remove Contact Labels associations. * @param {string} contactId Link contact ID. * @param {Array} etag Set of unique label(s).etag identifiers. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteLabels: (contactId: string, etag: Array, fields?: Array, options?: any) => Promise; /** * * @summary Search for Contacts engaged Label(s). * @param {number} [page] Page number of result dataset records. offset = ((page-1)*size) * @param {number} [size] Size count of records on result page. limit = (size+1) * @param {string} [q] Search term: label. `?` - matches any one character `*` - matches 0 or more characters * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLabels: (page?: number, size?: number, q?: string, options?: any) => Promise; /** * * @summary Locate the Contact\'s associated Label(s). * @param {string} contactId Link contact ID. * @param {number} [page] Page number of result dataset records. offset = ((page-1)*size) * @param {number} [size] Size count of records on result page. limit = (size+1) * @param {string} [q] Search term: label tag. `?` - matches any one character `*` - matches 0 or more characters * @param {Array} [sort] Sort the result according to fields. * @param {Array} [fields] Fields to be retrieved into result. * @param {Array} [id] Record(s) with unique ID or ETag. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listLabels: (contactId: string, page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, options?: any) => Promise; /** * * @summary Associate NEW Labels to the Contact. * @param {string} contactId Link contact ID. * @param {Array} input Fixed set of label(s) to be linked with the contact. Label(s) that conflicts with already linked will be updated. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeLabels: (contactId: string, input: Array, fields?: Array, options?: any) => Promise; /** * * @summary Reset Labels to fit the specified final set. * @param {string} contactId Link contact ID. * @param {Array} input Final set of labels(s) to be linked with the contact. Label(s) that are already linked with the contact but not given in here will be removed. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetLabels: (contactId: string, input: Array, fields?: Array, options?: any) => Promise; }; /** * LabelsApi - functional programming interface * @export */ export declare const LabelsApiFp: (configuration?: Configuration) => { /** * * @summary Remove Contact Labels associations. * @param {string} contactId Link contact ID. * @param {Array} etag Set of unique label(s).etag identifiers. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteLabels(contactId: string, etag: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Search for Contacts engaged Label(s). * @param {number} [page] Page number of result dataset records. offset = ((page-1)*size) * @param {number} [size] Size count of records on result page. limit = (size+1) * @param {string} [q] Search term: label. `?` - matches any one character `*` - matches 0 or more characters * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLabels(page?: number, size?: number, q?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Locate the Contact\'s associated Label(s). * @param {string} contactId Link contact ID. * @param {number} [page] Page number of result dataset records. offset = ((page-1)*size) * @param {number} [size] Size count of records on result page. limit = (size+1) * @param {string} [q] Search term: label tag. `?` - matches any one character `*` - matches 0 or more characters * @param {Array} [sort] Sort the result according to fields. * @param {Array} [fields] Fields to be retrieved into result. * @param {Array} [id] Record(s) with unique ID or ETag. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listLabels(contactId: string, page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Associate NEW Labels to the Contact. * @param {string} contactId Link contact ID. * @param {Array} input Fixed set of label(s) to be linked with the contact. Label(s) that conflicts with already linked will be updated. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeLabels(contactId: string, input: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Reset Labels to fit the specified final set. * @param {string} contactId Link contact ID. * @param {Array} input Final set of labels(s) to be linked with the contact. Label(s) that are already linked with the contact but not given in here will be removed. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetLabels(contactId: string, input: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * LabelsApi - factory interface * @export */ export declare const LabelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Remove Contact Labels associations. * @param {string} contactId Link contact ID. * @param {Array} etag Set of unique label(s).etag identifiers. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteLabels(contactId: string, etag: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary Search for Contacts engaged Label(s). * @param {number} [page] Page number of result dataset records. offset = ((page-1)*size) * @param {number} [size] Size count of records on result page. limit = (size+1) * @param {string} [q] Search term: label. `?` - matches any one character `*` - matches 0 or more characters * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLabels(page?: number, size?: number, q?: string, options?: any): AxiosPromise; /** * * @summary Locate the Contact\'s associated Label(s). * @param {string} contactId Link contact ID. * @param {number} [page] Page number of result dataset records. offset = ((page-1)*size) * @param {number} [size] Size count of records on result page. limit = (size+1) * @param {string} [q] Search term: label tag. `?` - matches any one character `*` - matches 0 or more characters * @param {Array} [sort] Sort the result according to fields. * @param {Array} [fields] Fields to be retrieved into result. * @param {Array} [id] Record(s) with unique ID or ETag. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listLabels(contactId: string, page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, options?: any): AxiosPromise; /** * * @summary Associate NEW Labels to the Contact. * @param {string} contactId Link contact ID. * @param {Array} input Fixed set of label(s) to be linked with the contact. Label(s) that conflicts with already linked will be updated. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeLabels(contactId: string, input: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary Reset Labels to fit the specified final set. * @param {string} contactId Link contact ID. * @param {Array} input Final set of labels(s) to be linked with the contact. Label(s) that are already linked with the contact but not given in here will be removed. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetLabels(contactId: string, input: Array, fields?: Array, options?: any): AxiosPromise; }; /** * LabelsApi - object-oriented interface * @export * @class LabelsApi * @extends {BaseAPI} */ export declare class LabelsApi extends BaseAPI { /** * * @summary Remove Contact Labels associations. * @param {string} contactId Link contact ID. * @param {Array} etag Set of unique label(s).etag identifiers. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LabelsApi */ deleteLabels(contactId: string, etag: Array, fields?: Array, options?: any): Promise>; /** * * @summary Search for Contacts engaged Label(s). * @param {number} [page] Page number of result dataset records. offset = ((page-1)*size) * @param {number} [size] Size count of records on result page. limit = (size+1) * @param {string} [q] Search term: label. `?` - matches any one character `*` - matches 0 or more characters * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LabelsApi */ getLabels(page?: number, size?: number, q?: string, options?: any): Promise>; /** * * @summary Locate the Contact\'s associated Label(s). * @param {string} contactId Link contact ID. * @param {number} [page] Page number of result dataset records. offset = ((page-1)*size) * @param {number} [size] Size count of records on result page. limit = (size+1) * @param {string} [q] Search term: label tag. `?` - matches any one character `*` - matches 0 or more characters * @param {Array} [sort] Sort the result according to fields. * @param {Array} [fields] Fields to be retrieved into result. * @param {Array} [id] Record(s) with unique ID or ETag. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LabelsApi */ listLabels(contactId: string, page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, options?: any): Promise>; /** * * @summary Associate NEW Labels to the Contact. * @param {string} contactId Link contact ID. * @param {Array} input Fixed set of label(s) to be linked with the contact. Label(s) that conflicts with already linked will be updated. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LabelsApi */ mergeLabels(contactId: string, input: Array, fields?: Array, options?: any): Promise>; /** * * @summary Reset Labels to fit the specified final set. * @param {string} contactId Link contact ID. * @param {Array} input Final set of labels(s) to be linked with the contact. Label(s) that are already linked with the contact but not given in here will be removed. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LabelsApi */ resetLabels(contactId: string, input: Array, fields?: Array, options?: any): Promise>; } //# sourceMappingURL=labels-api.d.ts.map