/** * 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 { NEWUpdateOfTheGroupLink } from '../api'; import { NEWUpdateOfTheGroupLink1 } from '../api'; import { WebitelContactsContactGroup } from '../api'; import { WebitelContactsContactGroupList } from '../api'; import { WebitelContactsInputContactGroup } from '../api'; /** * ContactGroupsApi - axios parameter creator * @export */ export declare const ContactGroupsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Remove the Contact\'s group association. * @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} */ deleteContactGroup: (contactId: string, etag: string, fields?: Array, options?: any) => Promise; /** * * @summary Remove the Contact\'s group(s). * @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} */ deleteContactGroups: (contactId: string, etag: Array, fields?: Array, options?: any) => Promise; /** * * @summary List of the Contact\'s group(s). * @param {string} contactId Contact ID associated with. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {string} [query] Search term: group name; `?` - 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} */ listContactGroups: (contactId: string, page?: number, size?: number, query?: string, sort?: Array, fields?: Array, id?: Array, options?: any) => Promise; /** * * @summary Locate the Contact\'s group association. * @param {string} contactId Contact source ID. * @param {string} etag Unique group link IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateContactGroup: (contactId: string, etag: string, fields?: Array, options?: any) => Promise; /** * * @summary Associate more group(s) with the Contact. * @param {string} contactId Link contact ID. * @param {Array} input Array of the unique User(s) to associate with the Contact. Any duplicate of an already linked user{id} will result in an error. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeContactGroups: (contactId: string, input: Array, fields?: Array, options?: any) => Promise; /** * * @summary Resets all groups of the contact according to the input dataset. * @param {string} contactId Link contact ID. * @param {Array} input Final set of group(s) to be linked with the contact. Group(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 of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetContactGroups: (contactId: string, input: Array, fields?: Array, options?: any) => Promise; /** * * @summary Update the Contact\'s group details. * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheGroupLink} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateContactGroup: (contactId: string, etag: string, input: NEWUpdateOfTheGroupLink, fields?: Array, options?: any) => Promise; /** * * @summary Update the Contact\'s group details. * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheGroupLink1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateContactGroup2: (contactId: string, etag: string, input: NEWUpdateOfTheGroupLink1, fields?: Array, options?: any) => Promise; }; /** * ContactGroupsApi - functional programming interface * @export */ export declare const ContactGroupsApiFp: (configuration?: Configuration) => { /** * * @summary Remove the Contact\'s group association. * @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} */ deleteContactGroup(contactId: string, etag: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Remove the Contact\'s group(s). * @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} */ deleteContactGroups(contactId: string, etag: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary List of the Contact\'s group(s). * @param {string} contactId Contact ID associated with. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {string} [query] Search term: group name; `?` - 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} */ listContactGroups(contactId: string, page?: number, size?: number, query?: string, sort?: Array, fields?: Array, id?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Locate the Contact\'s group association. * @param {string} contactId Contact source ID. * @param {string} etag Unique group link IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateContactGroup(contactId: string, etag: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Associate more group(s) with the Contact. * @param {string} contactId Link contact ID. * @param {Array} input Array of the unique User(s) to associate with the Contact. Any duplicate of an already linked user{id} will result in an error. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeContactGroups(contactId: string, input: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Resets all groups of the contact according to the input dataset. * @param {string} contactId Link contact ID. * @param {Array} input Final set of group(s) to be linked with the contact. Group(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 of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetContactGroups(contactId: string, input: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update the Contact\'s group details. * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheGroupLink} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateContactGroup(contactId: string, etag: string, input: NEWUpdateOfTheGroupLink, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update the Contact\'s group details. * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheGroupLink1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateContactGroup2(contactId: string, etag: string, input: NEWUpdateOfTheGroupLink1, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ContactGroupsApi - factory interface * @export */ export declare const ContactGroupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Remove the Contact\'s group association. * @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} */ deleteContactGroup(contactId: string, etag: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary Remove the Contact\'s group(s). * @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} */ deleteContactGroups(contactId: string, etag: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary List of the Contact\'s group(s). * @param {string} contactId Contact ID associated with. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {string} [query] Search term: group name; `?` - 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} */ listContactGroups(contactId: string, page?: number, size?: number, query?: string, sort?: Array, fields?: Array, id?: Array, options?: any): AxiosPromise; /** * * @summary Locate the Contact\'s group association. * @param {string} contactId Contact source ID. * @param {string} etag Unique group link IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateContactGroup(contactId: string, etag: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary Associate more group(s) with the Contact. * @param {string} contactId Link contact ID. * @param {Array} input Array of the unique User(s) to associate with the Contact. Any duplicate of an already linked user{id} will result in an error. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeContactGroups(contactId: string, input: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary Resets all groups of the contact according to the input dataset. * @param {string} contactId Link contact ID. * @param {Array} input Final set of group(s) to be linked with the contact. Group(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 of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetContactGroups(contactId: string, input: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary Update the Contact\'s group details. * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheGroupLink} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateContactGroup(contactId: string, etag: string, input: NEWUpdateOfTheGroupLink, fields?: Array, options?: any): AxiosPromise; /** * * @summary Update the Contact\'s group details. * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheGroupLink1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateContactGroup2(contactId: string, etag: string, input: NEWUpdateOfTheGroupLink1, fields?: Array, options?: any): AxiosPromise; }; /** * ContactGroupsApi - object-oriented interface * @export * @class ContactGroupsApi * @extends {BaseAPI} */ export declare class ContactGroupsApi extends BaseAPI { /** * * @summary Remove the Contact\'s group association. * @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 ContactGroupsApi */ deleteContactGroup(contactId: string, etag: string, fields?: Array, options?: any): Promise>; /** * * @summary Remove the Contact\'s group(s). * @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 ContactGroupsApi */ deleteContactGroups(contactId: string, etag: Array, fields?: Array, options?: any): Promise>; /** * * @summary List of the Contact\'s group(s). * @param {string} contactId Contact ID associated with. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {string} [query] Search term: group name; `?` - 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 ContactGroupsApi */ listContactGroups(contactId: string, page?: number, size?: number, query?: string, sort?: Array, fields?: Array, id?: Array, options?: any): Promise>; /** * * @summary Locate the Contact\'s group association. * @param {string} contactId Contact source ID. * @param {string} etag Unique group link IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactGroupsApi */ locateContactGroup(contactId: string, etag: string, fields?: Array, options?: any): Promise>; /** * * @summary Associate more group(s) with the Contact. * @param {string} contactId Link contact ID. * @param {Array} input Array of the unique User(s) to associate with the Contact. Any duplicate of an already linked user{id} will result in an error. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactGroupsApi */ mergeContactGroups(contactId: string, input: Array, fields?: Array, options?: any): Promise>; /** * * @summary Resets all groups of the contact according to the input dataset. * @param {string} contactId Link contact ID. * @param {Array} input Final set of group(s) to be linked with the contact. Group(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 of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactGroupsApi */ resetContactGroups(contactId: string, input: Array, fields?: Array, options?: any): Promise>; /** * * @summary Update the Contact\'s group details. * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheGroupLink} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactGroupsApi */ updateContactGroup(contactId: string, etag: string, input: NEWUpdateOfTheGroupLink, fields?: Array, options?: any): Promise>; /** * * @summary Update the Contact\'s group details. * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheGroupLink1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactGroupsApi */ updateContactGroup2(contactId: string, etag: string, input: NEWUpdateOfTheGroupLink1, fields?: Array, options?: any): Promise>; } //# sourceMappingURL=contact-groups-api.d.ts.map