/* tslint:disable */ /* eslint-disable */ /** * EMIL Tenant Service * The EMIL TenantService API description * * The version of the OpenAPI document: 1.0 * Contact: kontakt@emil.de * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import { Configuration } from '../configuration'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; // @ts-ignore import { CreateDashboardRequestDto } from '../models'; // @ts-ignore import { CreateDashboardResponseClass } from '../models'; // @ts-ignore import { CreateDashboardV2RequestDto } from '../models'; // @ts-ignore import { CreateDashboardV2ResponseClass } from '../models'; // @ts-ignore import { DeleteResponseClass } from '../models'; // @ts-ignore import { DuplicateDashboardRequestDto } from '../models'; // @ts-ignore import { DuplicateDashboardResponseClass } from '../models'; // @ts-ignore import { GetDashboardResponseClass } from '../models'; // @ts-ignore import { GetEmbeddedUrlResponseClass } from '../models'; // @ts-ignore import { ListDashboardsResponseClass } from '../models'; // @ts-ignore import { PublishDashboardRequestDto } from '../models'; // @ts-ignore import { RevertAnalysisRequestDto } from '../models'; // @ts-ignore import { UpdateDashboardRequestDto } from '../models'; // @ts-ignore import { UpdateDashboardResponseClass } from '../models'; // URLSearchParams not necessarily used // @ts-ignore import { URL, URLSearchParams } from 'url'; const FormData = require('form-data'); /** * DashboardApi - axios parameter creator * @export */ export const DashboardApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\" * @summary Creates a new dashboard * @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDashboard: async (createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'createDashboardV2RequestDto' is not null or undefined assertParamExists('createDashboard', 'createDashboardV2RequestDto', createDashboardV2RequestDto) const localVarPath = `/tenantservice/v1/dashboards`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(createDashboardV2RequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\" * @summary Creates a new dashboard (DEPRECATED) * @param {CreateDashboardRequestDto} createDashboardRequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ createDashboardLegacy: async (createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'createDashboardRequestDto' is not null or undefined assertParamExists('createDashboardLegacy', 'createDashboardRequestDto', createDashboardRequestDto) const localVarPath = `/tenantservice/v1/dashboards/legacy`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(createDashboardRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\" * @summary Deletes an existing dashboard * @param {string} code * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDashboard: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'code' is not null or undefined assertParamExists('deleteDashboard', 'code', code) const localVarPath = `/tenantservice/v1/dashboards/{code}` .replace(`{${"code"}}`, encodeURIComponent(String(code))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\" * @summary Creates a duplicate of an existing dashboard * @param {string} code * @param {DuplicateDashboardRequestDto} duplicateDashboardRequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ duplicateDashboard: async (code: string, duplicateDashboardRequestDto: DuplicateDashboardRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'code' is not null or undefined assertParamExists('duplicateDashboard', 'code', code) // verify required parameter 'duplicateDashboardRequestDto' is not null or undefined assertParamExists('duplicateDashboard', 'duplicateDashboardRequestDto', duplicateDashboardRequestDto) const localVarPath = `/tenantservice/v1/dashboards/{code}/duplicate` .replace(`{${"code"}}`, encodeURIComponent(String(code))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(duplicateDashboardRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\" * @summary Generates an embedded URL for dashboard editing * @param {string} providerDashboardId * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAnalysisEmbeddedUrl: async (providerDashboardId: string, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'providerDashboardId' is not null or undefined assertParamExists('getAnalysisEmbeddedUrl', 'providerDashboardId', providerDashboardId) const localVarPath = `/tenantservice/v1/dashboards/{provider_dashboard_id}/editor-embedded-url` .replace(`{${"provider_dashboard_id"}}`, encodeURIComponent(String(providerDashboardId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\" * @summary Retrieves a specific dashboard * @param {string} code * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDashboard: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'code' is not null or undefined assertParamExists('getDashboard', 'code', code) const localVarPath = `/tenantservice/v1/dashboards/{code}` .replace(`{${"code"}}`, encodeURIComponent(String(code))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\" * @summary Generates an embedded URL for dashboard viewing * @param {string} providerDashboardId * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDashboardEmbeddedUrl: async (providerDashboardId: string, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'providerDashboardId' is not null or undefined assertParamExists('getDashboardEmbeddedUrl', 'providerDashboardId', providerDashboardId) const localVarPath = `/tenantservice/v1/dashboards/{provider_dashboard_id}/dashboard-embedded-url` .replace(`{${"provider_dashboard_id"}}`, encodeURIComponent(String(providerDashboardId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\" * @summary Retrieves a list of dashboards * @param {string} [authorization] Bearer Token * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10. * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list. * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result. * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC. * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size. * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDashboards: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/tenantservice/v1/dashboards`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (pageSize !== undefined) { localVarQueryParameter['pageSize'] = pageSize; } if (pageToken !== undefined) { localVarQueryParameter['pageToken'] = pageToken; } if (filter !== undefined) { localVarQueryParameter['filter'] = filter; } if (search !== undefined) { localVarQueryParameter['search'] = search; } if (order !== undefined) { localVarQueryParameter['order'] = order; } if (expand !== undefined) { localVarQueryParameter['expand'] = expand; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\" * @summary Publishes a dashboard for general access * @param {PublishDashboardRequestDto} publishDashboardRequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ publishDashboard: async (publishDashboardRequestDto: PublishDashboardRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'publishDashboardRequestDto' is not null or undefined assertParamExists('publishDashboard', 'publishDashboardRequestDto', publishDashboardRequestDto) const localVarPath = `/tenantservice/v1/dashboards/publish-dashboard`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(publishDashboardRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\" * @summary Reverts dashboard analysis to previous state * @param {RevertAnalysisRequestDto} revertAnalysisRequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ revertAnalysis: async (revertAnalysisRequestDto: RevertAnalysisRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'revertAnalysisRequestDto' is not null or undefined assertParamExists('revertAnalysis', 'revertAnalysisRequestDto', revertAnalysisRequestDto) const localVarPath = `/tenantservice/v1/dashboards/revert-analysis`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(revertAnalysisRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\" * @summary Updates an existing dashboard * @param {string} code * @param {UpdateDashboardRequestDto} updateDashboardRequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDashboard: async (code: string, updateDashboardRequestDto: UpdateDashboardRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'code' is not null or undefined assertParamExists('updateDashboard', 'code', code) // verify required parameter 'updateDashboardRequestDto' is not null or undefined assertParamExists('updateDashboard', 'updateDashboardRequestDto', updateDashboardRequestDto) const localVarPath = `/tenantservice/v1/dashboards/{code}` .replace(`{${"code"}}`, encodeURIComponent(String(code))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(updateDashboardRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, } }; /** * DashboardApi - functional programming interface * @export */ export const DashboardApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = DashboardApiAxiosParamCreator(configuration) return { /** * Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\" * @summary Creates a new dashboard * @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ async createDashboard(createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboard(createDashboardV2RequestDto, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\" * @summary Creates a new dashboard (DEPRECATED) * @param {CreateDashboardRequestDto} createDashboardRequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ async createDashboardLegacy(createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardLegacy(createDashboardRequestDto, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\" * @summary Deletes an existing dashboard * @param {string} code * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ async deleteDashboard(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDashboard(code, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\" * @summary Creates a duplicate of an existing dashboard * @param {string} code * @param {DuplicateDashboardRequestDto} duplicateDashboardRequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ async duplicateDashboard(code: string, duplicateDashboardRequestDto: DuplicateDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.duplicateDashboard(code, duplicateDashboardRequestDto, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\" * @summary Generates an embedded URL for dashboard editing * @param {string} providerDashboardId * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ async getAnalysisEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getAnalysisEmbeddedUrl(providerDashboardId, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\" * @summary Retrieves a specific dashboard * @param {string} code * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ async getDashboard(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getDashboard(code, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\" * @summary Generates an embedded URL for dashboard viewing * @param {string} providerDashboardId * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ async getDashboardEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getDashboardEmbeddedUrl(providerDashboardId, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\" * @summary Retrieves a list of dashboards * @param {string} [authorization] Bearer Token * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10. * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list. * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result. * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC. * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size. * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ async listDashboards(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.listDashboards(authorization, pageSize, pageToken, filter, search, order, expand, filters, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\" * @summary Publishes a dashboard for general access * @param {PublishDashboardRequestDto} publishDashboardRequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ async publishDashboard(publishDashboardRequestDto: PublishDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.publishDashboard(publishDashboardRequestDto, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\" * @summary Reverts dashboard analysis to previous state * @param {RevertAnalysisRequestDto} revertAnalysisRequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ async revertAnalysis(revertAnalysisRequestDto: RevertAnalysisRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.revertAnalysis(revertAnalysisRequestDto, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\" * @summary Updates an existing dashboard * @param {string} code * @param {UpdateDashboardRequestDto} updateDashboardRequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ async updateDashboard(code: string, updateDashboardRequestDto: UpdateDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateDashboard(code, updateDashboardRequestDto, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } }; /** * DashboardApi - factory interface * @export */ export const DashboardApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = DashboardApiFp(configuration) return { /** * Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\" * @summary Creates a new dashboard * @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDashboard(createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options?: any): AxiosPromise { return localVarFp.createDashboard(createDashboardV2RequestDto, authorization, options).then((request) => request(axios, basePath)); }, /** * Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\" * @summary Creates a new dashboard (DEPRECATED) * @param {CreateDashboardRequestDto} createDashboardRequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ createDashboardLegacy(createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: any): AxiosPromise { return localVarFp.createDashboardLegacy(createDashboardRequestDto, authorization, options).then((request) => request(axios, basePath)); }, /** * Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\" * @summary Deletes an existing dashboard * @param {string} code * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDashboard(code: string, authorization?: string, options?: any): AxiosPromise { return localVarFp.deleteDashboard(code, authorization, options).then((request) => request(axios, basePath)); }, /** * Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\" * @summary Creates a duplicate of an existing dashboard * @param {string} code * @param {DuplicateDashboardRequestDto} duplicateDashboardRequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ duplicateDashboard(code: string, duplicateDashboardRequestDto: DuplicateDashboardRequestDto, authorization?: string, options?: any): AxiosPromise { return localVarFp.duplicateDashboard(code, duplicateDashboardRequestDto, authorization, options).then((request) => request(axios, basePath)); }, /** * Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\" * @summary Generates an embedded URL for dashboard editing * @param {string} providerDashboardId * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAnalysisEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: any): AxiosPromise { return localVarFp.getAnalysisEmbeddedUrl(providerDashboardId, authorization, options).then((request) => request(axios, basePath)); }, /** * Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\" * @summary Retrieves a specific dashboard * @param {string} code * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDashboard(code: string, authorization?: string, options?: any): AxiosPromise { return localVarFp.getDashboard(code, authorization, options).then((request) => request(axios, basePath)); }, /** * Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\" * @summary Generates an embedded URL for dashboard viewing * @param {string} providerDashboardId * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDashboardEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: any): AxiosPromise { return localVarFp.getDashboardEmbeddedUrl(providerDashboardId, authorization, options).then((request) => request(axios, basePath)); }, /** * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\" * @summary Retrieves a list of dashboards * @param {string} [authorization] Bearer Token * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10. * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list. * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result. * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC. * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size. * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDashboards(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise { return localVarFp.listDashboards(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath)); }, /** * Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\" * @summary Publishes a dashboard for general access * @param {PublishDashboardRequestDto} publishDashboardRequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ publishDashboard(publishDashboardRequestDto: PublishDashboardRequestDto, authorization?: string, options?: any): AxiosPromise { return localVarFp.publishDashboard(publishDashboardRequestDto, authorization, options).then((request) => request(axios, basePath)); }, /** * Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\" * @summary Reverts dashboard analysis to previous state * @param {RevertAnalysisRequestDto} revertAnalysisRequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ revertAnalysis(revertAnalysisRequestDto: RevertAnalysisRequestDto, authorization?: string, options?: any): AxiosPromise { return localVarFp.revertAnalysis(revertAnalysisRequestDto, authorization, options).then((request) => request(axios, basePath)); }, /** * Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\" * @summary Updates an existing dashboard * @param {string} code * @param {UpdateDashboardRequestDto} updateDashboardRequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDashboard(code: string, updateDashboardRequestDto: UpdateDashboardRequestDto, authorization?: string, options?: any): AxiosPromise { return localVarFp.updateDashboard(code, updateDashboardRequestDto, authorization, options).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for createDashboard operation in DashboardApi. * @export * @interface DashboardApiCreateDashboardRequest */ export interface DashboardApiCreateDashboardRequest { /** * * @type {CreateDashboardV2RequestDto} * @memberof DashboardApiCreateDashboard */ readonly createDashboardV2RequestDto: CreateDashboardV2RequestDto /** * Bearer Token * @type {string} * @memberof DashboardApiCreateDashboard */ readonly authorization?: string } /** * Request parameters for createDashboardLegacy operation in DashboardApi. * @export * @interface DashboardApiCreateDashboardLegacyRequest */ export interface DashboardApiCreateDashboardLegacyRequest { /** * * @type {CreateDashboardRequestDto} * @memberof DashboardApiCreateDashboardLegacy */ readonly createDashboardRequestDto: CreateDashboardRequestDto /** * Bearer Token * @type {string} * @memberof DashboardApiCreateDashboardLegacy */ readonly authorization?: string } /** * Request parameters for deleteDashboard operation in DashboardApi. * @export * @interface DashboardApiDeleteDashboardRequest */ export interface DashboardApiDeleteDashboardRequest { /** * * @type {string} * @memberof DashboardApiDeleteDashboard */ readonly code: string /** * Bearer Token * @type {string} * @memberof DashboardApiDeleteDashboard */ readonly authorization?: string } /** * Request parameters for duplicateDashboard operation in DashboardApi. * @export * @interface DashboardApiDuplicateDashboardRequest */ export interface DashboardApiDuplicateDashboardRequest { /** * * @type {string} * @memberof DashboardApiDuplicateDashboard */ readonly code: string /** * * @type {DuplicateDashboardRequestDto} * @memberof DashboardApiDuplicateDashboard */ readonly duplicateDashboardRequestDto: DuplicateDashboardRequestDto /** * Bearer Token * @type {string} * @memberof DashboardApiDuplicateDashboard */ readonly authorization?: string } /** * Request parameters for getAnalysisEmbeddedUrl operation in DashboardApi. * @export * @interface DashboardApiGetAnalysisEmbeddedUrlRequest */ export interface DashboardApiGetAnalysisEmbeddedUrlRequest { /** * * @type {string} * @memberof DashboardApiGetAnalysisEmbeddedUrl */ readonly providerDashboardId: string /** * Bearer Token * @type {string} * @memberof DashboardApiGetAnalysisEmbeddedUrl */ readonly authorization?: string } /** * Request parameters for getDashboard operation in DashboardApi. * @export * @interface DashboardApiGetDashboardRequest */ export interface DashboardApiGetDashboardRequest { /** * * @type {string} * @memberof DashboardApiGetDashboard */ readonly code: string /** * Bearer Token * @type {string} * @memberof DashboardApiGetDashboard */ readonly authorization?: string } /** * Request parameters for getDashboardEmbeddedUrl operation in DashboardApi. * @export * @interface DashboardApiGetDashboardEmbeddedUrlRequest */ export interface DashboardApiGetDashboardEmbeddedUrlRequest { /** * * @type {string} * @memberof DashboardApiGetDashboardEmbeddedUrl */ readonly providerDashboardId: string /** * Bearer Token * @type {string} * @memberof DashboardApiGetDashboardEmbeddedUrl */ readonly authorization?: string } /** * Request parameters for listDashboards operation in DashboardApi. * @export * @interface DashboardApiListDashboardsRequest */ export interface DashboardApiListDashboardsRequest { /** * Bearer Token * @type {string} * @memberof DashboardApiListDashboards */ readonly authorization?: string /** * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10. * @type {number} * @memberof DashboardApiListDashboards */ readonly pageSize?: number /** * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list. * @type {string} * @memberof DashboardApiListDashboards */ readonly pageToken?: string /** * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. * @type {string} * @memberof DashboardApiListDashboards */ readonly filter?: string /** * To search the list by any field, pass search=xxx to fetch the result. * @type {string} * @memberof DashboardApiListDashboards */ readonly search?: string /** * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC. * @type {string} * @memberof DashboardApiListDashboards */ readonly order?: string /** * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size. * @type {string} * @memberof DashboardApiListDashboards */ readonly expand?: string /** * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time. * @type {string} * @memberof DashboardApiListDashboards */ readonly filters?: string } /** * Request parameters for publishDashboard operation in DashboardApi. * @export * @interface DashboardApiPublishDashboardRequest */ export interface DashboardApiPublishDashboardRequest { /** * * @type {PublishDashboardRequestDto} * @memberof DashboardApiPublishDashboard */ readonly publishDashboardRequestDto: PublishDashboardRequestDto /** * Bearer Token * @type {string} * @memberof DashboardApiPublishDashboard */ readonly authorization?: string } /** * Request parameters for revertAnalysis operation in DashboardApi. * @export * @interface DashboardApiRevertAnalysisRequest */ export interface DashboardApiRevertAnalysisRequest { /** * * @type {RevertAnalysisRequestDto} * @memberof DashboardApiRevertAnalysis */ readonly revertAnalysisRequestDto: RevertAnalysisRequestDto /** * Bearer Token * @type {string} * @memberof DashboardApiRevertAnalysis */ readonly authorization?: string } /** * Request parameters for updateDashboard operation in DashboardApi. * @export * @interface DashboardApiUpdateDashboardRequest */ export interface DashboardApiUpdateDashboardRequest { /** * * @type {string} * @memberof DashboardApiUpdateDashboard */ readonly code: string /** * * @type {UpdateDashboardRequestDto} * @memberof DashboardApiUpdateDashboard */ readonly updateDashboardRequestDto: UpdateDashboardRequestDto /** * Bearer Token * @type {string} * @memberof DashboardApiUpdateDashboard */ readonly authorization?: string } /** * DashboardApi - object-oriented interface * @export * @class DashboardApi * @extends {BaseAPI} */ export class DashboardApi extends BaseAPI { /** * Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\" * @summary Creates a new dashboard * @param {DashboardApiCreateDashboardRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardApi */ public createDashboard(requestParameters: DashboardApiCreateDashboardRequest, options?: AxiosRequestConfig) { return DashboardApiFp(this.configuration).createDashboard(requestParameters.createDashboardV2RequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\" * @summary Creates a new dashboard (DEPRECATED) * @param {DashboardApiCreateDashboardLegacyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof DashboardApi */ public createDashboardLegacy(requestParameters: DashboardApiCreateDashboardLegacyRequest, options?: AxiosRequestConfig) { return DashboardApiFp(this.configuration).createDashboardLegacy(requestParameters.createDashboardRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\" * @summary Deletes an existing dashboard * @param {DashboardApiDeleteDashboardRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardApi */ public deleteDashboard(requestParameters: DashboardApiDeleteDashboardRequest, options?: AxiosRequestConfig) { return DashboardApiFp(this.configuration).deleteDashboard(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\" * @summary Creates a duplicate of an existing dashboard * @param {DashboardApiDuplicateDashboardRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardApi */ public duplicateDashboard(requestParameters: DashboardApiDuplicateDashboardRequest, options?: AxiosRequestConfig) { return DashboardApiFp(this.configuration).duplicateDashboard(requestParameters.code, requestParameters.duplicateDashboardRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\" * @summary Generates an embedded URL for dashboard editing * @param {DashboardApiGetAnalysisEmbeddedUrlRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardApi */ public getAnalysisEmbeddedUrl(requestParameters: DashboardApiGetAnalysisEmbeddedUrlRequest, options?: AxiosRequestConfig) { return DashboardApiFp(this.configuration).getAnalysisEmbeddedUrl(requestParameters.providerDashboardId, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\" * @summary Retrieves a specific dashboard * @param {DashboardApiGetDashboardRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardApi */ public getDashboard(requestParameters: DashboardApiGetDashboardRequest, options?: AxiosRequestConfig) { return DashboardApiFp(this.configuration).getDashboard(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\" * @summary Generates an embedded URL for dashboard viewing * @param {DashboardApiGetDashboardEmbeddedUrlRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardApi */ public getDashboardEmbeddedUrl(requestParameters: DashboardApiGetDashboardEmbeddedUrlRequest, options?: AxiosRequestConfig) { return DashboardApiFp(this.configuration).getDashboardEmbeddedUrl(requestParameters.providerDashboardId, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\" * @summary Retrieves a list of dashboards * @param {DashboardApiListDashboardsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardApi */ public listDashboards(requestParameters: DashboardApiListDashboardsRequest = {}, options?: AxiosRequestConfig) { return DashboardApiFp(this.configuration).listDashboards(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath)); } /** * Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\" * @summary Publishes a dashboard for general access * @param {DashboardApiPublishDashboardRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardApi */ public publishDashboard(requestParameters: DashboardApiPublishDashboardRequest, options?: AxiosRequestConfig) { return DashboardApiFp(this.configuration).publishDashboard(requestParameters.publishDashboardRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\" * @summary Reverts dashboard analysis to previous state * @param {DashboardApiRevertAnalysisRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardApi */ public revertAnalysis(requestParameters: DashboardApiRevertAnalysisRequest, options?: AxiosRequestConfig) { return DashboardApiFp(this.configuration).revertAnalysis(requestParameters.revertAnalysisRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\" * @summary Updates an existing dashboard * @param {DashboardApiUpdateDashboardRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DashboardApi */ public updateDashboard(requestParameters: DashboardApiUpdateDashboardRequest, options?: AxiosRequestConfig) { return DashboardApiFp(this.configuration).updateDashboard(requestParameters.code, requestParameters.updateDashboardRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } }