kb-cloud-client-typescript 2.4.0-alpha.7 → 2.4.0-alpha.70

package/src/adminapi/apis/dashboard-config-api.ts

@@ -0,0 +1,388 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.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 type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// 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, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { APIErrorResponse } from '../models';
+// @ts-ignore
+import type { DashboardConfig } from '../models';
+// @ts-ignore
+import type { DashboardConfigUpdate } from '../models';
+/**
+ * DashboardConfigApi - axios parameter creator
+ * @export
+ */
+export const DashboardConfigApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Requires platform configuration write access. Deleting a missing key succeeds.
+         * @summary Delete dashboard configuration by key
+         * @param {string} key Frontend-defined non-blank configuration key, up to 512 Unicode characters. URL-encode the key when used in a request path.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteDashboardConfig: async (key: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'key' is not null or undefined
+            assertParamExists('deleteDashboardConfig', 'key', key)
+            const localVarPath = `/admin/v1/dashboardConfigs/{key}`
+                .replace(`{${"key"}}`, encodeURIComponent(String(key)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BearerToken required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            // authentication DigestAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Requires platform configuration read access. Missing keys return 200 with a null value.
+         * @summary Get dashboard configuration by key
+         * @param {string} key Frontend-defined non-blank configuration key, up to 512 Unicode characters. URL-encode the key when used in a request path.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDashboardConfig: async (key: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'key' is not null or undefined
+            assertParamExists('getDashboardConfig', 'key', key)
+            const localVarPath = `/admin/v1/dashboardConfigs/{key}`
+                .replace(`{${"key"}}`, encodeURIComponent(String(key)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BearerToken required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            // authentication DigestAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Requires platform configuration write access. Atomic upsert with last-write-wins semantics. Request body is limited to 1 MiB.
+         * @summary Create or replace dashboard configuration by key
+         * @param {string} key Frontend-defined non-blank configuration key, up to 512 Unicode characters. URL-encode the key when used in a request path.
+         * @param {DashboardConfigUpdate} dashboardConfigUpdate 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putDashboardConfig: async (key: string, dashboardConfigUpdate: DashboardConfigUpdate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'key' is not null or undefined
+            assertParamExists('putDashboardConfig', 'key', key)
+            // verify required parameter 'dashboardConfigUpdate' is not null or undefined
+            assertParamExists('putDashboardConfig', 'dashboardConfigUpdate', dashboardConfigUpdate)
+            const localVarPath = `/admin/v1/dashboardConfigs/{key}`
+                .replace(`{${"key"}}`, encodeURIComponent(String(key)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BearerToken required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            // authentication DigestAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(dashboardConfigUpdate, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * DashboardConfigApi - functional programming interface
+ * @export
+ */
+export const DashboardConfigApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = DashboardConfigApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Requires platform configuration write access. Deleting a missing key succeeds.
+         * @summary Delete dashboard configuration by key
+         * @param {string} key Frontend-defined non-blank configuration key, up to 512 Unicode characters. URL-encode the key when used in a request path.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async deleteDashboardConfig(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDashboardConfig(key, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DashboardConfigApi.deleteDashboardConfig']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Requires platform configuration read access. Missing keys return 200 with a null value.
+         * @summary Get dashboard configuration by key
+         * @param {string} key Frontend-defined non-blank configuration key, up to 512 Unicode characters. URL-encode the key when used in a request path.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getDashboardConfig(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DashboardConfig>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getDashboardConfig(key, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DashboardConfigApi.getDashboardConfig']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Requires platform configuration write access. Atomic upsert with last-write-wins semantics. Request body is limited to 1 MiB.
+         * @summary Create or replace dashboard configuration by key
+         * @param {string} key Frontend-defined non-blank configuration key, up to 512 Unicode characters. URL-encode the key when used in a request path.
+         * @param {DashboardConfigUpdate} dashboardConfigUpdate 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async putDashboardConfig(key: string, dashboardConfigUpdate: DashboardConfigUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DashboardConfig>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.putDashboardConfig(key, dashboardConfigUpdate, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DashboardConfigApi.putDashboardConfig']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * DashboardConfigApi - factory interface
+ * @export
+ */
+export const DashboardConfigApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = DashboardConfigApiFp(configuration)
+    return {
+        /**
+         * Requires platform configuration write access. Deleting a missing key succeeds.
+         * @summary Delete dashboard configuration by key
+         * @param {DashboardConfigApiDeleteDashboardConfigRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteDashboardConfig(requestParameters: DashboardConfigApiDeleteDashboardConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.deleteDashboardConfig(requestParameters.key, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Requires platform configuration read access. Missing keys return 200 with a null value.
+         * @summary Get dashboard configuration by key
+         * @param {DashboardConfigApiGetDashboardConfigRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDashboardConfig(requestParameters: DashboardConfigApiGetDashboardConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<DashboardConfig> {
+            return localVarFp.getDashboardConfig(requestParameters.key, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Requires platform configuration write access. Atomic upsert with last-write-wins semantics. Request body is limited to 1 MiB.
+         * @summary Create or replace dashboard configuration by key
+         * @param {DashboardConfigApiPutDashboardConfigRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putDashboardConfig(requestParameters: DashboardConfigApiPutDashboardConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<DashboardConfig> {
+            return localVarFp.putDashboardConfig(requestParameters.key, requestParameters.dashboardConfigUpdate, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * DashboardConfigApi - interface
+ * @export
+ * @interface DashboardConfigApi
+ */
+export interface DashboardConfigApiInterface {
+    /**
+     * Requires platform configuration write access. Deleting a missing key succeeds.
+     * @summary Delete dashboard configuration by key
+     * @param {DashboardConfigApiDeleteDashboardConfigRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardConfigApiInterface
+     */
+    deleteDashboardConfig(requestParameters: DashboardConfigApiDeleteDashboardConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+
+    /**
+     * Requires platform configuration read access. Missing keys return 200 with a null value.
+     * @summary Get dashboard configuration by key
+     * @param {DashboardConfigApiGetDashboardConfigRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardConfigApiInterface
+     */
+    getDashboardConfig(requestParameters: DashboardConfigApiGetDashboardConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<DashboardConfig>;
+
+    /**
+     * Requires platform configuration write access. Atomic upsert with last-write-wins semantics. Request body is limited to 1 MiB.
+     * @summary Create or replace dashboard configuration by key
+     * @param {DashboardConfigApiPutDashboardConfigRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardConfigApiInterface
+     */
+    putDashboardConfig(requestParameters: DashboardConfigApiPutDashboardConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<DashboardConfig>;
+
+}
+
+/**
+ * Request parameters for deleteDashboardConfig operation in DashboardConfigApi.
+ * @export
+ * @interface DashboardConfigApiDeleteDashboardConfigRequest
+ */
+export interface DashboardConfigApiDeleteDashboardConfigRequest {
+    /**
+     * Frontend-defined non-blank configuration key, up to 512 Unicode characters. URL-encode the key when used in a request path.
+     * @type {string}
+     * @memberof DashboardConfigApiDeleteDashboardConfig
+     */
+    readonly key: string
+}
+
+/**
+ * Request parameters for getDashboardConfig operation in DashboardConfigApi.
+ * @export
+ * @interface DashboardConfigApiGetDashboardConfigRequest
+ */
+export interface DashboardConfigApiGetDashboardConfigRequest {
+    /**
+     * Frontend-defined non-blank configuration key, up to 512 Unicode characters. URL-encode the key when used in a request path.
+     * @type {string}
+     * @memberof DashboardConfigApiGetDashboardConfig
+     */
+    readonly key: string
+}
+
+/**
+ * Request parameters for putDashboardConfig operation in DashboardConfigApi.
+ * @export
+ * @interface DashboardConfigApiPutDashboardConfigRequest
+ */
+export interface DashboardConfigApiPutDashboardConfigRequest {
+    /**
+     * Frontend-defined non-blank configuration key, up to 512 Unicode characters. URL-encode the key when used in a request path.
+     * @type {string}
+     * @memberof DashboardConfigApiPutDashboardConfig
+     */
+    readonly key: string
+
+    /**
+     * 
+     * @type {DashboardConfigUpdate}
+     * @memberof DashboardConfigApiPutDashboardConfig
+     */
+    readonly dashboardConfigUpdate: DashboardConfigUpdate
+}
+
+/**
+ * DashboardConfigApi - object-oriented interface
+ * @export
+ * @class DashboardConfigApi
+ * @extends {BaseAPI}
+ */
+export class DashboardConfigApi extends BaseAPI implements DashboardConfigApiInterface {
+    /**
+     * Requires platform configuration write access. Deleting a missing key succeeds.
+     * @summary Delete dashboard configuration by key
+     * @param {DashboardConfigApiDeleteDashboardConfigRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardConfigApi
+     */
+    public deleteDashboardConfig(requestParameters: DashboardConfigApiDeleteDashboardConfigRequest, options?: RawAxiosRequestConfig) {
+        return DashboardConfigApiFp(this.configuration).deleteDashboardConfig(requestParameters.key, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Requires platform configuration read access. Missing keys return 200 with a null value.
+     * @summary Get dashboard configuration by key
+     * @param {DashboardConfigApiGetDashboardConfigRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardConfigApi
+     */
+    public getDashboardConfig(requestParameters: DashboardConfigApiGetDashboardConfigRequest, options?: RawAxiosRequestConfig) {
+        return DashboardConfigApiFp(this.configuration).getDashboardConfig(requestParameters.key, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Requires platform configuration write access. Atomic upsert with last-write-wins semantics. Request body is limited to 1 MiB.
+     * @summary Create or replace dashboard configuration by key
+     * @param {DashboardConfigApiPutDashboardConfigRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardConfigApi
+     */
+    public putDashboardConfig(requestParameters: DashboardConfigApiPutDashboardConfigRequest, options?: RawAxiosRequestConfig) {
+        return DashboardConfigApiFp(this.configuration).putDashboardConfig(requestParameters.key, requestParameters.dashboardConfigUpdate, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+