/** * 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 { WebitelProtoDataInputExtension } from '../api'; import { WebitelProtoDataStruct } from '../api'; import { WebitelProtoDataStructList } from '../api'; /** * ExtensionsApi - axios parameter creator * @export */ export declare const ExtensionsApiAxiosParamCreator: (configuration?: Configuration) => { /** * returns (Extension) { * @summary Create type extension. * @param {string} repo SUPER `types.repo` to extend, e.g.: `contacts`. Lookup: GET /types?extendable=true * @param {WebitelProtoDataInputExtension} input Extension type fields. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createType: (repo: string, input: WebitelProtoDataInputExtension, options?: any) => Promise; /** * returns (ExtensionList) { * @summary Delete extension for types. * @param {Array} repo `type.repo` * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteType: (repo: Array, fields?: Array, options?: any) => Promise; /** * returns (ExtensionList) { * @summary Delete extension for types. * @param {Array} [fields] * @param {Array} [repo] `type.repo` * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteType2: (fields?: Array, repo?: Array, options?: any) => Promise; /** * returns (Extension) { * @summary Type extension details. * @param {string} repo `type.repo` id * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateType: (repo: string, options?: any) => Promise; /** * (ExtensionList) { * @summary Search for type extensions. * @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] extension.type.id * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchType: (size?: number, page?: number, sort?: Array, fields?: Array, q?: string, id?: Array, options?: any) => Promise; /** * returns (Extension) { * @summary Update type extension. * @param {string} repo `type.repo` * @param {WebitelProtoDataInputExtension} input * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateType: (repo: string, input: WebitelProtoDataInputExtension, options?: any) => Promise; }; /** * ExtensionsApi - functional programming interface * @export */ export declare const ExtensionsApiFp: (configuration?: Configuration) => { /** * returns (Extension) { * @summary Create type extension. * @param {string} repo SUPER `types.repo` to extend, e.g.: `contacts`. Lookup: GET /types?extendable=true * @param {WebitelProtoDataInputExtension} input Extension type fields. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createType(repo: string, input: WebitelProtoDataInputExtension, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * returns (ExtensionList) { * @summary Delete extension for types. * @param {Array} repo `type.repo` * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteType(repo: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * returns (ExtensionList) { * @summary Delete extension for types. * @param {Array} [fields] * @param {Array} [repo] `type.repo` * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteType2(fields?: Array, repo?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * returns (Extension) { * @summary Type extension details. * @param {string} repo `type.repo` id * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateType(repo: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * (ExtensionList) { * @summary Search for type extensions. * @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] extension.type.id * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchType(size?: number, page?: number, sort?: Array, fields?: Array, q?: string, id?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * returns (Extension) { * @summary Update type extension. * @param {string} repo `type.repo` * @param {WebitelProtoDataInputExtension} input * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateType(repo: string, input: WebitelProtoDataInputExtension, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ExtensionsApi - factory interface * @export */ export declare const ExtensionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * returns (Extension) { * @summary Create type extension. * @param {string} repo SUPER `types.repo` to extend, e.g.: `contacts`. Lookup: GET /types?extendable=true * @param {WebitelProtoDataInputExtension} input Extension type fields. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createType(repo: string, input: WebitelProtoDataInputExtension, options?: any): AxiosPromise; /** * returns (ExtensionList) { * @summary Delete extension for types. * @param {Array} repo `type.repo` * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteType(repo: Array, fields?: Array, options?: any): AxiosPromise; /** * returns (ExtensionList) { * @summary Delete extension for types. * @param {Array} [fields] * @param {Array} [repo] `type.repo` * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteType2(fields?: Array, repo?: Array, options?: any): AxiosPromise; /** * returns (Extension) { * @summary Type extension details. * @param {string} repo `type.repo` id * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateType(repo: string, options?: any): AxiosPromise; /** * (ExtensionList) { * @summary Search for type extensions. * @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] extension.type.id * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchType(size?: number, page?: number, sort?: Array, fields?: Array, q?: string, id?: Array, options?: any): AxiosPromise; /** * returns (Extension) { * @summary Update type extension. * @param {string} repo `type.repo` * @param {WebitelProtoDataInputExtension} input * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateType(repo: string, input: WebitelProtoDataInputExtension, options?: any): AxiosPromise; }; /** * ExtensionsApi - object-oriented interface * @export * @class ExtensionsApi * @extends {BaseAPI} */ export declare class ExtensionsApi extends BaseAPI { /** * returns (Extension) { * @summary Create type extension. * @param {string} repo SUPER `types.repo` to extend, e.g.: `contacts`. Lookup: GET /types?extendable=true * @param {WebitelProtoDataInputExtension} input Extension type fields. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExtensionsApi */ createType(repo: string, input: WebitelProtoDataInputExtension, options?: any): Promise>; /** * returns (ExtensionList) { * @summary Delete extension for types. * @param {Array} repo `type.repo` * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExtensionsApi */ deleteType(repo: Array, fields?: Array, options?: any): Promise>; /** * returns (ExtensionList) { * @summary Delete extension for types. * @param {Array} [fields] * @param {Array} [repo] `type.repo` * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExtensionsApi */ deleteType2(fields?: Array, repo?: Array, options?: any): Promise>; /** * returns (Extension) { * @summary Type extension details. * @param {string} repo `type.repo` id * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExtensionsApi */ locateType(repo: string, options?: any): Promise>; /** * (ExtensionList) { * @summary Search for type extensions. * @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] extension.type.id * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExtensionsApi */ searchType(size?: number, page?: number, sort?: Array, fields?: Array, q?: string, id?: Array, options?: any): Promise>; /** * returns (Extension) { * @summary Update type extension. * @param {string} repo `type.repo` * @param {WebitelProtoDataInputExtension} input * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExtensionsApi */ updateType(repo: string, input: WebitelProtoDataInputExtension, options?: any): Promise>; } //# sourceMappingURL=extensions-api.d.ts.map