/** * 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 { NEWVariableUpdate } from '../api'; import { NEWVariableUpdate1 } from '../api'; import { WebitelContactsInputVariable } from '../api'; import { WebitelContactsVariable } from '../api'; import { WebitelContactsVariableList } from '../api'; /** * VariablesApi - axios parameter creator * @export */ export declare const VariablesApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Remove the contact\'s variable by etag * @param {string} contactId Contact ID associated with. * @param {string} etag Unique ID to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteVariable: (contactId: string, etag: string, fields?: Array, options?: any) => Promise; /** * * @summary Remove variable(s) of the contact * @param {string} contactId Contact ID associated with. * @param {Array} etag Set of unique ID(s) to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteVariables: (contactId: string, etag: Array, fields?: Array, options?: any) => Promise; /** * * @summary List variables of the contact * @param {string} contactId Contact ID associated with. * @param {number} [page] Page number of result. offset = ((page-1)*size) * @param {number} [size] Size of result page. limit = (size++) * @param {string} [q] Search term: variable key; `?` - 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 as a result. * @param {Array} [id] Record(s) with unique ID only. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listVariables: (contactId: string, page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, options?: any) => Promise; /** * * @summary Update or append variables to the contact * @param {string} contactId Link contact ID. * @param {Array} input Fixed object of unique variables to associate with a Contact. Each individual key of an object represents a separate variable. Variable{key} already linked with the Contact and listed here will be updated. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeVariables: (contactId: string, input: Array, fields?: Array, options?: any) => Promise; /** * * @summary Reset all variables of the contact * @param {string} contactId Contact ID associated with. * @param {Array} input Fixed object of unique variables to associate with a Contact. Each individual key of an object represents a separate variable. Variable{key} already linked with the Contact but not listed here will be removed. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetVariables: (contactId: string, input: Array, fields?: Array, options?: any) => Promise; /** * * @summary Update contact variable * @param {string} contactId Contact ID associated with. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWVariableUpdate} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVariable: (contactId: string, etag: string, input: NEWVariableUpdate, fields?: Array, options?: any) => Promise; /** * * @summary Update contact variable * @param {string} contactId Contact ID associated with. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWVariableUpdate1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVariable2: (contactId: string, etag: string, input: NEWVariableUpdate1, fields?: Array, options?: any) => Promise; }; /** * VariablesApi - functional programming interface * @export */ export declare const VariablesApiFp: (configuration?: Configuration) => { /** * * @summary Remove the contact\'s variable by etag * @param {string} contactId Contact ID associated with. * @param {string} etag Unique ID to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteVariable(contactId: string, etag: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Remove variable(s) of the contact * @param {string} contactId Contact ID associated with. * @param {Array} etag Set of unique ID(s) to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteVariables(contactId: string, etag: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary List variables of the contact * @param {string} contactId Contact ID associated with. * @param {number} [page] Page number of result. offset = ((page-1)*size) * @param {number} [size] Size of result page. limit = (size++) * @param {string} [q] Search term: variable key; `?` - 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 as a result. * @param {Array} [id] Record(s) with unique ID only. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listVariables(contactId: string, page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update or append variables to the contact * @param {string} contactId Link contact ID. * @param {Array} input Fixed object of unique variables to associate with a Contact. Each individual key of an object represents a separate variable. Variable{key} already linked with the Contact and listed here will be updated. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeVariables(contactId: string, input: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Reset all variables of the contact * @param {string} contactId Contact ID associated with. * @param {Array} input Fixed object of unique variables to associate with a Contact. Each individual key of an object represents a separate variable. Variable{key} already linked with the Contact but not listed here will be removed. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetVariables(contactId: string, input: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update contact variable * @param {string} contactId Contact ID associated with. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWVariableUpdate} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVariable(contactId: string, etag: string, input: NEWVariableUpdate, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update contact variable * @param {string} contactId Contact ID associated with. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWVariableUpdate1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVariable2(contactId: string, etag: string, input: NEWVariableUpdate1, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * VariablesApi - factory interface * @export */ export declare const VariablesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Remove the contact\'s variable by etag * @param {string} contactId Contact ID associated with. * @param {string} etag Unique ID to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteVariable(contactId: string, etag: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary Remove variable(s) of the contact * @param {string} contactId Contact ID associated with. * @param {Array} etag Set of unique ID(s) to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteVariables(contactId: string, etag: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary List variables of the contact * @param {string} contactId Contact ID associated with. * @param {number} [page] Page number of result. offset = ((page-1)*size) * @param {number} [size] Size of result page. limit = (size++) * @param {string} [q] Search term: variable key; `?` - 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 as a result. * @param {Array} [id] Record(s) with unique ID only. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listVariables(contactId: string, page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, options?: any): AxiosPromise; /** * * @summary Update or append variables to the contact * @param {string} contactId Link contact ID. * @param {Array} input Fixed object of unique variables to associate with a Contact. Each individual key of an object represents a separate variable. Variable{key} already linked with the Contact and listed here will be updated. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeVariables(contactId: string, input: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary Reset all variables of the contact * @param {string} contactId Contact ID associated with. * @param {Array} input Fixed object of unique variables to associate with a Contact. Each individual key of an object represents a separate variable. Variable{key} already linked with the Contact but not listed here will be removed. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetVariables(contactId: string, input: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary Update contact variable * @param {string} contactId Contact ID associated with. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWVariableUpdate} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVariable(contactId: string, etag: string, input: NEWVariableUpdate, fields?: Array, options?: any): AxiosPromise; /** * * @summary Update contact variable * @param {string} contactId Contact ID associated with. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWVariableUpdate1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVariable2(contactId: string, etag: string, input: NEWVariableUpdate1, fields?: Array, options?: any): AxiosPromise; }; /** * VariablesApi - object-oriented interface * @export * @class VariablesApi * @extends {BaseAPI} */ export declare class VariablesApi extends BaseAPI { /** * * @summary Remove the contact\'s variable by etag * @param {string} contactId Contact ID associated with. * @param {string} etag Unique ID to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VariablesApi */ deleteVariable(contactId: string, etag: string, fields?: Array, options?: any): Promise>; /** * * @summary Remove variable(s) of the contact * @param {string} contactId Contact ID associated with. * @param {Array} etag Set of unique ID(s) to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VariablesApi */ deleteVariables(contactId: string, etag: Array, fields?: Array, options?: any): Promise>; /** * * @summary List variables of the contact * @param {string} contactId Contact ID associated with. * @param {number} [page] Page number of result. offset = ((page-1)*size) * @param {number} [size] Size of result page. limit = (size++) * @param {string} [q] Search term: variable key; `?` - 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 as a result. * @param {Array} [id] Record(s) with unique ID only. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VariablesApi */ listVariables(contactId: string, page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, options?: any): Promise>; /** * * @summary Update or append variables to the contact * @param {string} contactId Link contact ID. * @param {Array} input Fixed object of unique variables to associate with a Contact. Each individual key of an object represents a separate variable. Variable{key} already linked with the Contact and listed here will be updated. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VariablesApi */ mergeVariables(contactId: string, input: Array, fields?: Array, options?: any): Promise>; /** * * @summary Reset all variables of the contact * @param {string} contactId Contact ID associated with. * @param {Array} input Fixed object of unique variables to associate with a Contact. Each individual key of an object represents a separate variable. Variable{key} already linked with the Contact but not listed here will be removed. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VariablesApi */ resetVariables(contactId: string, input: Array, fields?: Array, options?: any): Promise>; /** * * @summary Update contact variable * @param {string} contactId Contact ID associated with. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWVariableUpdate} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VariablesApi */ updateVariable(contactId: string, etag: string, input: NEWVariableUpdate, fields?: Array, options?: any): Promise>; /** * * @summary Update contact variable * @param {string} contactId Contact ID associated with. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWVariableUpdate1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VariablesApi */ updateVariable2(contactId: string, etag: string, input: NEWVariableUpdate1, fields?: Array, options?: any): Promise>; } //# sourceMappingURL=variables-api.d.ts.map