/** * 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 { NEWSpaceSourceChanges } from '../api'; import { WebitelKnowledgebaseInputSpace } from '../api'; import { WebitelKnowledgebaseSpace } from '../api'; import { WebitelKnowledgebaseSpaceList } from '../api'; /** * SpacesApi - axios parameter creator * @export */ export declare const SpacesApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Create NEW Space * @param {Array} input NEW Spaces source changes * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSpace: (input: Array, fields?: Array, options?: any) => Promise; /** * * @summary Remove Space 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} */ deleteSpace: (etag: string, fields?: Array, 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! | `home_page` | string (home_page) | `state` | bool | `has_children`| bool * @param {number} [page] * @param {number} [size] Limit of result page records count. _default(16); limit=(size<=0?-1:size+1);_ ```javascript const default = 16 , maximum = 32 ; ``` * @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, 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} - `state` * @param {Array} [fields] * @param {Array} [id] Records with unique IDentifier(s). Accept: `id` -or- `etag`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSpaces: (page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, options?: any) => Promise; /** * * @summary Locate spaces source * @param {string} etag The Space source IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateSpace: (etag: string, fields?: Array, options?: any) => Promise; /** * * @summary NEW Update of the Space source * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWSpaceSourceChanges} input * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSpace: (etag: string, input: NEWSpaceSourceChanges, fields?: Array, options?: any) => Promise; }; /** * SpacesApi - functional programming interface * @export */ export declare const SpacesApiFp: (configuration?: Configuration) => { /** * * @summary Create NEW Space * @param {Array} input NEW Spaces source changes * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSpace(input: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Remove Space 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} */ deleteSpace(etag: string, fields?: Array, 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! | `home_page` | string (home_page) | `state` | bool | `has_children`| bool * @param {number} [page] * @param {number} [size] Limit of result page records count. _default(16); limit=(size<=0?-1:size+1);_ ```javascript const default = 16 , maximum = 32 ; ``` * @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, 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} - `state` * @param {Array} [fields] * @param {Array} [id] Records with unique IDentifier(s). Accept: `id` -or- `etag`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSpaces(page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Locate spaces source * @param {string} etag The Space source IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateSpace(etag: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary NEW Update of the Space source * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWSpaceSourceChanges} input * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSpace(etag: string, input: NEWSpaceSourceChanges, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SpacesApi - factory interface * @export */ export declare const SpacesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Create NEW Space * @param {Array} input NEW Spaces source changes * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSpace(input: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary Remove Space 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} */ deleteSpace(etag: string, fields?: Array, 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! | `home_page` | string (home_page) | `state` | bool | `has_children`| bool * @param {number} [page] * @param {number} [size] Limit of result page records count. _default(16); limit=(size<=0?-1:size+1);_ ```javascript const default = 16 , maximum = 32 ; ``` * @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, 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} - `state` * @param {Array} [fields] * @param {Array} [id] Records with unique IDentifier(s). Accept: `id` -or- `etag`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSpaces(page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, options?: any): AxiosPromise; /** * * @summary Locate spaces source * @param {string} etag The Space source IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateSpace(etag: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary NEW Update of the Space source * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWSpaceSourceChanges} input * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSpace(etag: string, input: NEWSpaceSourceChanges, fields?: Array, options?: any): AxiosPromise; }; /** * SpacesApi - object-oriented interface * @export * @class SpacesApi * @extends {BaseAPI} */ export declare class SpacesApi extends BaseAPI { /** * * @summary Create NEW Space * @param {Array} input NEW Spaces source changes * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SpacesApi */ createSpace(input: Array, fields?: Array, options?: any): Promise>; /** * * @summary Remove Space 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 SpacesApi */ deleteSpace(etag: string, fields?: Array, 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! | `home_page` | string (home_page) | `state` | bool | `has_children`| bool * @param {number} [page] * @param {number} [size] Limit of result page records count. _default(16); limit=(size<=0?-1:size+1);_ ```javascript const default = 16 , maximum = 32 ; ``` * @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, 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} - `state` * @param {Array} [fields] * @param {Array} [id] Records with unique IDentifier(s). Accept: `id` -or- `etag`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SpacesApi */ listSpaces(page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, options?: any): Promise>; /** * * @summary Locate spaces source * @param {string} etag The Space source IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SpacesApi */ locateSpace(etag: string, fields?: Array, options?: any): Promise>; /** * * @summary NEW Update of the Space source * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWSpaceSourceChanges} input * @param {Array} [fields] Source Fields to return into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SpacesApi */ updateSpace(etag: string, input: NEWSpaceSourceChanges, fields?: Array, options?: any): Promise>; } //# sourceMappingURL=spaces-api.d.ts.map