kb-cloud-client-typescript 2.3.0-alpha.106 → 2.3.0-alpha.107

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

@@ -9355,6 +9355,59 @@ 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,
+            };
+        },
+        /**
+         * lock an account in cluster
+         * @summary Lock cluster account
+         * @param {string} engineName name of the engine
+         * @param {string} orgName name of the organization
+         * @param {string} clusterName name of the cluster
+         * @param {string} accountName name of the account
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        lockAccount: async (engineName: string, orgName: string, clusterName: string, accountName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'engineName' is not null or undefined
+            assertParamExists('lockAccount', 'engineName', engineName)
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('lockAccount', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('lockAccount', 'clusterName', clusterName)
+            // verify required parameter 'accountName' is not null or undefined
+            assertParamExists('lockAccount', 'accountName', accountName)
+            const localVarPath = `/admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/accounts/{accountName}/lock`
+                .replace(`{${"engineName"}}`, encodeURIComponent(String(engineName)))
+                .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
+                .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)))
+                .replace(`{${"accountName"}}`, encodeURIComponent(String(accountName)));
+            // 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)
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -12070,6 +12123,59 @@ 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,
+            };
+        },
+        /**
+         * unlock an account in cluster
+         * @summary Unlock cluster account
+         * @param {string} engineName name of the engine
+         * @param {string} orgName name of the organization
+         * @param {string} clusterName name of the cluster
+         * @param {string} accountName name of the account
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        unlockAccount: async (engineName: string, orgName: string, clusterName: string, accountName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'engineName' is not null or undefined
+            assertParamExists('unlockAccount', 'engineName', engineName)
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('unlockAccount', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('unlockAccount', 'clusterName', clusterName)
+            // verify required parameter 'accountName' is not null or undefined
+            assertParamExists('unlockAccount', 'accountName', accountName)
+            const localVarPath = `/admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/accounts/{accountName}/unlock`
+                .replace(`{${"engineName"}}`, encodeURIComponent(String(engineName)))
+                .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
+                .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)))
+                .replace(`{${"accountName"}}`, encodeURIComponent(String(accountName)));
+            // 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)
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -15962,6 +16068,22 @@ export const SharedApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['SharedApi.listUpgradeableServiceVersion']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * lock an account in cluster
+         * @summary Lock cluster account
+         * @param {string} engineName name of the engine
+         * @param {string} orgName name of the organization
+         * @param {string} clusterName name of the cluster
+         * @param {string} accountName name of the account
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async lockAccount(engineName: string, orgName: string, clusterName: string, accountName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.lockAccount(engineName, orgName, clusterName, accountName, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SharedApi.lockAccount']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary batch modify database tde status
@@ -16699,6 +16821,22 @@ export const SharedApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['SharedApi.unfreezeMember']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * unlock an account in cluster
+         * @summary Unlock cluster account
+         * @param {string} engineName name of the engine
+         * @param {string} orgName name of the organization
+         * @param {string} clusterName name of the cluster
+         * @param {string} accountName name of the account
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async unlockAccount(engineName: string, orgName: string, clusterName: string, accountName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.unlockAccount(engineName, orgName, clusterName, accountName, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SharedApi.unlockAccount']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * update an account in cluster
          * @summary update cluster account
@@ -18803,6 +18941,16 @@ export const SharedApiFactory = function (configuration?: Configuration, basePat
         listUpgradeableServiceVersion(requestParameters: SharedApiListUpgradeableServiceVersionRequest, options?: RawAxiosRequestConfig): AxiosPromise<EngineServiceVersions> {
             return localVarFp.listUpgradeableServiceVersion(requestParameters.clusterName, requestParameters.orgName, requestParameters.component, options).then((request) => request(axios, basePath));
         },
+        /**
+         * lock an account in cluster
+         * @summary Lock cluster account
+         * @param {SharedApiLockAccountRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        lockAccount(requestParameters: SharedApiLockAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.lockAccount(requestParameters.engineName, requestParameters.orgName, requestParameters.clusterName, requestParameters.accountName, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary batch modify database tde status
@@ -19212,6 +19360,16 @@ export const SharedApiFactory = function (configuration?: Configuration, basePat
         unfreezeMember(requestParameters: SharedApiUnfreezeMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
             return localVarFp.unfreezeMember(requestParameters.orgName, requestParameters.memberId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * unlock an account in cluster
+         * @summary Unlock cluster account
+         * @param {SharedApiUnlockAccountRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        unlockAccount(requestParameters: SharedApiUnlockAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.unlockAccount(requestParameters.engineName, requestParameters.orgName, requestParameters.clusterName, requestParameters.accountName, options).then((request) => request(axios, basePath));
+        },
         /**
          * update an account in cluster
          * @summary update cluster account
@@ -21186,6 +21344,16 @@ export interface SharedApiInterface {
      */
     listUpgradeableServiceVersion(requestParameters: SharedApiListUpgradeableServiceVersionRequest, options?: RawAxiosRequestConfig): AxiosPromise<EngineServiceVersions>;
 
+    /**
+     * lock an account in cluster
+     * @summary Lock cluster account
+     * @param {SharedApiLockAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApiInterface
+     */
+    lockAccount(requestParameters: SharedApiLockAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+
     /**
      * 
      * @summary batch modify database tde status
@@ -21595,6 +21763,16 @@ export interface SharedApiInterface {
      */
     unfreezeMember(requestParameters: SharedApiUnfreezeMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
 
+    /**
+     * unlock an account in cluster
+     * @summary Unlock cluster account
+     * @param {SharedApiUnlockAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApiInterface
+     */
+    unlockAccount(requestParameters: SharedApiUnlockAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+
     /**
      * update an account in cluster
      * @summary update cluster account
@@ -26929,6 +27107,41 @@ export interface SharedApiListUpgradeableServiceVersionRequest {
     readonly component: string
 }
 
+/**
+ * Request parameters for lockAccount operation in SharedApi.
+ * @export
+ * @interface SharedApiLockAccountRequest
+ */
+export interface SharedApiLockAccountRequest {
+    /**
+     * name of the engine
+     * @type {string}
+     * @memberof SharedApiLockAccount
+     */
+    readonly engineName: string
+
+    /**
+     * name of the organization
+     * @type {string}
+     * @memberof SharedApiLockAccount
+     */
+    readonly orgName: string
+
+    /**
+     * name of the cluster
+     * @type {string}
+     * @memberof SharedApiLockAccount
+     */
+    readonly clusterName: string
+
+    /**
+     * name of the account
+     * @type {string}
+     * @memberof SharedApiLockAccount
+     */
+    readonly accountName: string
+}
+
 /**
  * Request parameters for manageMssqlTDEDatabase operation in SharedApi.
  * @export
@@ -28924,6 +29137,41 @@ export interface SharedApiUnfreezeMemberRequest {
     readonly memberId: string
 }
 
+/**
+ * Request parameters for unlockAccount operation in SharedApi.
+ * @export
+ * @interface SharedApiUnlockAccountRequest
+ */
+export interface SharedApiUnlockAccountRequest {
+    /**
+     * name of the engine
+     * @type {string}
+     * @memberof SharedApiUnlockAccount
+     */
+    readonly engineName: string
+
+    /**
+     * name of the organization
+     * @type {string}
+     * @memberof SharedApiUnlockAccount
+     */
+    readonly orgName: string
+
+    /**
+     * name of the cluster
+     * @type {string}
+     * @memberof SharedApiUnlockAccount
+     */
+    readonly clusterName: string
+
+    /**
+     * name of the account
+     * @type {string}
+     * @memberof SharedApiUnlockAccount
+     */
+    readonly accountName: string
+}
+
 /**
  * Request parameters for updateAccount operation in SharedApi.
  * @export
@@ -31757,6 +32005,18 @@ export class SharedApi extends BaseAPI implements SharedApiInterface {
         return SharedApiFp(this.configuration).listUpgradeableServiceVersion(requestParameters.clusterName, requestParameters.orgName, requestParameters.component, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * lock an account in cluster
+     * @summary Lock cluster account
+     * @param {SharedApiLockAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApi
+     */
+    public lockAccount(requestParameters: SharedApiLockAccountRequest, options?: RawAxiosRequestConfig) {
+        return SharedApiFp(this.configuration).lockAccount(requestParameters.engineName, requestParameters.orgName, requestParameters.clusterName, requestParameters.accountName, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary batch modify database tde status
@@ -32248,6 +32508,18 @@ export class SharedApi extends BaseAPI implements SharedApiInterface {
         return SharedApiFp(this.configuration).unfreezeMember(requestParameters.orgName, requestParameters.memberId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * unlock an account in cluster
+     * @summary Unlock cluster account
+     * @param {SharedApiUnlockAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApi
+     */
+    public unlockAccount(requestParameters: SharedApiUnlockAccountRequest, options?: RawAxiosRequestConfig) {
+        return SharedApiFp(this.configuration).unlockAccount(requestParameters.engineName, requestParameters.orgName, requestParameters.clusterName, requestParameters.accountName, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * update an account in cluster
      * @summary update cluster account

package/src/adminapi/models/account-option.ts

@@ -74,6 +74,12 @@ export interface AccountOption {
      * @memberof AccountOption
      */
     'delete': boolean;
+    /**
+     * Whether the engine supports account lock and unlock actions.
+     * @type {boolean}
+     * @memberof AccountOption
+     */
+    'lock'?: boolean;
     /**
      * 
      * @type {boolean}

package/src/adminapi.yaml

@@ -18732,6 +18732,94 @@ paths:
         - rdbms
         - shared
       x-codegen-request-body-name: body
+  /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/accounts/{accountName}/lock:
+    patch:
+      description: lock an account in cluster
+      summary: Lock cluster account
+      operationId: lockAccount
+      parameters:
+        - description: name of the engine
+          in: path
+          name: engineName
+          required: true
+          schema:
+            type: string
+        - description: name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: name of the cluster
+          in: path
+          name: clusterName
+          required: true
+          schema:
+            type: string
+        - description: name of the account
+          in: path
+          name: accountName
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          content: {}
+          description: Returned when account is locked successfully.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - account
+        - rdbms
+        - shared
+  /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/accounts/{accountName}/unlock:
+    patch:
+      description: unlock an account in cluster
+      summary: Unlock cluster account
+      operationId: unlockAccount
+      parameters:
+        - description: name of the engine
+          in: path
+          name: engineName
+          required: true
+          schema:
+            type: string
+        - description: name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: name of the cluster
+          in: path
+          name: clusterName
+          required: true
+          schema:
+            type: string
+        - description: name of the account
+          in: path
+          name: accountName
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          content: {}
+          description: Returned when account is unlocked successfully.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - account
+        - rdbms
+        - shared
   /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/sessions:
     get:
       description: list sessions in cluster
@@ -30083,6 +30171,9 @@ components:
           type: boolean
         delete:
           type: boolean
+        lock:
+          type: boolean
+          description: Whether the engine supports account lock and unlock actions.
         displayRootAccount:
           type: boolean
           x-omitempty: false