kb-cloud-client-typescript 2.4.0-alpha.102 → 2.4.0-alpha.105

package/src/adminapi/apis/node-alert-api.ts

@@ -0,0 +1,424 @@
+/* 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 { AlertCluster } from '../models';
+// @ts-ignore
+import type { AlertRuleList } from '../models';
+/**
+ * NodeAlertApi - axios parameter creator
+ * @export
+ */
+export const NodeAlertApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 
+         * @summary Get alert settings for a node in an environment
+         * @param {string} environmentName 
+         * @param {string} nodeName 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getNodeAlertSettings: async (environmentName: string, nodeName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'environmentName' is not null or undefined
+            assertParamExists('getNodeAlertSettings', 'environmentName', environmentName)
+            // verify required parameter 'nodeName' is not null or undefined
+            assertParamExists('getNodeAlertSettings', 'nodeName', nodeName)
+            const localVarPath = `/admin/v1/environments/{environmentName}/nodes/{nodeName}/alert/settings`
+                .replace(`{${"environmentName"}}`, encodeURIComponent(String(environmentName)))
+                .replace(`{${"nodeName"}}`, encodeURIComponent(String(nodeName)));
+            // 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,
+            };
+        },
+        /**
+         * 
+         * @summary List node metric and NodeDown event alert rules
+         * @param {string} environmentName 
+         * @param {string} nodeName 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listNodeAlertRules: async (environmentName: string, nodeName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'environmentName' is not null or undefined
+            assertParamExists('listNodeAlertRules', 'environmentName', environmentName)
+            // verify required parameter 'nodeName' is not null or undefined
+            assertParamExists('listNodeAlertRules', 'nodeName', nodeName)
+            const localVarPath = `/admin/v1/environments/{environmentName}/nodes/{nodeName}/alert/rules`
+                .replace(`{${"environmentName"}}`, encodeURIComponent(String(environmentName)))
+                .replace(`{${"nodeName"}}`, encodeURIComponent(String(nodeName)));
+            // 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,
+            };
+        },
+        /**
+         * 
+         * @summary Update supplied node alert settings; omitted fields are preserved
+         * @param {string} environmentName 
+         * @param {string} nodeName 
+         * @param {AlertCluster} alertCluster 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchNodeAlertSettings: async (environmentName: string, nodeName: string, alertCluster: AlertCluster, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'environmentName' is not null or undefined
+            assertParamExists('patchNodeAlertSettings', 'environmentName', environmentName)
+            // verify required parameter 'nodeName' is not null or undefined
+            assertParamExists('patchNodeAlertSettings', 'nodeName', nodeName)
+            // verify required parameter 'alertCluster' is not null or undefined
+            assertParamExists('patchNodeAlertSettings', 'alertCluster', alertCluster)
+            const localVarPath = `/admin/v1/environments/{environmentName}/nodes/{nodeName}/alert/settings`
+                .replace(`{${"environmentName"}}`, encodeURIComponent(String(environmentName)))
+                .replace(`{${"nodeName"}}`, encodeURIComponent(String(nodeName)));
+            // 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: 'PATCH', ...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(alertCluster, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * NodeAlertApi - functional programming interface
+ * @export
+ */
+export const NodeAlertApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = NodeAlertApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 
+         * @summary Get alert settings for a node in an environment
+         * @param {string} environmentName 
+         * @param {string} nodeName 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getNodeAlertSettings(environmentName: string, nodeName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AlertCluster>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getNodeAlertSettings(environmentName, nodeName, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['NodeAlertApi.getNodeAlertSettings']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary List node metric and NodeDown event alert rules
+         * @param {string} environmentName 
+         * @param {string} nodeName 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listNodeAlertRules(environmentName: string, nodeName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AlertRuleList>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listNodeAlertRules(environmentName, nodeName, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['NodeAlertApi.listNodeAlertRules']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary Update supplied node alert settings; omitted fields are preserved
+         * @param {string} environmentName 
+         * @param {string} nodeName 
+         * @param {AlertCluster} alertCluster 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async patchNodeAlertSettings(environmentName: string, nodeName: string, alertCluster: AlertCluster, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AlertCluster>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.patchNodeAlertSettings(environmentName, nodeName, alertCluster, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['NodeAlertApi.patchNodeAlertSettings']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * NodeAlertApi - factory interface
+ * @export
+ */
+export const NodeAlertApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = NodeAlertApiFp(configuration)
+    return {
+        /**
+         * 
+         * @summary Get alert settings for a node in an environment
+         * @param {NodeAlertApiGetNodeAlertSettingsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getNodeAlertSettings(requestParameters: NodeAlertApiGetNodeAlertSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AlertCluster> {
+            return localVarFp.getNodeAlertSettings(requestParameters.environmentName, requestParameters.nodeName, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary List node metric and NodeDown event alert rules
+         * @param {NodeAlertApiListNodeAlertRulesRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listNodeAlertRules(requestParameters: NodeAlertApiListNodeAlertRulesRequest, options?: RawAxiosRequestConfig): AxiosPromise<AlertRuleList> {
+            return localVarFp.listNodeAlertRules(requestParameters.environmentName, requestParameters.nodeName, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Update supplied node alert settings; omitted fields are preserved
+         * @param {NodeAlertApiPatchNodeAlertSettingsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchNodeAlertSettings(requestParameters: NodeAlertApiPatchNodeAlertSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AlertCluster> {
+            return localVarFp.patchNodeAlertSettings(requestParameters.environmentName, requestParameters.nodeName, requestParameters.alertCluster, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * NodeAlertApi - interface
+ * @export
+ * @interface NodeAlertApi
+ */
+export interface NodeAlertApiInterface {
+    /**
+     * 
+     * @summary Get alert settings for a node in an environment
+     * @param {NodeAlertApiGetNodeAlertSettingsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NodeAlertApiInterface
+     */
+    getNodeAlertSettings(requestParameters: NodeAlertApiGetNodeAlertSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AlertCluster>;
+
+    /**
+     * 
+     * @summary List node metric and NodeDown event alert rules
+     * @param {NodeAlertApiListNodeAlertRulesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NodeAlertApiInterface
+     */
+    listNodeAlertRules(requestParameters: NodeAlertApiListNodeAlertRulesRequest, options?: RawAxiosRequestConfig): AxiosPromise<AlertRuleList>;
+
+    /**
+     * 
+     * @summary Update supplied node alert settings; omitted fields are preserved
+     * @param {NodeAlertApiPatchNodeAlertSettingsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NodeAlertApiInterface
+     */
+    patchNodeAlertSettings(requestParameters: NodeAlertApiPatchNodeAlertSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AlertCluster>;
+
+}
+
+/**
+ * Request parameters for getNodeAlertSettings operation in NodeAlertApi.
+ * @export
+ * @interface NodeAlertApiGetNodeAlertSettingsRequest
+ */
+export interface NodeAlertApiGetNodeAlertSettingsRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof NodeAlertApiGetNodeAlertSettings
+     */
+    readonly environmentName: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof NodeAlertApiGetNodeAlertSettings
+     */
+    readonly nodeName: string
+}
+
+/**
+ * Request parameters for listNodeAlertRules operation in NodeAlertApi.
+ * @export
+ * @interface NodeAlertApiListNodeAlertRulesRequest
+ */
+export interface NodeAlertApiListNodeAlertRulesRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof NodeAlertApiListNodeAlertRules
+     */
+    readonly environmentName: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof NodeAlertApiListNodeAlertRules
+     */
+    readonly nodeName: string
+}
+
+/**
+ * Request parameters for patchNodeAlertSettings operation in NodeAlertApi.
+ * @export
+ * @interface NodeAlertApiPatchNodeAlertSettingsRequest
+ */
+export interface NodeAlertApiPatchNodeAlertSettingsRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof NodeAlertApiPatchNodeAlertSettings
+     */
+    readonly environmentName: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof NodeAlertApiPatchNodeAlertSettings
+     */
+    readonly nodeName: string
+
+    /**
+     * 
+     * @type {AlertCluster}
+     * @memberof NodeAlertApiPatchNodeAlertSettings
+     */
+    readonly alertCluster: AlertCluster
+}
+
+/**
+ * NodeAlertApi - object-oriented interface
+ * @export
+ * @class NodeAlertApi
+ * @extends {BaseAPI}
+ */
+export class NodeAlertApi extends BaseAPI implements NodeAlertApiInterface {
+    /**
+     * 
+     * @summary Get alert settings for a node in an environment
+     * @param {NodeAlertApiGetNodeAlertSettingsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NodeAlertApi
+     */
+    public getNodeAlertSettings(requestParameters: NodeAlertApiGetNodeAlertSettingsRequest, options?: RawAxiosRequestConfig) {
+        return NodeAlertApiFp(this.configuration).getNodeAlertSettings(requestParameters.environmentName, requestParameters.nodeName, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary List node metric and NodeDown event alert rules
+     * @param {NodeAlertApiListNodeAlertRulesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NodeAlertApi
+     */
+    public listNodeAlertRules(requestParameters: NodeAlertApiListNodeAlertRulesRequest, options?: RawAxiosRequestConfig) {
+        return NodeAlertApiFp(this.configuration).listNodeAlertRules(requestParameters.environmentName, requestParameters.nodeName, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Update supplied node alert settings; omitted fields are preserved
+     * @param {NodeAlertApiPatchNodeAlertSettingsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NodeAlertApi
+     */
+    public patchNodeAlertSettings(requestParameters: NodeAlertApiPatchNodeAlertSettingsRequest, options?: RawAxiosRequestConfig) {
+        return NodeAlertApiFp(this.configuration).patchNodeAlertSettings(requestParameters.environmentName, requestParameters.nodeName, requestParameters.alertCluster, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+

package/src/adminapi/apis/opsrequest-api.ts

@@ -165,7 +165,7 @@ export const OpsrequestApiAxiosParamCreator = function (configuration?: Configur
         },
         /**
          * 
-         * @summary Expose cluster loadbalancer endpoint
+         * @summary Expose cluster endpoint
          * @param {string} orgName name of the Org
          * @param {string} clusterName name of the KubeBlocks cluster
          * @param {OpsExpose} body 
@@ -865,7 +865,7 @@ export const OpsrequestApiFp = function(configuration?: Configuration) {
         },
         /**
          * 
-         * @summary Expose cluster loadbalancer endpoint
+         * @summary Expose cluster endpoint
          * @param {string} orgName name of the Org
          * @param {string} clusterName name of the KubeBlocks cluster
          * @param {OpsExpose} body 
@@ -1090,7 +1090,7 @@ export const OpsrequestApiFactory = function (configuration?: Configuration, bas
         },
         /**
          * 
-         * @summary Expose cluster loadbalancer endpoint
+         * @summary Expose cluster endpoint
          * @param {OpsrequestApiExposeClusterRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1249,7 +1249,7 @@ export interface OpsrequestApiInterface {
 
     /**
      * 
-     * @summary Expose cluster loadbalancer endpoint
+     * @summary Expose cluster endpoint
      * @param {OpsrequestApiExposeClusterRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1832,7 +1832,7 @@ export class OpsrequestApi extends BaseAPI implements OpsrequestApiInterface {
 
     /**
      * 
-     * @summary Expose cluster loadbalancer endpoint
+     * @summary Expose cluster endpoint
      * @param {OpsrequestApiExposeClusterRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}