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

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

@@ -28,6 +28,8 @@ import type { Account } from '../models';
 // @ts-ignore
 import type { AccountListItem } from '../models';
 // @ts-ignore
+import type { MongoCollectionInfo } from '../models';
+// @ts-ignore
 import type { MongoRBACBindingChange } from '../models';
 // @ts-ignore
 import type { MongoRBACCapabilities } from '../models';
@@ -667,6 +669,100 @@ export const MongodbApiAxiosParamCreator = function (configuration?: Configurati
 
 
     
+            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};
@@ -732,10 +828,11 @@ export const MongodbApiAxiosParamCreator = function (configuration?: Configurati
          * @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
@@ -765,6 +862,10 @@ export const MongodbApiAxiosParamCreator = function (configuration?: Configurati
                 localVarQueryParameter['database'] = database;
             }
 
+            if (allDatabases !== undefined) {
+                localVarQueryParameter['allDatabases'] = allDatabases;
+            }
+
 
     
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -1032,6 +1133,35 @@ export const MongodbApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['MongodbApi.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['MongodbApi.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['MongodbApi.mongoListClusterDatabases']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary ListRBACRoles
@@ -1053,11 +1183,12 @@ export const MongodbApiFp = 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['MongodbApi.mongoListRBACUsers']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1209,6 +1340,26 @@ export const MongodbApiFactory = function (configuration?: Configuration, basePa
         mongoGetRBACUser(requestParameters: MongodbApiMongoGetRBACUserRequest, 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 {MongodbApiMongoListClusterCollectionsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        mongoListClusterCollections(requestParameters: MongodbApiMongoListClusterCollectionsRequest, 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 {MongodbApiMongoListClusterDatabasesRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        mongoListClusterDatabases(requestParameters: MongodbApiMongoListClusterDatabasesRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>> {
+            return localVarFp.mongoListClusterDatabases(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary ListRBACRoles
@@ -1227,7 +1378,7 @@ export const MongodbApiFactory = function (configuration?: Configuration, basePa
          * @throws {RequiredError}
          */
         mongoListRBACUsers(requestParameters: MongodbApiMongoListRBACUsersRequest, 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));
         },
         /**
          * 
@@ -1368,6 +1519,26 @@ export interface MongodbApiInterface {
      */
     mongoGetRBACUser(requestParameters: MongodbApiMongoGetRBACUserRequest, 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 {MongodbApiMongoListClusterCollectionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MongodbApiInterface
+     */
+    mongoListClusterCollections(requestParameters: MongodbApiMongoListClusterCollectionsRequest, 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 {MongodbApiMongoListClusterDatabasesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MongodbApiInterface
+     */
+    mongoListClusterDatabases(requestParameters: MongodbApiMongoListClusterDatabasesRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
+
     /**
      * 
      * @summary ListRBACRoles
@@ -1785,6 +1956,55 @@ export interface MongodbApiMongoGetRBACUserRequest {
     readonly username: string
 }
 
+/**
+ * Request parameters for mongoListClusterCollections operation in MongodbApi.
+ * @export
+ * @interface MongodbApiMongoListClusterCollectionsRequest
+ */
+export interface MongodbApiMongoListClusterCollectionsRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof MongodbApiMongoListClusterCollections
+     */
+    readonly orgName: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof MongodbApiMongoListClusterCollections
+     */
+    readonly clusterName: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof MongodbApiMongoListClusterCollections
+     */
+    readonly database: string
+}
+
+/**
+ * Request parameters for mongoListClusterDatabases operation in MongodbApi.
+ * @export
+ * @interface MongodbApiMongoListClusterDatabasesRequest
+ */
+export interface MongodbApiMongoListClusterDatabasesRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof MongodbApiMongoListClusterDatabases
+     */
+    readonly orgName: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof MongodbApiMongoListClusterDatabases
+     */
+    readonly clusterName: string
+}
+
 /**
  * Request parameters for mongoListRBACRoles operation in MongodbApi.
  * @export
@@ -1839,6 +2059,13 @@ export interface MongodbApiMongoListRBACUsersRequest {
      * @memberof MongodbApiMongoListRBACUsers
      */
     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 MongodbApiMongoListRBACUsers
+     */
+    readonly allDatabases?: boolean
 }
 
 /**
@@ -2034,6 +2261,30 @@ export class MongodbApi extends BaseAPI implements MongodbApiInterface {
         return MongodbApiFp(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 {MongodbApiMongoListClusterCollectionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MongodbApi
+     */
+    public mongoListClusterCollections(requestParameters: MongodbApiMongoListClusterCollectionsRequest, options?: RawAxiosRequestConfig) {
+        return MongodbApiFp(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 {MongodbApiMongoListClusterDatabasesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MongodbApi
+     */
+    public mongoListClusterDatabases(requestParameters: MongodbApiMongoListClusterDatabasesRequest, options?: RawAxiosRequestConfig) {
+        return MongodbApiFp(this.configuration).mongoListClusterDatabases(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary ListRBACRoles
@@ -2055,7 +2306,7 @@ export class MongodbApi extends BaseAPI implements MongodbApiInterface {
      * @memberof MongodbApi
      */
     public mongoListRBACUsers(requestParameters: MongodbApiMongoListRBACUsersRequest, options?: RawAxiosRequestConfig) {
-        return MongodbApiFp(this.configuration).mongoListRBACUsers(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, options).then((request) => request(this.axios, this.basePath));
+        return MongodbApiFp(this.configuration).mongoListRBACUsers(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, requestParameters.allDatabases, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**