/** * 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 { InlineObject2 } from '../api'; import { WebitelProtoDataDataset } from '../api'; import { WebitelProtoDataInputDictionary } from '../api'; import { WebitelProtoDataStruct } from '../api'; import { WebitelProtoDataStructList } from '../api'; /** * DictionariesApi - axios parameter creator * @export */ export declare const DictionariesApiAxiosParamCreator: (configuration?: Configuration) => { /** * (Record) { * @summary Create a dictionary record. * @param {string} repo [`types.repo`] * @param {object} record Record data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createData: (repo: string, record: object, options?: any) => Promise; /** * (Dictionary) { * @summary Create custom dictionary. * @param {string} repo NEW [`types.repo`] repository name, e.g.: `countries`. * @param {WebitelProtoDataInputDictionary} input NEW dictionary [type] definition. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createType: (repo: string, input: WebitelProtoDataInputDictionary, options?: any) => Promise; /** * * @summary Delete a dictionary records. * @param {string} repo [`types.repo`] * @param {Array} id [`record.id`] * @param {Array} [fields] Fields to be retrieved into result dataset. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteData: (repo: string, id: Array, fields?: Array, options?: any) => Promise; /** * * @summary Delete a dictionary records. * @param {string} repo [`types.repo`] * @param {Array} id [`record.id`] * @param {Array} [fields] Fields to be retrieved into result dataset. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteData2: (repo: string, id: Array, fields?: Array, options?: any) => Promise; /** * (DictionaryList) { * @summary Delete custom dictionaries. * @param {Array} repo `types.repo` // `record.pk` repeated string id = 3; * @param {Array} [fields] Fields to retrive into result dataset. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteType: (repo: Array, fields?: Array, options?: any) => Promise; /** * * @summary Import dataset from CSV file. * @param {string} repo `types.repo` * @param {InlineObject2} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ importCSV: (repo: string, body: InlineObject2, options?: any) => Promise; /** * (Record) { * @summary Locate a dictionary record. * @param {string} repo [`types.repo`] * @param {string} id [`record.id`] * @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 {*} [options] Override http request option. * @throws {RequiredError} */ locateData: (repo: string, id: string, fields?: Array, options?: any) => Promise; /** * (Dictionary) { * @summary Locate the dictionary type. * @param {string} repo `types.repo` * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateType: (repo: string, options?: any) => Promise; /** * * @summary Lookup a dictionary dataset. * @param {string} repo [`types.repo`] * @param {number} [size] Number of result records (per page). Default: 16. * @param {number} [page] Page number of result set of records. Default: 1. * @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 {string} [q] Search term: `?` - matches any character `*` - matches 0 or more characters e.g.: name,emails{type},labels etc... * @param {Array} [id] [`record.id`] * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchData: (repo: string, size?: number, page?: number, sort?: Array, fields?: Array, q?: string, id?: Array, options?: any) => Promise; /** * * @summary Lookup dictionaries data types. * @param {string} [q] Search term: `?` - matches any character `*` - matches 0 or more characters e.g.: name,emails{type},labels etc... * @param {string} [id] `types.id` * @param {string} [name] `types.name` * @param {string} [repo] `types.repo` * @param {string} [path] `types.path` * @param {boolean} [readonly] [NOT] [ system / custom ] types only * @param {boolean} [extendable] [NOT] Extend[able] types only. * @param {boolean} [extensions] [NOT] include extensions/_* types. * @param {boolean} [extended] [NOT] Extend[ed] types only. * @param {boolean} [administered] [NOT] Administer access control only * @param {number} [size] Number of result records (per page). Default: 16. * @param {number} [page] Page number of result set of records. Default: 1. * @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 {*} [options] Override http request option. * @throws {RequiredError} */ searchType: (q?: string, id?: string, name?: string, repo?: string, path?: string, readonly?: boolean, extendable?: boolean, extensions?: boolean, extended?: boolean, administered?: boolean, size?: number, page?: number, sort?: Array, fields?: Array, options?: any) => Promise; /** * (Record) { * @summary Update a dictionary record. * @param {string} repo [`types.repo`] data source * @param {string} id [`record.id`] for update * @param {object} record Record data fields changes. * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateData: (repo: string, id: string, record: object, fields?: Array, options?: any) => Promise; /** * (Record) { * @summary Update a dictionary record. * @param {string} repo [`types.repo`] data source * @param {string} id [`record.id`] for update * @param {object} record Record data fields changes. * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateData2: (repo: string, id: string, record: object, fields?: Array, options?: any) => Promise; /** * (Dictionary) { * @summary Update custom dictionary. * @param {string} repo [**repo**] name of the dataset type, e.g.: `countries`. * @param {WebitelProtoDataInputDictionary} input The dictionary [**type**] changes. * @param {Array} [fields] Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateType: (repo: string, input: WebitelProtoDataInputDictionary, fields?: Array, options?: any) => Promise; }; /** * DictionariesApi - functional programming interface * @export */ export declare const DictionariesApiFp: (configuration?: Configuration) => { /** * (Record) { * @summary Create a dictionary record. * @param {string} repo [`types.repo`] * @param {object} record Record data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createData(repo: string, record: object, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * (Dictionary) { * @summary Create custom dictionary. * @param {string} repo NEW [`types.repo`] repository name, e.g.: `countries`. * @param {WebitelProtoDataInputDictionary} input NEW dictionary [type] definition. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createType(repo: string, input: WebitelProtoDataInputDictionary, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Delete a dictionary records. * @param {string} repo [`types.repo`] * @param {Array} id [`record.id`] * @param {Array} [fields] Fields to be retrieved into result dataset. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteData(repo: string, id: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Delete a dictionary records. * @param {string} repo [`types.repo`] * @param {Array} id [`record.id`] * @param {Array} [fields] Fields to be retrieved into result dataset. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteData2(repo: string, id: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * (DictionaryList) { * @summary Delete custom dictionaries. * @param {Array} repo `types.repo` // `record.pk` repeated string id = 3; * @param {Array} [fields] Fields to retrive into result dataset. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteType(repo: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Import dataset from CSV file. * @param {string} repo `types.repo` * @param {InlineObject2} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ importCSV(repo: string, body: InlineObject2, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * (Record) { * @summary Locate a dictionary record. * @param {string} repo [`types.repo`] * @param {string} id [`record.id`] * @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 {*} [options] Override http request option. * @throws {RequiredError} */ locateData(repo: string, id: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * (Dictionary) { * @summary Locate the dictionary type. * @param {string} repo `types.repo` * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateType(repo: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Lookup a dictionary dataset. * @param {string} repo [`types.repo`] * @param {number} [size] Number of result records (per page). Default: 16. * @param {number} [page] Page number of result set of records. Default: 1. * @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 {string} [q] Search term: `?` - matches any character `*` - matches 0 or more characters e.g.: name,emails{type},labels etc... * @param {Array} [id] [`record.id`] * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchData(repo: string, size?: number, page?: number, sort?: Array, fields?: Array, q?: string, id?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Lookup dictionaries data types. * @param {string} [q] Search term: `?` - matches any character `*` - matches 0 or more characters e.g.: name,emails{type},labels etc... * @param {string} [id] `types.id` * @param {string} [name] `types.name` * @param {string} [repo] `types.repo` * @param {string} [path] `types.path` * @param {boolean} [readonly] [NOT] [ system / custom ] types only * @param {boolean} [extendable] [NOT] Extend[able] types only. * @param {boolean} [extensions] [NOT] include extensions/_* types. * @param {boolean} [extended] [NOT] Extend[ed] types only. * @param {boolean} [administered] [NOT] Administer access control only * @param {number} [size] Number of result records (per page). Default: 16. * @param {number} [page] Page number of result set of records. Default: 1. * @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 {*} [options] Override http request option. * @throws {RequiredError} */ searchType(q?: string, id?: string, name?: string, repo?: string, path?: string, readonly?: boolean, extendable?: boolean, extensions?: boolean, extended?: boolean, administered?: boolean, size?: number, page?: number, sort?: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * (Record) { * @summary Update a dictionary record. * @param {string} repo [`types.repo`] data source * @param {string} id [`record.id`] for update * @param {object} record Record data fields changes. * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateData(repo: string, id: string, record: object, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * (Record) { * @summary Update a dictionary record. * @param {string} repo [`types.repo`] data source * @param {string} id [`record.id`] for update * @param {object} record Record data fields changes. * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateData2(repo: string, id: string, record: object, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * (Dictionary) { * @summary Update custom dictionary. * @param {string} repo [**repo**] name of the dataset type, e.g.: `countries`. * @param {WebitelProtoDataInputDictionary} input The dictionary [**type**] changes. * @param {Array} [fields] Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateType(repo: string, input: WebitelProtoDataInputDictionary, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DictionariesApi - factory interface * @export */ export declare const DictionariesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * (Record) { * @summary Create a dictionary record. * @param {string} repo [`types.repo`] * @param {object} record Record data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createData(repo: string, record: object, options?: any): AxiosPromise; /** * (Dictionary) { * @summary Create custom dictionary. * @param {string} repo NEW [`types.repo`] repository name, e.g.: `countries`. * @param {WebitelProtoDataInputDictionary} input NEW dictionary [type] definition. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createType(repo: string, input: WebitelProtoDataInputDictionary, options?: any): AxiosPromise; /** * * @summary Delete a dictionary records. * @param {string} repo [`types.repo`] * @param {Array} id [`record.id`] * @param {Array} [fields] Fields to be retrieved into result dataset. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteData(repo: string, id: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary Delete a dictionary records. * @param {string} repo [`types.repo`] * @param {Array} id [`record.id`] * @param {Array} [fields] Fields to be retrieved into result dataset. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteData2(repo: string, id: Array, fields?: Array, options?: any): AxiosPromise; /** * (DictionaryList) { * @summary Delete custom dictionaries. * @param {Array} repo `types.repo` // `record.pk` repeated string id = 3; * @param {Array} [fields] Fields to retrive into result dataset. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteType(repo: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary Import dataset from CSV file. * @param {string} repo `types.repo` * @param {InlineObject2} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ importCSV(repo: string, body: InlineObject2, options?: any): AxiosPromise; /** * (Record) { * @summary Locate a dictionary record. * @param {string} repo [`types.repo`] * @param {string} id [`record.id`] * @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 {*} [options] Override http request option. * @throws {RequiredError} */ locateData(repo: string, id: string, fields?: Array, options?: any): AxiosPromise; /** * (Dictionary) { * @summary Locate the dictionary type. * @param {string} repo `types.repo` * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateType(repo: string, options?: any): AxiosPromise; /** * * @summary Lookup a dictionary dataset. * @param {string} repo [`types.repo`] * @param {number} [size] Number of result records (per page). Default: 16. * @param {number} [page] Page number of result set of records. Default: 1. * @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 {string} [q] Search term: `?` - matches any character `*` - matches 0 or more characters e.g.: name,emails{type},labels etc... * @param {Array} [id] [`record.id`] * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchData(repo: string, size?: number, page?: number, sort?: Array, fields?: Array, q?: string, id?: Array, options?: any): AxiosPromise; /** * * @summary Lookup dictionaries data types. * @param {string} [q] Search term: `?` - matches any character `*` - matches 0 or more characters e.g.: name,emails{type},labels etc... * @param {string} [id] `types.id` * @param {string} [name] `types.name` * @param {string} [repo] `types.repo` * @param {string} [path] `types.path` * @param {boolean} [readonly] [NOT] [ system / custom ] types only * @param {boolean} [extendable] [NOT] Extend[able] types only. * @param {boolean} [extensions] [NOT] include extensions/_* types. * @param {boolean} [extended] [NOT] Extend[ed] types only. * @param {boolean} [administered] [NOT] Administer access control only * @param {number} [size] Number of result records (per page). Default: 16. * @param {number} [page] Page number of result set of records. Default: 1. * @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 {*} [options] Override http request option. * @throws {RequiredError} */ searchType(q?: string, id?: string, name?: string, repo?: string, path?: string, readonly?: boolean, extendable?: boolean, extensions?: boolean, extended?: boolean, administered?: boolean, size?: number, page?: number, sort?: Array, fields?: Array, options?: any): AxiosPromise; /** * (Record) { * @summary Update a dictionary record. * @param {string} repo [`types.repo`] data source * @param {string} id [`record.id`] for update * @param {object} record Record data fields changes. * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateData(repo: string, id: string, record: object, fields?: Array, options?: any): AxiosPromise; /** * (Record) { * @summary Update a dictionary record. * @param {string} repo [`types.repo`] data source * @param {string} id [`record.id`] for update * @param {object} record Record data fields changes. * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateData2(repo: string, id: string, record: object, fields?: Array, options?: any): AxiosPromise; /** * (Dictionary) { * @summary Update custom dictionary. * @param {string} repo [**repo**] name of the dataset type, e.g.: `countries`. * @param {WebitelProtoDataInputDictionary} input The dictionary [**type**] changes. * @param {Array} [fields] Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateType(repo: string, input: WebitelProtoDataInputDictionary, fields?: Array, options?: any): AxiosPromise; }; /** * DictionariesApi - object-oriented interface * @export * @class DictionariesApi * @extends {BaseAPI} */ export declare class DictionariesApi extends BaseAPI { /** * (Record) { * @summary Create a dictionary record. * @param {string} repo [`types.repo`] * @param {object} record Record data. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DictionariesApi */ createData(repo: string, record: object, options?: any): Promise>; /** * (Dictionary) { * @summary Create custom dictionary. * @param {string} repo NEW [`types.repo`] repository name, e.g.: `countries`. * @param {WebitelProtoDataInputDictionary} input NEW dictionary [type] definition. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DictionariesApi */ createType(repo: string, input: WebitelProtoDataInputDictionary, options?: any): Promise>; /** * * @summary Delete a dictionary records. * @param {string} repo [`types.repo`] * @param {Array} id [`record.id`] * @param {Array} [fields] Fields to be retrieved into result dataset. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DictionariesApi */ deleteData(repo: string, id: Array, fields?: Array, options?: any): Promise>; /** * * @summary Delete a dictionary records. * @param {string} repo [`types.repo`] * @param {Array} id [`record.id`] * @param {Array} [fields] Fields to be retrieved into result dataset. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DictionariesApi */ deleteData2(repo: string, id: Array, fields?: Array, options?: any): Promise>; /** * (DictionaryList) { * @summary Delete custom dictionaries. * @param {Array} repo `types.repo` // `record.pk` repeated string id = 3; * @param {Array} [fields] Fields to retrive into result dataset. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DictionariesApi */ deleteType(repo: Array, fields?: Array, options?: any): Promise>; /** * * @summary Import dataset from CSV file. * @param {string} repo `types.repo` * @param {InlineObject2} body * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DictionariesApi */ importCSV(repo: string, body: InlineObject2, options?: any): Promise>; /** * (Record) { * @summary Locate a dictionary record. * @param {string} repo [`types.repo`] * @param {string} id [`record.id`] * @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 {*} [options] Override http request option. * @throws {RequiredError} * @memberof DictionariesApi */ locateData(repo: string, id: string, fields?: Array, options?: any): Promise>; /** * (Dictionary) { * @summary Locate the dictionary type. * @param {string} repo `types.repo` * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DictionariesApi */ locateType(repo: string, options?: any): Promise>; /** * * @summary Lookup a dictionary dataset. * @param {string} repo [`types.repo`] * @param {number} [size] Number of result records (per page). Default: 16. * @param {number} [page] Page number of result set of records. Default: 1. * @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 {string} [q] Search term: `?` - matches any character `*` - matches 0 or more characters e.g.: name,emails{type},labels etc... * @param {Array} [id] [`record.id`] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DictionariesApi */ searchData(repo: string, size?: number, page?: number, sort?: Array, fields?: Array, q?: string, id?: Array, options?: any): Promise>; /** * * @summary Lookup dictionaries data types. * @param {string} [q] Search term: `?` - matches any character `*` - matches 0 or more characters e.g.: name,emails{type},labels etc... * @param {string} [id] `types.id` * @param {string} [name] `types.name` * @param {string} [repo] `types.repo` * @param {string} [path] `types.path` * @param {boolean} [readonly] [NOT] [ system / custom ] types only * @param {boolean} [extendable] [NOT] Extend[able] types only. * @param {boolean} [extensions] [NOT] include extensions/_* types. * @param {boolean} [extended] [NOT] Extend[ed] types only. * @param {boolean} [administered] [NOT] Administer access control only * @param {number} [size] Number of result records (per page). Default: 16. * @param {number} [page] Page number of result set of records. Default: 1. * @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 {*} [options] Override http request option. * @throws {RequiredError} * @memberof DictionariesApi */ searchType(q?: string, id?: string, name?: string, repo?: string, path?: string, readonly?: boolean, extendable?: boolean, extensions?: boolean, extended?: boolean, administered?: boolean, size?: number, page?: number, sort?: Array, fields?: Array, options?: any): Promise>; /** * (Record) { * @summary Update a dictionary record. * @param {string} repo [`types.repo`] data source * @param {string} id [`record.id`] for update * @param {object} record Record data fields changes. * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DictionariesApi */ updateData(repo: string, id: string, record: object, fields?: Array, options?: any): Promise>; /** * (Record) { * @summary Update a dictionary record. * @param {string} repo [`types.repo`] data source * @param {string} id [`record.id`] for update * @param {object} record Record data fields changes. * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DictionariesApi */ updateData2(repo: string, id: string, record: object, fields?: Array, options?: any): Promise>; /** * (Dictionary) { * @summary Update custom dictionary. * @param {string} repo [**repo**] name of the dataset type, e.g.: `countries`. * @param {WebitelProtoDataInputDictionary} input The dictionary [**type**] changes. * @param {Array} [fields] Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DictionariesApi */ updateType(repo: string, input: WebitelProtoDataInputDictionary, fields?: Array, options?: any): Promise>; } //# sourceMappingURL=dictionaries-api.d.ts.map