kb-cloud-client-typescript 2.3.0-alpha.86 → 2.3.0-alpha.88

package/dist/openapi/apis/dms-api.js

@@ -586,10 +586,11 @@ const DmsApiAxiosParamCreator = function (configuration) {
          * @param {string} schema schema or database name
          * @param {string} type object type
          * @param {string} objectName object name
+         * @param {string} [database] database name, used by engines such as MSSQL when reading object metadata inside a schema
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getObjectInfo: async (orgName, clusterName, id, schema, type, objectName, options = {}) => {
+        getObjectInfo: async (orgName, clusterName, id, schema, type, objectName, database, options = {}) => {
             // verify required parameter 'orgName' is not null or undefined
             (0, common_1.assertParamExists)('getObjectInfo', 'orgName', orgName);
             // verify required parameter 'clusterName' is not null or undefined
@@ -620,6 +621,9 @@ const DmsApiAxiosParamCreator = function (configuration) {
             const localVarQueryParameter = {};
             // authentication BearerToken required
             await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "authorization", configuration);
+            if (database !== undefined) {
+                localVarQueryParameter['database'] = database;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -634,10 +638,11 @@ const DmsApiAxiosParamCreator = function (configuration) {
          * @param {string} orgName name of the Org
          * @param {string} clusterName name of the cluster
          * @param {string} id id of the datasource
+         * @param {string} [database] database name, used by engines such as MSSQL when listing schemas inside a database
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSchemaList: async (orgName, clusterName, id, options = {}) => {
+        getSchemaList: async (orgName, clusterName, id, database, options = {}) => {
             // verify required parameter 'orgName' is not null or undefined
             (0, common_1.assertParamExists)('getSchemaList', 'orgName', orgName);
             // verify required parameter 'clusterName' is not null or undefined
@@ -659,6 +664,9 @@ const DmsApiAxiosParamCreator = function (configuration) {
             const localVarQueryParameter = {};
             // authentication BearerToken required
             await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "authorization", configuration);
+            if (database !== undefined) {
+                localVarQueryParameter['database'] = database;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -786,6 +794,45 @@ const DmsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         *
+         * @summary list all databases of the datasource
+         * @param {string} orgName name of the Org
+         * @param {string} clusterName name of the cluster
+         * @param {string} id id of the datasource
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listDmsDatabases: async (orgName, clusterName, id, options = {}) => {
+            // verify required parameter 'orgName' is not null or undefined
+            (0, common_1.assertParamExists)('listDmsDatabases', 'orgName', orgName);
+            // verify required parameter 'clusterName' is not null or undefined
+            (0, common_1.assertParamExists)('listDmsDatabases', 'clusterName', clusterName);
+            // verify required parameter 'id' is not null or undefined
+            (0, common_1.assertParamExists)('listDmsDatabases', 'id', id);
+            const localVarPath = `/api/v1/organizations/{orgName}/clusters/{clusterName}/datasource/{id}/databases`
+                .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
+                .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)))
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication BearerToken required
+            await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "authorization", configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          *
          * @summary list collections in a MongoDB database
@@ -915,10 +962,11 @@ const DmsApiAxiosParamCreator = function (configuration) {
          * @param {string} id id of the datasource
          * @param {string} schema schema or database name
          * @param {string} type object type
+         * @param {string} [database] database name, used by engines such as MSSQL when listing object names inside a schema
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listObjectNamesByType: async (orgName, clusterName, id, schema, type, options = {}) => {
+        listObjectNamesByType: async (orgName, clusterName, id, schema, type, database, options = {}) => {
             // verify required parameter 'orgName' is not null or undefined
             (0, common_1.assertParamExists)('listObjectNamesByType', 'orgName', orgName);
             // verify required parameter 'clusterName' is not null or undefined
@@ -946,6 +994,9 @@ const DmsApiAxiosParamCreator = function (configuration) {
             const localVarQueryParameter = {};
             // authentication BearerToken required
             await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "authorization", configuration);
+            if (database !== undefined) {
+                localVarQueryParameter['database'] = database;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -961,10 +1012,11 @@ const DmsApiAxiosParamCreator = function (configuration) {
          * @param {string} clusterName name of the cluster
          * @param {string} id id of the datasource
          * @param {string} schema schema or database name
+         * @param {string} [database] database name, used by engines such as MSSQL when listing objects inside a schema
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listObjectTypesInSchema: async (orgName, clusterName, id, schema, options = {}) => {
+        listObjectTypesInSchema: async (orgName, clusterName, id, schema, database, options = {}) => {
             // verify required parameter 'orgName' is not null or undefined
             (0, common_1.assertParamExists)('listObjectTypesInSchema', 'orgName', orgName);
             // verify required parameter 'clusterName' is not null or undefined
@@ -989,6 +1041,9 @@ const DmsApiAxiosParamCreator = function (configuration) {
             const localVarQueryParameter = {};
             // authentication BearerToken required
             await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "authorization", configuration);
+            if (database !== undefined) {
+                localVarQueryParameter['database'] = database;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -2639,12 +2694,13 @@ const DmsApiFp = function (configuration) {
          * @param {string} schema schema or database name
          * @param {string} type object type
          * @param {string} objectName object name
+         * @param {string} [database] database name, used by engines such as MSSQL when reading object metadata inside a schema
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getObjectInfo(orgName, clusterName, id, schema, type, objectName, options) {
+        async getObjectInfo(orgName, clusterName, id, schema, type, objectName, database, options) {
             var _a, _b, _c;
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectInfo(orgName, clusterName, id, schema, type, objectName, options);
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectInfo(orgName, clusterName, id, schema, type, objectName, database, options);
             const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
             const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DmsApi.getObjectInfo']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -2655,12 +2711,13 @@ const DmsApiFp = function (configuration) {
          * @param {string} orgName name of the Org
          * @param {string} clusterName name of the cluster
          * @param {string} id id of the datasource
+         * @param {string} [database] database name, used by engines such as MSSQL when listing schemas inside a database
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getSchemaList(orgName, clusterName, id, options) {
+        async getSchemaList(orgName, clusterName, id, database, options) {
             var _a, _b, _c;
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getSchemaList(orgName, clusterName, id, options);
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getSchemaList(orgName, clusterName, id, database, options);
             const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
             const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DmsApi.getSchemaList']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -2713,6 +2770,22 @@ const DmsApiFp = function (configuration) {
             const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DmsApi.listDataSourceV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         *
+         * @summary list all databases of the datasource
+         * @param {string} orgName name of the Org
+         * @param {string} clusterName name of the cluster
+         * @param {string} id id of the datasource
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listDmsDatabases(orgName, clusterName, id, options) {
+            var _a, _b, _c;
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listDmsDatabases(orgName, clusterName, id, options);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DmsApi.listDmsDatabases']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          *
          * @summary list collections in a MongoDB database
@@ -2770,12 +2843,13 @@ const DmsApiFp = function (configuration) {
          * @param {string} id id of the datasource
          * @param {string} schema schema or database name
          * @param {string} type object type
+         * @param {string} [database] database name, used by engines such as MSSQL when listing object names inside a schema
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listObjectNamesByType(orgName, clusterName, id, schema, type, options) {
+        async listObjectNamesByType(orgName, clusterName, id, schema, type, database, options) {
             var _a, _b, _c;
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listObjectNamesByType(orgName, clusterName, id, schema, type, options);
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listObjectNamesByType(orgName, clusterName, id, schema, type, database, options);
             const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
             const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DmsApi.listObjectNamesByType']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -2787,12 +2861,13 @@ const DmsApiFp = function (configuration) {
          * @param {string} clusterName name of the cluster
          * @param {string} id id of the datasource
          * @param {string} schema schema or database name
+         * @param {string} [database] database name, used by engines such as MSSQL when listing objects inside a schema
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listObjectTypesInSchema(orgName, clusterName, id, schema, options) {
+        async listObjectTypesInSchema(orgName, clusterName, id, schema, database, options) {
             var _a, _b, _c;
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listObjectTypesInSchema(orgName, clusterName, id, schema, options);
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listObjectTypesInSchema(orgName, clusterName, id, schema, database, options);
             const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
             const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DmsApi.listObjectTypesInSchema']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -3481,7 +3556,7 @@ const DmsApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         getObjectInfo(requestParameters, options) {
-            return localVarFp.getObjectInfo(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.schema, requestParameters.type, requestParameters.objectName, options).then((request) => request(axios, basePath));
+            return localVarFp.getObjectInfo(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.schema, requestParameters.type, requestParameters.objectName, requestParameters.database, options).then((request) => request(axios, basePath));
         },
         /**
          *
@@ -3491,7 +3566,7 @@ const DmsApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         getSchemaList(requestParameters, options) {
-            return localVarFp.getSchemaList(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, options).then((request) => request(axios, basePath));
+            return localVarFp.getSchemaList(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.database, options).then((request) => request(axios, basePath));
         },
         /**
          *
@@ -3523,6 +3598,16 @@ const DmsApiFactory = function (configuration, basePath, axios) {
         listDataSourceV2(requestParameters, options) {
             return localVarFp.listDataSourceV2(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(axios, basePath));
         },
+        /**
+         *
+         * @summary list all databases of the datasource
+         * @param {DmsApiListDmsDatabasesRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listDmsDatabases(requestParameters, options) {
+            return localVarFp.listDmsDatabases(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, options).then((request) => request(axios, basePath));
+        },
         /**
          *
          * @summary list collections in a MongoDB database
@@ -3561,7 +3646,7 @@ const DmsApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         listObjectNamesByType(requestParameters, options) {
-            return localVarFp.listObjectNamesByType(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.schema, requestParameters.type, options).then((request) => request(axios, basePath));
+            return localVarFp.listObjectNamesByType(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.schema, requestParameters.type, requestParameters.database, options).then((request) => request(axios, basePath));
         },
         /**
          *
@@ -3571,7 +3656,7 @@ const DmsApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         listObjectTypesInSchema(requestParameters, options) {
-            return localVarFp.listObjectTypesInSchema(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.schema, options).then((request) => request(axios, basePath));
+            return localVarFp.listObjectTypesInSchema(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.schema, requestParameters.database, options).then((request) => request(axios, basePath));
         },
         /**
          *
@@ -4037,7 +4122,7 @@ class DmsApi extends base_1.BaseAPI {
      * @memberof DmsApi
      */
     getObjectInfo(requestParameters, options) {
-        return (0, exports.DmsApiFp)(this.configuration).getObjectInfo(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.schema, requestParameters.type, requestParameters.objectName, options).then((request) => request(this.axios, this.basePath));
+        return (0, exports.DmsApiFp)(this.configuration).getObjectInfo(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.schema, requestParameters.type, requestParameters.objectName, requestParameters.database, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      *
@@ -4048,7 +4133,7 @@ class DmsApi extends base_1.BaseAPI {
      * @memberof DmsApi
      */
     getSchemaList(requestParameters, options) {
-        return (0, exports.DmsApiFp)(this.configuration).getSchemaList(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, options).then((request) => request(this.axios, this.basePath));
+        return (0, exports.DmsApiFp)(this.configuration).getSchemaList(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.database, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      *
@@ -4083,6 +4168,17 @@ class DmsApi extends base_1.BaseAPI {
     listDataSourceV2(requestParameters, options) {
         return (0, exports.DmsApiFp)(this.configuration).listDataSourceV2(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     *
+     * @summary list all databases of the datasource
+     * @param {DmsApiListDmsDatabasesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DmsApi
+     */
+    listDmsDatabases(requestParameters, options) {
+        return (0, exports.DmsApiFp)(this.configuration).listDmsDatabases(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary list collections in a MongoDB database
@@ -4125,7 +4221,7 @@ class DmsApi extends base_1.BaseAPI {
      * @memberof DmsApi
      */
     listObjectNamesByType(requestParameters, options) {
-        return (0, exports.DmsApiFp)(this.configuration).listObjectNamesByType(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.schema, requestParameters.type, options).then((request) => request(this.axios, this.basePath));
+        return (0, exports.DmsApiFp)(this.configuration).listObjectNamesByType(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.schema, requestParameters.type, requestParameters.database, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      *
@@ -4136,7 +4232,7 @@ class DmsApi extends base_1.BaseAPI {
      * @memberof DmsApi
      */
     listObjectTypesInSchema(requestParameters, options) {
-        return (0, exports.DmsApiFp)(this.configuration).listObjectTypesInSchema(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.schema, options).then((request) => request(this.axios, this.basePath));
+        return (0, exports.DmsApiFp)(this.configuration).listObjectTypesInSchema(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.schema, requestParameters.database, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      *