/** * 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 { WebitelCasesCatalog } from '../api'; import { WebitelCasesCatalogList } from '../api'; import { WebitelCasesInputCatalog } from '../api'; import { WebitelCasesLocateCatalogResponse } from '../api'; /** * CatalogsApi - axios parameter creator * @export */ export declare const CatalogsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Create a new catalog * @param {WebitelCasesInputCatalog} input * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCatalog: (input: WebitelCasesInputCatalog, fields?: Array, options?: any) => Promise; /** * * @summary Delete a catalog * @param {Array} id ID of the catalog to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCatalog: (id: Array, options?: any) => Promise; /** * * @summary Retrieve a list of catalogs or search catalogs * @param {number} [page] Page number for pagination * @param {number} [size] Number of records per page * @param {Array} [fields] Fields to be retrieved as a result. If the user passes \"-\" as the value for fields, it will retrieve all available fields for each catalog. * @param {string} [sort] Sorting options by fields * @param {Array} [id] List of IDs to filter the catalogs * @param {string} [query] Search query string for filtering by name. Supports: - Wildcards (*) for substring matching - Placeholder (?) for single character substitution - Exact match for full names * @param {boolean} [state] Filter by state (true for active, false for inactive) * @param {string} [depth] Filter by the depth of the hierarchy to retrieve services. The depth indicates how many ancestor levels of services will be included for each catalog. - A depth of 0 includes only the direct catalog. - A depth of 1 includes the catalog and its immediate services. - By default the depth is limited by 3, meaning all nested services and sub-services will be included. * @param {Array} [subFields] Fields to be retrieved as a result for [SUBSERVICES]. If the user passes \"-\" as the value for fields, it will retrieve all available fields for each catalog subservices. * @param {boolean} [hasSubservices] Filter catalogs with subservices * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCatalogs: (page?: number, size?: number, fields?: Array, sort?: string, id?: Array, query?: string, state?: boolean, depth?: string, subFields?: Array, hasSubservices?: boolean, options?: any) => Promise; /** * * @summary Locate a catalog by ID * @param {string} id ID of the catalog to be located * @param {Array} [fields] Fields to be retrieved as a result. If the user passes \"-\" as the value for fields, it will retrieve all available fields for each catalog. * @param {Array} [subFields] Fields to be retrieved as a result for [SUBSERVICES]. If the user passes \"-\" as the value for fields, it will retrieve all available fields for each catalog subservices. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateCatalog: (id: string, fields?: Array, subFields?: Array, options?: any) => Promise; /** * * @summary Update an existing catalog * @param {string} id ID of the catalog to be updated * @param {WebitelCasesInputCatalog} input Input data for updating the catalog * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCatalog: (id: string, input: WebitelCasesInputCatalog, fields?: Array, options?: any) => Promise; /** * * @summary Update an existing catalog * @param {string} id ID of the catalog to be updated * @param {WebitelCasesInputCatalog} input Input data for updating the catalog * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCatalog2: (id: string, input: WebitelCasesInputCatalog, fields?: Array, options?: any) => Promise; }; /** * CatalogsApi - functional programming interface * @export */ export declare const CatalogsApiFp: (configuration?: Configuration) => { /** * * @summary Create a new catalog * @param {WebitelCasesInputCatalog} input * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCatalog(input: WebitelCasesInputCatalog, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Delete a catalog * @param {Array} id ID of the catalog to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCatalog(id: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Retrieve a list of catalogs or search catalogs * @param {number} [page] Page number for pagination * @param {number} [size] Number of records per page * @param {Array} [fields] Fields to be retrieved as a result. If the user passes \"-\" as the value for fields, it will retrieve all available fields for each catalog. * @param {string} [sort] Sorting options by fields * @param {Array} [id] List of IDs to filter the catalogs * @param {string} [query] Search query string for filtering by name. Supports: - Wildcards (*) for substring matching - Placeholder (?) for single character substitution - Exact match for full names * @param {boolean} [state] Filter by state (true for active, false for inactive) * @param {string} [depth] Filter by the depth of the hierarchy to retrieve services. The depth indicates how many ancestor levels of services will be included for each catalog. - A depth of 0 includes only the direct catalog. - A depth of 1 includes the catalog and its immediate services. - By default the depth is limited by 3, meaning all nested services and sub-services will be included. * @param {Array} [subFields] Fields to be retrieved as a result for [SUBSERVICES]. If the user passes \"-\" as the value for fields, it will retrieve all available fields for each catalog subservices. * @param {boolean} [hasSubservices] Filter catalogs with subservices * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCatalogs(page?: number, size?: number, fields?: Array, sort?: string, id?: Array, query?: string, state?: boolean, depth?: string, subFields?: Array, hasSubservices?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Locate a catalog by ID * @param {string} id ID of the catalog to be located * @param {Array} [fields] Fields to be retrieved as a result. If the user passes \"-\" as the value for fields, it will retrieve all available fields for each catalog. * @param {Array} [subFields] Fields to be retrieved as a result for [SUBSERVICES]. If the user passes \"-\" as the value for fields, it will retrieve all available fields for each catalog subservices. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateCatalog(id: string, fields?: Array, subFields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update an existing catalog * @param {string} id ID of the catalog to be updated * @param {WebitelCasesInputCatalog} input Input data for updating the catalog * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCatalog(id: string, input: WebitelCasesInputCatalog, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update an existing catalog * @param {string} id ID of the catalog to be updated * @param {WebitelCasesInputCatalog} input Input data for updating the catalog * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCatalog2(id: string, input: WebitelCasesInputCatalog, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CatalogsApi - factory interface * @export */ export declare const CatalogsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Create a new catalog * @param {WebitelCasesInputCatalog} input * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCatalog(input: WebitelCasesInputCatalog, fields?: Array, options?: any): AxiosPromise; /** * * @summary Delete a catalog * @param {Array} id ID of the catalog to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCatalog(id: Array, options?: any): AxiosPromise; /** * * @summary Retrieve a list of catalogs or search catalogs * @param {number} [page] Page number for pagination * @param {number} [size] Number of records per page * @param {Array} [fields] Fields to be retrieved as a result. If the user passes \"-\" as the value for fields, it will retrieve all available fields for each catalog. * @param {string} [sort] Sorting options by fields * @param {Array} [id] List of IDs to filter the catalogs * @param {string} [query] Search query string for filtering by name. Supports: - Wildcards (*) for substring matching - Placeholder (?) for single character substitution - Exact match for full names * @param {boolean} [state] Filter by state (true for active, false for inactive) * @param {string} [depth] Filter by the depth of the hierarchy to retrieve services. The depth indicates how many ancestor levels of services will be included for each catalog. - A depth of 0 includes only the direct catalog. - A depth of 1 includes the catalog and its immediate services. - By default the depth is limited by 3, meaning all nested services and sub-services will be included. * @param {Array} [subFields] Fields to be retrieved as a result for [SUBSERVICES]. If the user passes \"-\" as the value for fields, it will retrieve all available fields for each catalog subservices. * @param {boolean} [hasSubservices] Filter catalogs with subservices * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCatalogs(page?: number, size?: number, fields?: Array, sort?: string, id?: Array, query?: string, state?: boolean, depth?: string, subFields?: Array, hasSubservices?: boolean, options?: any): AxiosPromise; /** * * @summary Locate a catalog by ID * @param {string} id ID of the catalog to be located * @param {Array} [fields] Fields to be retrieved as a result. If the user passes \"-\" as the value for fields, it will retrieve all available fields for each catalog. * @param {Array} [subFields] Fields to be retrieved as a result for [SUBSERVICES]. If the user passes \"-\" as the value for fields, it will retrieve all available fields for each catalog subservices. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateCatalog(id: string, fields?: Array, subFields?: Array, options?: any): AxiosPromise; /** * * @summary Update an existing catalog * @param {string} id ID of the catalog to be updated * @param {WebitelCasesInputCatalog} input Input data for updating the catalog * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCatalog(id: string, input: WebitelCasesInputCatalog, fields?: Array, options?: any): AxiosPromise; /** * * @summary Update an existing catalog * @param {string} id ID of the catalog to be updated * @param {WebitelCasesInputCatalog} input Input data for updating the catalog * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCatalog2(id: string, input: WebitelCasesInputCatalog, fields?: Array, options?: any): AxiosPromise; }; /** * CatalogsApi - object-oriented interface * @export * @class CatalogsApi * @extends {BaseAPI} */ export declare class CatalogsApi extends BaseAPI { /** * * @summary Create a new catalog * @param {WebitelCasesInputCatalog} input * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CatalogsApi */ createCatalog(input: WebitelCasesInputCatalog, fields?: Array, options?: any): Promise>; /** * * @summary Delete a catalog * @param {Array} id ID of the catalog to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CatalogsApi */ deleteCatalog(id: Array, options?: any): Promise>; /** * * @summary Retrieve a list of catalogs or search catalogs * @param {number} [page] Page number for pagination * @param {number} [size] Number of records per page * @param {Array} [fields] Fields to be retrieved as a result. If the user passes \"-\" as the value for fields, it will retrieve all available fields for each catalog. * @param {string} [sort] Sorting options by fields * @param {Array} [id] List of IDs to filter the catalogs * @param {string} [query] Search query string for filtering by name. Supports: - Wildcards (*) for substring matching - Placeholder (?) for single character substitution - Exact match for full names * @param {boolean} [state] Filter by state (true for active, false for inactive) * @param {string} [depth] Filter by the depth of the hierarchy to retrieve services. The depth indicates how many ancestor levels of services will be included for each catalog. - A depth of 0 includes only the direct catalog. - A depth of 1 includes the catalog and its immediate services. - By default the depth is limited by 3, meaning all nested services and sub-services will be included. * @param {Array} [subFields] Fields to be retrieved as a result for [SUBSERVICES]. If the user passes \"-\" as the value for fields, it will retrieve all available fields for each catalog subservices. * @param {boolean} [hasSubservices] Filter catalogs with subservices * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CatalogsApi */ listCatalogs(page?: number, size?: number, fields?: Array, sort?: string, id?: Array, query?: string, state?: boolean, depth?: string, subFields?: Array, hasSubservices?: boolean, options?: any): Promise>; /** * * @summary Locate a catalog by ID * @param {string} id ID of the catalog to be located * @param {Array} [fields] Fields to be retrieved as a result. If the user passes \"-\" as the value for fields, it will retrieve all available fields for each catalog. * @param {Array} [subFields] Fields to be retrieved as a result for [SUBSERVICES]. If the user passes \"-\" as the value for fields, it will retrieve all available fields for each catalog subservices. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CatalogsApi */ locateCatalog(id: string, fields?: Array, subFields?: Array, options?: any): Promise>; /** * * @summary Update an existing catalog * @param {string} id ID of the catalog to be updated * @param {WebitelCasesInputCatalog} input Input data for updating the catalog * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CatalogsApi */ updateCatalog(id: string, input: WebitelCasesInputCatalog, fields?: Array, options?: any): Promise>; /** * * @summary Update an existing catalog * @param {string} id ID of the catalog to be updated * @param {WebitelCasesInputCatalog} input Input data for updating the catalog * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CatalogsApi */ updateCatalog2(id: string, input: WebitelCasesInputCatalog, fields?: Array, options?: any): Promise>; } //# sourceMappingURL=catalogs-api.d.ts.map