/** * Cloud API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * 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 { DashboardDto } from '../models'; import { DashboardPageDto } from '../models'; import { DashboardSearchResultPageDto } from '../models'; import { SearchRequestDto } from '../models'; /** * DashboardsApi - axios parameter creator * @export */ export declare const DashboardsApiAxiosParamCreator: (axiosClientConfiguration?: Configuration) => { /** * * @param {DashboardDto} dashboard * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDashboard: (dashboard: DashboardDto, translate?: string, options?: any) => Promise; /** * This is a very performant method for checking if a Dashboard exists. * @summary Check if Dashboard exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ dashboardExists: (id: string, options?: any) => Promise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDashboard: (id: string, translate?: string, options?: any) => Promise; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyDashboards: (ids: Array, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDashboard: (id: string, translate?: string, options?: any) => Promise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [translate] * @param {boolean} [withReplacements] * @param {string} [sort] * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDashboards: (page?: number, size?: number, translate?: string, withReplacements?: boolean, sort?: string, search?: string, options?: any) => Promise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDashboardsCount: (page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {any} dashboard * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchDashboard: (id: string, dashboard: any, translate?: string, options?: any) => Promise; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performDashboardSearch: (searchRequest: SearchRequestDto, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {DashboardDto} dashboard * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putDashboard: (id: string, dashboard: DashboardDto, translate?: string, options?: any) => Promise; }; /** * DashboardsApi - functional programming interface * @export */ export declare const DashboardsApiFp: (axiosClientConfiguration?: Configuration) => { /** * * @param {DashboardDto} dashboard * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDashboard(dashboard: DashboardDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This is a very performant method for checking if a Dashboard exists. * @summary Check if Dashboard exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ dashboardExists(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDashboard(id: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyDashboards(ids: Array, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDashboard(id: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {number} [page] * @param {number} [size] * @param {string} [translate] * @param {boolean} [withReplacements] * @param {string} [sort] * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDashboards(page?: number, size?: number, translate?: string, withReplacements?: boolean, sort?: string, search?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDashboardsCount(page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {any} dashboard * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchDashboard(id: string, dashboard: any, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performDashboardSearch(searchRequest: SearchRequestDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {DashboardDto} dashboard * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putDashboard(id: string, dashboard: DashboardDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DashboardsApi - factory interface * @export */ export declare const DashboardsApiFactory: (axiosClientConfiguration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @param {DashboardDto} dashboard * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDashboard(dashboard: DashboardDto, translate?: string, options?: any): AxiosPromise; /** * This is a very performant method for checking if a Dashboard exists. * @summary Check if Dashboard exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ dashboardExists(id: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDashboard(id: string, translate?: string, options?: any): AxiosPromise; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyDashboards(ids: Array, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDashboard(id: string, translate?: string, options?: any): AxiosPromise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [translate] * @param {boolean} [withReplacements] * @param {string} [sort] * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDashboards(page?: number, size?: number, translate?: string, withReplacements?: boolean, sort?: string, search?: string, options?: any): AxiosPromise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDashboardsCount(page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {any} dashboard * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchDashboard(id: string, dashboard: any, translate?: string, options?: any): AxiosPromise; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performDashboardSearch(searchRequest: SearchRequestDto, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {DashboardDto} dashboard * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putDashboard(id: string, dashboard: DashboardDto, translate?: string, options?: any): AxiosPromise; }; /** * Request parameters for createDashboard operation in DashboardsApi. * @export * @interface DashboardsApiCreateDashboardRequest */ export interface DashboardsApiCreateDashboardRequest { /** * * @type {DashboardDto} * @memberof DashboardsApiCreateDashboard */ readonly dashboard: DashboardDto; /** * * @type {string} * @memberof DashboardsApiCreateDashboard */ readonly translate?: string; } /** * Request parameters for dashboardExists operation in DashboardsApi. * @export * @interface DashboardsApiDashboardExistsRequest */ export interface DashboardsApiDashboardExistsRequest { /** * * @type {string} * @memberof DashboardsApiDashboardExists */ readonly id: string; } /** * Request parameters for deleteDashboard operation in DashboardsApi. * @export * @interface DashboardsApiDeleteDashboardRequest */ export interface DashboardsApiDeleteDashboardRequest { /** * * @type {string} * @memberof DashboardsApiDeleteDashboard */ readonly id: string; /** * * @type {string} * @memberof DashboardsApiDeleteDashboard */ readonly translate?: string; } /** * Request parameters for deleteManyDashboards operation in DashboardsApi. * @export * @interface DashboardsApiDeleteManyDashboardsRequest */ export interface DashboardsApiDeleteManyDashboardsRequest { /** * * @type {Array} * @memberof DashboardsApiDeleteManyDashboards */ readonly ids: Array; /** * * @type {string} * @memberof DashboardsApiDeleteManyDashboards */ readonly translate?: string; } /** * Request parameters for getDashboard operation in DashboardsApi. * @export * @interface DashboardsApiGetDashboardRequest */ export interface DashboardsApiGetDashboardRequest { /** * * @type {string} * @memberof DashboardsApiGetDashboard */ readonly id: string; /** * * @type {string} * @memberof DashboardsApiGetDashboard */ readonly translate?: string; } /** * Request parameters for getDashboards operation in DashboardsApi. * @export * @interface DashboardsApiGetDashboardsRequest */ export interface DashboardsApiGetDashboardsRequest { /** * * @type {number} * @memberof DashboardsApiGetDashboards */ readonly page?: number; /** * * @type {number} * @memberof DashboardsApiGetDashboards */ readonly size?: number; /** * * @type {string} * @memberof DashboardsApiGetDashboards */ readonly translate?: string; /** * * @type {boolean} * @memberof DashboardsApiGetDashboards */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof DashboardsApiGetDashboards */ readonly sort?: string; /** * * @type {string} * @memberof DashboardsApiGetDashboards */ readonly search?: string; } /** * Request parameters for getDashboardsCount operation in DashboardsApi. * @export * @interface DashboardsApiGetDashboardsCountRequest */ export interface DashboardsApiGetDashboardsCountRequest { /** * * @type {number} * @memberof DashboardsApiGetDashboardsCount */ readonly page?: number; /** * * @type {number} * @memberof DashboardsApiGetDashboardsCount */ readonly size?: number; /** * * @type {string} * @memberof DashboardsApiGetDashboardsCount */ readonly sort?: string; /** * * @type {string} * @memberof DashboardsApiGetDashboardsCount */ readonly search?: string; /** * * @type {boolean} * @memberof DashboardsApiGetDashboardsCount */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof DashboardsApiGetDashboardsCount */ readonly translate?: string; } /** * Request parameters for patchDashboard operation in DashboardsApi. * @export * @interface DashboardsApiPatchDashboardRequest */ export interface DashboardsApiPatchDashboardRequest { /** * * @type {string} * @memberof DashboardsApiPatchDashboard */ readonly id: string; /** * * @type {any} * @memberof DashboardsApiPatchDashboard */ readonly dashboard: any; /** * * @type {string} * @memberof DashboardsApiPatchDashboard */ readonly translate?: string; } /** * Request parameters for performDashboardSearch operation in DashboardsApi. * @export * @interface DashboardsApiPerformDashboardSearchRequest */ export interface DashboardsApiPerformDashboardSearchRequest { /** * * @type {SearchRequestDto} * @memberof DashboardsApiPerformDashboardSearch */ readonly searchRequest: SearchRequestDto; /** * * @type {string} * @memberof DashboardsApiPerformDashboardSearch */ readonly translate?: string; } /** * Request parameters for putDashboard operation in DashboardsApi. * @export * @interface DashboardsApiPutDashboardRequest */ export interface DashboardsApiPutDashboardRequest { /** * * @type {string} * @memberof DashboardsApiPutDashboard */ readonly id: string; /** * * @type {DashboardDto} * @memberof DashboardsApiPutDashboard */ readonly dashboard: DashboardDto; /** * * @type {string} * @memberof DashboardsApiPutDashboard */ readonly translate?: string; } /** * DashboardsApi - object-oriented interface * @export * @class DashboardsApi * @extends {BaseAPI} */ export declare class DashboardsApi extends BaseAPI { /** * * @param {DashboardsApiCreateDashboardRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardsApi */ createDashboard(requestParameters: DashboardsApiCreateDashboardRequest, options?: any): Promise>; /** * This is a very performant method for checking if a Dashboard exists. * @summary Check if Dashboard exists * @param {DashboardsApiDashboardExistsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardsApi */ dashboardExists(requestParameters: DashboardsApiDashboardExistsRequest, options?: any): Promise>; /** * * @param {DashboardsApiDeleteDashboardRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardsApi */ deleteDashboard(requestParameters: DashboardsApiDeleteDashboardRequest, options?: any): Promise>; /** * * @param {DashboardsApiDeleteManyDashboardsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardsApi */ deleteManyDashboards(requestParameters: DashboardsApiDeleteManyDashboardsRequest, options?: any): Promise>; /** * * @param {DashboardsApiGetDashboardRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardsApi */ getDashboard(requestParameters: DashboardsApiGetDashboardRequest, options?: any): Promise>; /** * * @param {DashboardsApiGetDashboardsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardsApi */ getDashboards(requestParameters?: DashboardsApiGetDashboardsRequest, options?: any): Promise>; /** * * @param {DashboardsApiGetDashboardsCountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardsApi */ getDashboardsCount(requestParameters?: DashboardsApiGetDashboardsCountRequest, options?: any): Promise>; /** * * @param {DashboardsApiPatchDashboardRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardsApi */ patchDashboard(requestParameters: DashboardsApiPatchDashboardRequest, options?: any): Promise>; /** * * @param {DashboardsApiPerformDashboardSearchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardsApi */ performDashboardSearch(requestParameters: DashboardsApiPerformDashboardSearchRequest, options?: any): Promise>; /** * * @param {DashboardsApiPutDashboardRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardsApi */ putDashboard(requestParameters: DashboardsApiPutDashboardRequest, options?: any): Promise>; }