kb-cloud-client-typescript 2.4.0-alpha.97 → 2.4.0-alpha.99

package/src/openapi/apis/shared-api.ts

@@ -272,6 +272,8 @@ import type { MilvusRoleList } from '../models';
 // @ts-ignore
 import type { MilvusRoleRequest } from '../models';
 // @ts-ignore
+import type { MongoCollectionInfo } from '../models';
+// @ts-ignore
 import type { MongoRBACBindingChange } from '../models';
 // @ts-ignore
 import type { MongoRBACCapabilities } from '../models';
@@ -13243,6 +13245,100 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Lists existing collections, views and time-series collections in a database using the cluster management connection. Returns metadata, not document contents.
+         * @summary List MongoDB cluster database objects
+         * @param {string} orgName 
+         * @param {string} clusterName 
+         * @param {string} database 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        mongoListClusterCollections: async (orgName: string, clusterName: string, database: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('mongoListClusterCollections', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('mongoListClusterCollections', 'clusterName', clusterName)
+            // verify required parameter 'database' is not null or undefined
+            assertParamExists('mongoListClusterCollections', 'database', database)
+            const localVarPath = `/api/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/databases/{database}/collections`
+                .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
+                .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)))
+                .replace(`{${"database"}}`, encodeURIComponent(String(database)));
+            // 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,
+            };
+        },
+        /**
+         * Lists existing database names using the cluster management connection. Does not require a personal Workbench datasource.
+         * @summary List MongoDB cluster databases
+         * @param {string} orgName 
+         * @param {string} clusterName 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        mongoListClusterDatabases: async (orgName: string, clusterName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('mongoListClusterDatabases', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('mongoListClusterDatabases', 'clusterName', clusterName)
+            const localVarPath = `/api/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/databases`
+                .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
+                .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)));
+            // 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};
@@ -13308,10 +13404,11 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
          * @param {string} orgName 
          * @param {string} clusterName 
          * @param {string} [database] 
+         * @param {boolean} [allDatabases] List accounts from all authentication databases. Overrides database; returns role memberships without effective privileges. Use the user detail endpoint for privileges. Requires viewUser and viewRole on the relevant databases.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        mongoListRBACUsers: async (orgName: string, clusterName: string, database?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        mongoListRBACUsers: async (orgName: string, clusterName: string, database?: string, allDatabases?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'orgName' is not null or undefined
             assertParamExists('mongoListRBACUsers', 'orgName', orgName)
             // verify required parameter 'clusterName' is not null or undefined
@@ -13341,6 +13438,10 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
                 localVarQueryParameter['database'] = database;
             }
 
+            if (allDatabases !== undefined) {
+                localVarQueryParameter['allDatabases'] = allDatabases;
+            }
+
 
     
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -22823,6 +22924,35 @@ export const SharedApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['SharedApi.mongoGetRBACUser']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Lists existing collections, views and time-series collections in a database using the cluster management connection. Returns metadata, not document contents.
+         * @summary List MongoDB cluster database objects
+         * @param {string} orgName 
+         * @param {string} clusterName 
+         * @param {string} database 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async mongoListClusterCollections(orgName: string, clusterName: string, database: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MongoCollectionInfo>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.mongoListClusterCollections(orgName, clusterName, database, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SharedApi.mongoListClusterCollections']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Lists existing database names using the cluster management connection. Does not require a personal Workbench datasource.
+         * @summary List MongoDB cluster databases
+         * @param {string} orgName 
+         * @param {string} clusterName 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async mongoListClusterDatabases(orgName: string, clusterName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.mongoListClusterDatabases(orgName, clusterName, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SharedApi.mongoListClusterDatabases']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary ListRBACRoles
@@ -22844,11 +22974,12 @@ export const SharedApiFp = function(configuration?: Configuration) {
          * @param {string} orgName 
          * @param {string} clusterName 
          * @param {string} [database] 
+         * @param {boolean} [allDatabases] List accounts from all authentication databases. Overrides database; returns role memberships without effective privileges. Use the user detail endpoint for privileges. Requires viewUser and viewRole on the relevant databases.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async mongoListRBACUsers(orgName: string, clusterName: string, database?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MongoRBACUser>>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.mongoListRBACUsers(orgName, clusterName, database, options);
+        async mongoListRBACUsers(orgName: string, clusterName: string, database?: string, allDatabases?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MongoRBACUser>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.mongoListRBACUsers(orgName, clusterName, database, allDatabases, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['SharedApi.mongoListRBACUsers']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -26837,6 +26968,26 @@ export const SharedApiFactory = function (configuration?: Configuration, basePat
         mongoGetRBACUser(requestParameters: SharedApiMongoGetRBACUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<MongoRBACUser> {
             return localVarFp.mongoGetRBACUser(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, requestParameters.username, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Lists existing collections, views and time-series collections in a database using the cluster management connection. Returns metadata, not document contents.
+         * @summary List MongoDB cluster database objects
+         * @param {SharedApiMongoListClusterCollectionsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        mongoListClusterCollections(requestParameters: SharedApiMongoListClusterCollectionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<MongoCollectionInfo>> {
+            return localVarFp.mongoListClusterCollections(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Lists existing database names using the cluster management connection. Does not require a personal Workbench datasource.
+         * @summary List MongoDB cluster databases
+         * @param {SharedApiMongoListClusterDatabasesRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        mongoListClusterDatabases(requestParameters: SharedApiMongoListClusterDatabasesRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>> {
+            return localVarFp.mongoListClusterDatabases(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary ListRBACRoles
@@ -26855,7 +27006,7 @@ export const SharedApiFactory = function (configuration?: Configuration, basePat
          * @throws {RequiredError}
          */
         mongoListRBACUsers(requestParameters: SharedApiMongoListRBACUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<MongoRBACUser>> {
-            return localVarFp.mongoListRBACUsers(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, options).then((request) => request(axios, basePath));
+            return localVarFp.mongoListRBACUsers(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, requestParameters.allDatabases, options).then((request) => request(axios, basePath));
         },
         /**
          * 
@@ -30181,6 +30332,26 @@ export interface SharedApiInterface {
      */
     mongoGetRBACUser(requestParameters: SharedApiMongoGetRBACUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<MongoRBACUser>;
 
+    /**
+     * Lists existing collections, views and time-series collections in a database using the cluster management connection. Returns metadata, not document contents.
+     * @summary List MongoDB cluster database objects
+     * @param {SharedApiMongoListClusterCollectionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApiInterface
+     */
+    mongoListClusterCollections(requestParameters: SharedApiMongoListClusterCollectionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<MongoCollectionInfo>>;
+
+    /**
+     * Lists existing database names using the cluster management connection. Does not require a personal Workbench datasource.
+     * @summary List MongoDB cluster databases
+     * @param {SharedApiMongoListClusterDatabasesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApiInterface
+     */
+    mongoListClusterDatabases(requestParameters: SharedApiMongoListClusterDatabasesRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
+
     /**
      * 
      * @summary ListRBACRoles
@@ -38974,6 +39145,55 @@ export interface SharedApiMongoGetRBACUserRequest {
     readonly username: string
 }
 
+/**
+ * Request parameters for mongoListClusterCollections operation in SharedApi.
+ * @export
+ * @interface SharedApiMongoListClusterCollectionsRequest
+ */
+export interface SharedApiMongoListClusterCollectionsRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof SharedApiMongoListClusterCollections
+     */
+    readonly orgName: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof SharedApiMongoListClusterCollections
+     */
+    readonly clusterName: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof SharedApiMongoListClusterCollections
+     */
+    readonly database: string
+}
+
+/**
+ * Request parameters for mongoListClusterDatabases operation in SharedApi.
+ * @export
+ * @interface SharedApiMongoListClusterDatabasesRequest
+ */
+export interface SharedApiMongoListClusterDatabasesRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof SharedApiMongoListClusterDatabases
+     */
+    readonly orgName: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof SharedApiMongoListClusterDatabases
+     */
+    readonly clusterName: string
+}
+
 /**
  * Request parameters for mongoListRBACRoles operation in SharedApi.
  * @export
@@ -39028,6 +39248,13 @@ export interface SharedApiMongoListRBACUsersRequest {
      * @memberof SharedApiMongoListRBACUsers
      */
     readonly database?: string
+
+    /**
+     * List accounts from all authentication databases. Overrides database; returns role memberships without effective privileges. Use the user detail endpoint for privileges. Requires viewUser and viewRole on the relevant databases.
+     * @type {boolean}
+     * @memberof SharedApiMongoListRBACUsers
+     */
+    readonly allDatabases?: boolean
 }
 
 /**
@@ -45831,6 +46058,30 @@ export class SharedApi extends BaseAPI implements SharedApiInterface {
         return SharedApiFp(this.configuration).mongoGetRBACUser(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, requestParameters.username, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Lists existing collections, views and time-series collections in a database using the cluster management connection. Returns metadata, not document contents.
+     * @summary List MongoDB cluster database objects
+     * @param {SharedApiMongoListClusterCollectionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApi
+     */
+    public mongoListClusterCollections(requestParameters: SharedApiMongoListClusterCollectionsRequest, options?: RawAxiosRequestConfig) {
+        return SharedApiFp(this.configuration).mongoListClusterCollections(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Lists existing database names using the cluster management connection. Does not require a personal Workbench datasource.
+     * @summary List MongoDB cluster databases
+     * @param {SharedApiMongoListClusterDatabasesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApi
+     */
+    public mongoListClusterDatabases(requestParameters: SharedApiMongoListClusterDatabasesRequest, options?: RawAxiosRequestConfig) {
+        return SharedApiFp(this.configuration).mongoListClusterDatabases(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary ListRBACRoles
@@ -45852,7 +46103,7 @@ export class SharedApi extends BaseAPI implements SharedApiInterface {
      * @memberof SharedApi
      */
     public mongoListRBACUsers(requestParameters: SharedApiMongoListRBACUsersRequest, options?: RawAxiosRequestConfig) {
-        return SharedApiFp(this.configuration).mongoListRBACUsers(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, options).then((request) => request(this.axios, this.basePath));
+        return SharedApiFp(this.configuration).mongoListRBACUsers(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, requestParameters.allDatabases, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/src/openapi/models/alert-object.ts

@@ -19,6 +19,9 @@ import type { AlertSeverity } from './alert-severity';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { AlertStatus } from './alert-status';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ObjectTypeEnum } from './object-type-enum';
 
 /**
  * Alert object information
@@ -56,6 +59,18 @@ export interface AlertObject {
      * @memberof AlertObject
      */
     'clusterName'?: string;
+    /**
+     * 
+     * @type {ObjectTypeEnum}
+     * @memberof AlertObject
+     */
+    'objectType'?: ObjectTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof AlertObject
+     */
+    'objectID'?: string | null;
     /**
      * 
      * @type {string}

package/src/openapi/models/engine-option-license.ts

@@ -44,6 +44,12 @@ export interface EngineOptionLicense {
      * @memberof EngineOptionLicense
      */
     'fileName'?: string;
+    /**
+     * Allowed engine license types. Omit to retain unrestricted license types.
+     * @type {Array<string>}
+     * @memberof EngineOptionLicense
+     */
+    'allowedTypes'?: Array<string>;
     /**
      * Explicit license file upload slots. Each item maps one UI upload field to the file name written into the license Secret.
      * @type {Array<EngineOptionLicenseFile>}

package/src/openapi/models/index.ts

@@ -686,6 +686,7 @@ export * from './object-privilege-spec';
 export * from './object-privilege-subject';
 export * from './object-privilege-subject-type';
 export * from './object-privilege-target';
+export * from './object-type-enum';
 export * from './offline-instance';
 export * from './offline-instance-list';
 export * from './offset-reset-strategy';

package/src/openapi/models/license-option.ts

@@ -32,5 +32,17 @@ export interface LicenseOption {
      * @memberof LicenseOption
      */
     'opsDefName': string;
+    /**
+     * Optional custom Ops parameter receiving a JSON object of candidate file SHA256 digests.
+     * @type {string}
+     * @memberof LicenseOption
+     */
+    'fileDigestParameter'?: string;
+    /**
+     * Create a standard restart dependent on successful license installation.
+     * @type {boolean}
+     * @memberof LicenseOption
+     */
+    'restartAfterUpdate'?: boolean;
 }
 

package/src/openapi/models/mongo-rbaccapabilities.ts

@@ -23,6 +23,12 @@ import type { MongoRBACResourceCapability } from './mongo-rbacresource-capabilit
  * @interface MongoRBACCapabilities
  */
 export interface MongoRBACCapabilities {
+    /**
+     * Supports allDatabases on the account list endpoint.
+     * @type {boolean}
+     * @memberof MongoRBACCapabilities
+     */
+    'allDatabaseUsers'?: boolean;
     /**
      * 
      * @type {string}

package/src/openapi/models/object-type-enum.ts

@@ -0,0 +1,32 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+
+export const ObjectTypeEnum = {
+    cluster: 'cluster',
+    channel: 'channel',
+    unknown: 'unknown'
+} as const;
+
+export type ObjectTypeEnum = typeof ObjectTypeEnum[keyof typeof ObjectTypeEnum];
+
+
+