/** * 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 { NEWContactSourceChanges } from '../api'; import { WebitelContactsContact } from '../api'; import { WebitelContactsContactList } from '../api'; import { WebitelContactsInputContact } from '../api'; /** * ContactsApi - axios parameter creator * @export */ export declare const ContactsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Create NEW Contact * @param {WebitelContactsInputContact} input NEW Contact source changes * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createContact: (input: WebitelContactsInputContact, fields?: Array, options?: any) => Promise; /** * * @summary Remove Contact source * @param {string} etag Unique ID of the latest version of a resource. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteContact: (etag: string, fields?: Array, options?: any) => Promise; /** * * @summary Locate Contact source * @param {string} etag The Contact source IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Source Fields to return into result. * @param {'READ' | 'WRITE' | 'DELETE'} [mode] The requirement of a special access mode to the Source. - READ: Can `fetch` record. [GET] - WRITE: Can `update` record. [PUT|PATCH] - DELETE: Can `delete` record. [DELETE] * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateContact: (etag: string, fields?: Array, mode?: "READ" | "WRITE" | "DELETE", options?: any) => Promise; /** * | Field | Type | ----------- | ---- | **----------- READ-ONLY -----------** | | `id` | int64 | `ver` | int32 | `etag` | string | **---------- OPERATIONAL ----------** | | `created_at` | int64(epoch:milli) | `created_by` | lookup(user) | `updated_at` | int64(epoch:milli) | `updated_by` | lookup(user) | **---------- ATTRIBUTES -----------** | | `name` | name! | `about` | string | `labels` | list[label!] | `emails` | list[email!] | `photos` | list[photo!] | `phones` | list[phone!] | `managers` | list[manager!] | `comments` | list[comment!] | `addresses` | list[address!] | `languages` | list[language!] | `timezones` | list[timezone!] | `variables` | list[variable!] | `imclients` | list[imClient!] * @summary Search for Contact(s) * @param {number} [page] Page number of result records. _default(1); offset=(size*(page-1));_ ```javascript let offset = 0 , page = req.page ; if (page <= 0) page = 1; if (page > 1) offset = ((page-1)*size); // . . . ``` * @param {number} [size] Limit of result page records count. _default(16); limit=(size<=0?-1:size+1);_ ```javascript const default = 16 , maximum = 32 ; let limit = req.size; if (limit <= 0) limit = default; if (maximum < limit) limit = maximum; // . . . ``` * @param {string} [q] Search term: `?` - matches any character `*` - matches 0 or more characters Used to query records within a set of `qin` fields, eg: name,emails{type},labels etc... * @param {Array} [sort] Sort result dataset of records by fields. ``` sort ::= *( ORDER name ) ORDER = ASC / DESC DESC = \"-\" / \"!\" ASC = [ \"+\" ] ; Default ``` Fields available - `id`(seq) - `domain`{name} - `created_at` - `created_by`{name} - `updated_at` - `updated_by`{name} Use ?fields=`field.sort()` option to sort Edge fields. * @param {Array} [fields] Fields [Q]uery to build result dataset record. ``` fields ::= field [ *( \",\" field ) ] field ::= name [ *( func ) ] [ inner ] inner ::= \"{\" fields \"}\" funcs ::= *( func ) func ::= \".\" name \"(\" [ args ] \")\" name ::= ALPHA / DIGIT / USCORE ALPHA = %x41-5A / %x61-7A ; \"A\"-\"Z\" / \"a\"-\"z\" DIGIT = %x30-39 ; \"0\"-\"9\" USCORE = %x5F ; underscore ; \"_\" ``` * @param {Array} [id] Records with unique IDentifier(s). Accept: `id` -or- `etag`. * @param {Array} [qin] [Q]uery[IN] is a set of search fields for term `q`. Default: `name{common_name}`. * @param {'READ' | 'WRITE' | 'DELETE'} [mode] Source access mode requirement. - READ: Can `fetch` record. [GET] - WRITE: Can `update` record. [PUT|PATCH] - DELETE: Can `delete` record. [DELETE] * @param {string} [notIdGroup] Excludes contacts that belong to the specified group ID. - Filters out contacts associated with the given `group_id`. * @param {Array} [group] Filters contacts by the specified group(s). - Includes only contacts that belong to one or more of the given group Group(s). * @param {Array} [owner] Filters contacts by the specified owner(s). - Includes only contacts whose owner matches one or more of the given Owner(s). - The owner ID corresponds to `contact_id` in the `directory.wbt_user` table. * @param {Array} [label] Filters contacts by the specified label(s). - Includes only contacts that have one or more of the given Label(s). * @param {boolean} [user] Filters contacts based on whether they are user-associated. - `true` → Includes only user-associated contacts. - `false` → Includes only contacts that are NOT user-associated. - A contact is considered user-associated if it exists in `directory.wbt_user`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchContacts: (page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, qin?: Array, mode?: "READ" | "WRITE" | "DELETE", notIdGroup?: string, group?: Array, owner?: Array, label?: Array, user?: boolean, options?: any) => Promise; /** * * @summary NEW Update of the Contact source * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWContactSourceChanges} input * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateContact: (etag: string, input: NEWContactSourceChanges, fields?: Array, options?: any) => Promise; }; /** * ContactsApi - functional programming interface * @export */ export declare const ContactsApiFp: (configuration?: Configuration) => { /** * * @summary Create NEW Contact * @param {WebitelContactsInputContact} input NEW Contact source changes * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createContact(input: WebitelContactsInputContact, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Remove Contact source * @param {string} etag Unique ID of the latest version of a resource. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteContact(etag: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Locate Contact source * @param {string} etag The Contact source IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Source Fields to return into result. * @param {'READ' | 'WRITE' | 'DELETE'} [mode] The requirement of a special access mode to the Source. - READ: Can `fetch` record. [GET] - WRITE: Can `update` record. [PUT|PATCH] - DELETE: Can `delete` record. [DELETE] * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateContact(etag: string, fields?: Array, mode?: "READ" | "WRITE" | "DELETE", options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * | Field | Type | ----------- | ---- | **----------- READ-ONLY -----------** | | `id` | int64 | `ver` | int32 | `etag` | string | **---------- OPERATIONAL ----------** | | `created_at` | int64(epoch:milli) | `created_by` | lookup(user) | `updated_at` | int64(epoch:milli) | `updated_by` | lookup(user) | **---------- ATTRIBUTES -----------** | | `name` | name! | `about` | string | `labels` | list[label!] | `emails` | list[email!] | `photos` | list[photo!] | `phones` | list[phone!] | `managers` | list[manager!] | `comments` | list[comment!] | `addresses` | list[address!] | `languages` | list[language!] | `timezones` | list[timezone!] | `variables` | list[variable!] | `imclients` | list[imClient!] * @summary Search for Contact(s) * @param {number} [page] Page number of result records. _default(1); offset=(size*(page-1));_ ```javascript let offset = 0 , page = req.page ; if (page <= 0) page = 1; if (page > 1) offset = ((page-1)*size); // . . . ``` * @param {number} [size] Limit of result page records count. _default(16); limit=(size<=0?-1:size+1);_ ```javascript const default = 16 , maximum = 32 ; let limit = req.size; if (limit <= 0) limit = default; if (maximum < limit) limit = maximum; // . . . ``` * @param {string} [q] Search term: `?` - matches any character `*` - matches 0 or more characters Used to query records within a set of `qin` fields, eg: name,emails{type},labels etc... * @param {Array} [sort] Sort result dataset of records by fields. ``` sort ::= *( ORDER name ) ORDER = ASC / DESC DESC = \"-\" / \"!\" ASC = [ \"+\" ] ; Default ``` Fields available - `id`(seq) - `domain`{name} - `created_at` - `created_by`{name} - `updated_at` - `updated_by`{name} Use ?fields=`field.sort()` option to sort Edge fields. * @param {Array} [fields] Fields [Q]uery to build result dataset record. ``` fields ::= field [ *( \",\" field ) ] field ::= name [ *( func ) ] [ inner ] inner ::= \"{\" fields \"}\" funcs ::= *( func ) func ::= \".\" name \"(\" [ args ] \")\" name ::= ALPHA / DIGIT / USCORE ALPHA = %x41-5A / %x61-7A ; \"A\"-\"Z\" / \"a\"-\"z\" DIGIT = %x30-39 ; \"0\"-\"9\" USCORE = %x5F ; underscore ; \"_\" ``` * @param {Array} [id] Records with unique IDentifier(s). Accept: `id` -or- `etag`. * @param {Array} [qin] [Q]uery[IN] is a set of search fields for term `q`. Default: `name{common_name}`. * @param {'READ' | 'WRITE' | 'DELETE'} [mode] Source access mode requirement. - READ: Can `fetch` record. [GET] - WRITE: Can `update` record. [PUT|PATCH] - DELETE: Can `delete` record. [DELETE] * @param {string} [notIdGroup] Excludes contacts that belong to the specified group ID. - Filters out contacts associated with the given `group_id`. * @param {Array} [group] Filters contacts by the specified group(s). - Includes only contacts that belong to one or more of the given group Group(s). * @param {Array} [owner] Filters contacts by the specified owner(s). - Includes only contacts whose owner matches one or more of the given Owner(s). - The owner ID corresponds to `contact_id` in the `directory.wbt_user` table. * @param {Array} [label] Filters contacts by the specified label(s). - Includes only contacts that have one or more of the given Label(s). * @param {boolean} [user] Filters contacts based on whether they are user-associated. - `true` → Includes only user-associated contacts. - `false` → Includes only contacts that are NOT user-associated. - A contact is considered user-associated if it exists in `directory.wbt_user`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchContacts(page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, qin?: Array, mode?: "READ" | "WRITE" | "DELETE", notIdGroup?: string, group?: Array, owner?: Array, label?: Array, user?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary NEW Update of the Contact source * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWContactSourceChanges} input * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateContact(etag: string, input: NEWContactSourceChanges, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ContactsApi - factory interface * @export */ export declare const ContactsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Create NEW Contact * @param {WebitelContactsInputContact} input NEW Contact source changes * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createContact(input: WebitelContactsInputContact, fields?: Array, options?: any): AxiosPromise; /** * * @summary Remove Contact source * @param {string} etag Unique ID of the latest version of a resource. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteContact(etag: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary Locate Contact source * @param {string} etag The Contact source IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Source Fields to return into result. * @param {'READ' | 'WRITE' | 'DELETE'} [mode] The requirement of a special access mode to the Source. - READ: Can `fetch` record. [GET] - WRITE: Can `update` record. [PUT|PATCH] - DELETE: Can `delete` record. [DELETE] * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateContact(etag: string, fields?: Array, mode?: "READ" | "WRITE" | "DELETE", options?: any): AxiosPromise; /** * | Field | Type | ----------- | ---- | **----------- READ-ONLY -----------** | | `id` | int64 | `ver` | int32 | `etag` | string | **---------- OPERATIONAL ----------** | | `created_at` | int64(epoch:milli) | `created_by` | lookup(user) | `updated_at` | int64(epoch:milli) | `updated_by` | lookup(user) | **---------- ATTRIBUTES -----------** | | `name` | name! | `about` | string | `labels` | list[label!] | `emails` | list[email!] | `photos` | list[photo!] | `phones` | list[phone!] | `managers` | list[manager!] | `comments` | list[comment!] | `addresses` | list[address!] | `languages` | list[language!] | `timezones` | list[timezone!] | `variables` | list[variable!] | `imclients` | list[imClient!] * @summary Search for Contact(s) * @param {number} [page] Page number of result records. _default(1); offset=(size*(page-1));_ ```javascript let offset = 0 , page = req.page ; if (page <= 0) page = 1; if (page > 1) offset = ((page-1)*size); // . . . ``` * @param {number} [size] Limit of result page records count. _default(16); limit=(size<=0?-1:size+1);_ ```javascript const default = 16 , maximum = 32 ; let limit = req.size; if (limit <= 0) limit = default; if (maximum < limit) limit = maximum; // . . . ``` * @param {string} [q] Search term: `?` - matches any character `*` - matches 0 or more characters Used to query records within a set of `qin` fields, eg: name,emails{type},labels etc... * @param {Array} [sort] Sort result dataset of records by fields. ``` sort ::= *( ORDER name ) ORDER = ASC / DESC DESC = \"-\" / \"!\" ASC = [ \"+\" ] ; Default ``` Fields available - `id`(seq) - `domain`{name} - `created_at` - `created_by`{name} - `updated_at` - `updated_by`{name} Use ?fields=`field.sort()` option to sort Edge fields. * @param {Array} [fields] Fields [Q]uery to build result dataset record. ``` fields ::= field [ *( \",\" field ) ] field ::= name [ *( func ) ] [ inner ] inner ::= \"{\" fields \"}\" funcs ::= *( func ) func ::= \".\" name \"(\" [ args ] \")\" name ::= ALPHA / DIGIT / USCORE ALPHA = %x41-5A / %x61-7A ; \"A\"-\"Z\" / \"a\"-\"z\" DIGIT = %x30-39 ; \"0\"-\"9\" USCORE = %x5F ; underscore ; \"_\" ``` * @param {Array} [id] Records with unique IDentifier(s). Accept: `id` -or- `etag`. * @param {Array} [qin] [Q]uery[IN] is a set of search fields for term `q`. Default: `name{common_name}`. * @param {'READ' | 'WRITE' | 'DELETE'} [mode] Source access mode requirement. - READ: Can `fetch` record. [GET] - WRITE: Can `update` record. [PUT|PATCH] - DELETE: Can `delete` record. [DELETE] * @param {string} [notIdGroup] Excludes contacts that belong to the specified group ID. - Filters out contacts associated with the given `group_id`. * @param {Array} [group] Filters contacts by the specified group(s). - Includes only contacts that belong to one or more of the given group Group(s). * @param {Array} [owner] Filters contacts by the specified owner(s). - Includes only contacts whose owner matches one or more of the given Owner(s). - The owner ID corresponds to `contact_id` in the `directory.wbt_user` table. * @param {Array} [label] Filters contacts by the specified label(s). - Includes only contacts that have one or more of the given Label(s). * @param {boolean} [user] Filters contacts based on whether they are user-associated. - `true` → Includes only user-associated contacts. - `false` → Includes only contacts that are NOT user-associated. - A contact is considered user-associated if it exists in `directory.wbt_user`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchContacts(page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, qin?: Array, mode?: "READ" | "WRITE" | "DELETE", notIdGroup?: string, group?: Array, owner?: Array, label?: Array, user?: boolean, options?: any): AxiosPromise; /** * * @summary NEW Update of the Contact source * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWContactSourceChanges} input * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateContact(etag: string, input: NEWContactSourceChanges, fields?: Array, options?: any): AxiosPromise; }; /** * ContactsApi - object-oriented interface * @export * @class ContactsApi * @extends {BaseAPI} */ export declare class ContactsApi extends BaseAPI { /** * * @summary Create NEW Contact * @param {WebitelContactsInputContact} input NEW Contact source changes * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ createContact(input: WebitelContactsInputContact, fields?: Array, options?: any): Promise>; /** * * @summary Remove Contact source * @param {string} etag Unique ID of the latest version of a resource. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ deleteContact(etag: string, fields?: Array, options?: any): Promise>; /** * * @summary Locate Contact source * @param {string} etag The Contact source IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Source Fields to return into result. * @param {'READ' | 'WRITE' | 'DELETE'} [mode] The requirement of a special access mode to the Source. - READ: Can `fetch` record. [GET] - WRITE: Can `update` record. [PUT|PATCH] - DELETE: Can `delete` record. [DELETE] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ locateContact(etag: string, fields?: Array, mode?: 'READ' | 'WRITE' | 'DELETE', options?: any): Promise>; /** * | Field | Type | ----------- | ---- | **----------- READ-ONLY -----------** | | `id` | int64 | `ver` | int32 | `etag` | string | **---------- OPERATIONAL ----------** | | `created_at` | int64(epoch:milli) | `created_by` | lookup(user) | `updated_at` | int64(epoch:milli) | `updated_by` | lookup(user) | **---------- ATTRIBUTES -----------** | | `name` | name! | `about` | string | `labels` | list[label!] | `emails` | list[email!] | `photos` | list[photo!] | `phones` | list[phone!] | `managers` | list[manager!] | `comments` | list[comment!] | `addresses` | list[address!] | `languages` | list[language!] | `timezones` | list[timezone!] | `variables` | list[variable!] | `imclients` | list[imClient!] * @summary Search for Contact(s) * @param {number} [page] Page number of result records. _default(1); offset=(size*(page-1));_ ```javascript let offset = 0 , page = req.page ; if (page <= 0) page = 1; if (page > 1) offset = ((page-1)*size); // . . . ``` * @param {number} [size] Limit of result page records count. _default(16); limit=(size<=0?-1:size+1);_ ```javascript const default = 16 , maximum = 32 ; let limit = req.size; if (limit <= 0) limit = default; if (maximum < limit) limit = maximum; // . . . ``` * @param {string} [q] Search term: `?` - matches any character `*` - matches 0 or more characters Used to query records within a set of `qin` fields, eg: name,emails{type},labels etc... * @param {Array} [sort] Sort result dataset of records by fields. ``` sort ::= *( ORDER name ) ORDER = ASC / DESC DESC = \"-\" / \"!\" ASC = [ \"+\" ] ; Default ``` Fields available - `id`(seq) - `domain`{name} - `created_at` - `created_by`{name} - `updated_at` - `updated_by`{name} Use ?fields=`field.sort()` option to sort Edge fields. * @param {Array} [fields] Fields [Q]uery to build result dataset record. ``` fields ::= field [ *( \",\" field ) ] field ::= name [ *( func ) ] [ inner ] inner ::= \"{\" fields \"}\" funcs ::= *( func ) func ::= \".\" name \"(\" [ args ] \")\" name ::= ALPHA / DIGIT / USCORE ALPHA = %x41-5A / %x61-7A ; \"A\"-\"Z\" / \"a\"-\"z\" DIGIT = %x30-39 ; \"0\"-\"9\" USCORE = %x5F ; underscore ; \"_\" ``` * @param {Array} [id] Records with unique IDentifier(s). Accept: `id` -or- `etag`. * @param {Array} [qin] [Q]uery[IN] is a set of search fields for term `q`. Default: `name{common_name}`. * @param {'READ' | 'WRITE' | 'DELETE'} [mode] Source access mode requirement. - READ: Can `fetch` record. [GET] - WRITE: Can `update` record. [PUT|PATCH] - DELETE: Can `delete` record. [DELETE] * @param {string} [notIdGroup] Excludes contacts that belong to the specified group ID. - Filters out contacts associated with the given `group_id`. * @param {Array} [group] Filters contacts by the specified group(s). - Includes only contacts that belong to one or more of the given group Group(s). * @param {Array} [owner] Filters contacts by the specified owner(s). - Includes only contacts whose owner matches one or more of the given Owner(s). - The owner ID corresponds to `contact_id` in the `directory.wbt_user` table. * @param {Array} [label] Filters contacts by the specified label(s). - Includes only contacts that have one or more of the given Label(s). * @param {boolean} [user] Filters contacts based on whether they are user-associated. - `true` → Includes only user-associated contacts. - `false` → Includes only contacts that are NOT user-associated. - A contact is considered user-associated if it exists in `directory.wbt_user`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ searchContacts(page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, qin?: Array, mode?: 'READ' | 'WRITE' | 'DELETE', notIdGroup?: string, group?: Array, owner?: Array, label?: Array, user?: boolean, options?: any): Promise>; /** * * @summary NEW Update of the Contact source * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWContactSourceChanges} input * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ updateContact(etag: string, input: NEWContactSourceChanges, fields?: Array, options?: any): Promise>; } //# sourceMappingURL=contacts-api.d.ts.map