kb-cloud-client-typescript 2.4.0-alpha.101 → 2.4.0-alpha.104

package/dist/adminapi/apis/shared-api.d.ts

@@ -174,11 +174,15 @@ import type { OpsUpgrade } from '../models';
 import type { OpsVScale } from '../models';
 import type { OpsVolumeExpand } from '../models';
 import type { Org } from '../models';
+import type { OrgDeletionAction } from '../models';
+import type { OrgDeletionPreview } from '../models';
+import type { OrgLifecycleRequest } from '../models';
 import type { OrgMember } from '../models';
 import type { OrgMemberAdd } from '../models';
 import type { OrgMemberList } from '../models';
 import type { OrgMemberUpdate } from '../models';
 import type { OrgParameter } from '../models';
+import type { OrgPurgeResult } from '../models';
 import type { OrgTagsList } from '../models';
 import type { OrgUpdate } from '../models';
 import type { ParamTplApplyToClusterList } from '../models';
@@ -926,10 +930,11 @@ export declare const SharedApiAxiosParamCreator: (configuration?: Configuration)
      * partially delete the specified org
      * @summary Delete organization
      * @param {string} orgName name of the Org
+     * @param {string} orgID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteOrg: (orgName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    deleteOrg: (orgName: string, orgID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * delete a Org Member
      * @summary Delete member
@@ -1213,7 +1218,7 @@ export declare const SharedApiAxiosParamCreator: (configuration?: Configuration)
     exportParameterTemplateFromCluster: (orgName: string, clusterName: string, body: ParamTplCreateFromCluster, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
-     * @summary Expose cluster loadbalancer endpoint
+     * @summary Expose cluster endpoint
      * @param {string} orgName name of the Org
      * @param {string} clusterName name of the KubeBlocks cluster
      * @param {OpsExpose} body
@@ -2922,6 +2927,16 @@ export declare const SharedApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     previewAccountPrivilegeReset: (engineName: string, orgName: string, clusterName: string, accountName: string, subjectType?: ObjectPrivilegeSubjectType, host?: string, subjectQualifiers?: string, databaseNames?: Array<string>, allDatabases?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Preview organization deletion or purge
+     * @param {string} orgName
+     * @param {string} orgID
+     * @param {OrgDeletionAction} action
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    previewOrgDeletion: (orgName: string, orgID: string, action: OrgDeletionAction, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Produce message to topic
@@ -2943,6 +2958,15 @@ export declare const SharedApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     promoteCluster: (orgName: string, clusterName: string, body: OpsPromote, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Purge organization
+     * @param {string} orgName
+     * @param {OrgLifecycleRequest} orgLifecycleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    purgeOrg: (orgName: string, orgLifecycleRequest: OrgLifecycleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Create or update Elasticsearch security role
@@ -3392,6 +3416,15 @@ export declare const SharedApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     restartInstance: (orgName: string, clusterName: string, instanceName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Restore organization
+     * @param {string} orgName
+     * @param {OrgLifecycleRequest} orgLifecycleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    restoreOrg: (orgName: string, orgLifecycleRequest: OrgLifecycleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Restore cluster from the Recycle Bin of the Org
@@ -4635,10 +4668,11 @@ export declare const SharedApiFp: (configuration?: Configuration) => {
      * partially delete the specified org
      * @summary Delete organization
      * @param {string} orgName name of the Org
+     * @param {string} orgID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteOrg(orgName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    deleteOrg(orgName: string, orgID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * delete a Org Member
      * @summary Delete member
@@ -4922,7 +4956,7 @@ export declare const SharedApiFp: (configuration?: Configuration) => {
     exportParameterTemplateFromCluster(orgName: string, clusterName: string, body: ParamTplCreateFromCluster, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
-     * @summary Expose cluster loadbalancer endpoint
+     * @summary Expose cluster endpoint
      * @param {string} orgName name of the Org
      * @param {string} clusterName name of the KubeBlocks cluster
      * @param {OpsExpose} body
@@ -6639,6 +6673,16 @@ export declare const SharedApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     previewAccountPrivilegeReset(engineName: string, orgName: string, clusterName: string, accountName: string, subjectType?: ObjectPrivilegeSubjectType, host?: string, subjectQualifiers?: string, databaseNames?: Array<string>, allDatabases?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ObjectPrivilegeResetStep>>>;
+    /**
+     *
+     * @summary Preview organization deletion or purge
+     * @param {string} orgName
+     * @param {string} orgID
+     * @param {OrgDeletionAction} action
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    previewOrgDeletion(orgName: string, orgID: string, action: OrgDeletionAction, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgDeletionPreview>>;
     /**
      *
      * @summary Produce message to topic
@@ -6660,6 +6704,15 @@ export declare const SharedApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     promoteCluster(orgName: string, clusterName: string, body: OpsPromote, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OpsRequestName>>;
+    /**
+     *
+     * @summary Purge organization
+     * @param {string} orgName
+     * @param {OrgLifecycleRequest} orgLifecycleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    purgeOrg(orgName: string, orgLifecycleRequest: OrgLifecycleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgPurgeResult>>;
     /**
      *
      * @summary Create or update Elasticsearch security role
@@ -7109,6 +7162,15 @@ export declare const SharedApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     restartInstance(orgName: string, clusterName: string, instanceName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Restore organization
+     * @param {string} orgName
+     * @param {OrgLifecycleRequest} orgLifecycleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    restoreOrg(orgName: string, orgLifecycleRequest: OrgLifecycleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Org>>;
     /**
      *
      * @summary Restore cluster from the Recycle Bin of the Org
@@ -8401,7 +8463,7 @@ export declare const SharedApiFactory: (configuration?: Configuration, basePath?
     exportParameterTemplateFromCluster(requestParameters: SharedApiExportParameterTemplateFromClusterRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      *
-     * @summary Expose cluster loadbalancer endpoint
+     * @summary Expose cluster endpoint
      * @param {SharedApiExposeClusterRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -9706,6 +9768,14 @@ export declare const SharedApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     previewAccountPrivilegeReset(requestParameters: SharedApiPreviewAccountPrivilegeResetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ObjectPrivilegeResetStep>>;
+    /**
+     *
+     * @summary Preview organization deletion or purge
+     * @param {SharedApiPreviewOrgDeletionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    previewOrgDeletion(requestParameters: SharedApiPreviewOrgDeletionRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgDeletionPreview>;
     /**
      *
      * @summary Produce message to topic
@@ -9722,6 +9792,14 @@ export declare const SharedApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     promoteCluster(requestParameters: SharedApiPromoteClusterRequest, options?: RawAxiosRequestConfig): AxiosPromise<OpsRequestName>;
+    /**
+     *
+     * @summary Purge organization
+     * @param {SharedApiPurgeOrgRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    purgeOrg(requestParameters: SharedApiPurgeOrgRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgPurgeResult>;
     /**
      *
      * @summary Create or update Elasticsearch security role
@@ -9961,6 +10039,14 @@ export declare const SharedApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     restartInstance(requestParameters: SharedApiRestartInstanceRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Restore organization
+     * @param {SharedApiRestoreOrgRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    restoreOrg(requestParameters: SharedApiRestoreOrgRequest, options?: RawAxiosRequestConfig): AxiosPromise<Org>;
     /**
      *
      * @summary Restore cluster from the Recycle Bin of the Org
@@ -11204,7 +11290,7 @@ export interface SharedApiInterface {
     exportParameterTemplateFromCluster(requestParameters: SharedApiExportParameterTemplateFromClusterRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      *
-     * @summary Expose cluster loadbalancer endpoint
+     * @summary Expose cluster endpoint
      * @param {SharedApiExposeClusterRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -12672,6 +12758,15 @@ export interface SharedApiInterface {
      * @memberof SharedApiInterface
      */
     previewAccountPrivilegeReset(requestParameters: SharedApiPreviewAccountPrivilegeResetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ObjectPrivilegeResetStep>>;
+    /**
+     *
+     * @summary Preview organization deletion or purge
+     * @param {SharedApiPreviewOrgDeletionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApiInterface
+     */
+    previewOrgDeletion(requestParameters: SharedApiPreviewOrgDeletionRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgDeletionPreview>;
     /**
      *
      * @summary Produce message to topic
@@ -12690,6 +12785,15 @@ export interface SharedApiInterface {
      * @memberof SharedApiInterface
      */
     promoteCluster(requestParameters: SharedApiPromoteClusterRequest, options?: RawAxiosRequestConfig): AxiosPromise<OpsRequestName>;
+    /**
+     *
+     * @summary Purge organization
+     * @param {SharedApiPurgeOrgRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApiInterface
+     */
+    purgeOrg(requestParameters: SharedApiPurgeOrgRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgPurgeResult>;
     /**
      *
      * @summary Create or update Elasticsearch security role
@@ -12959,6 +13063,15 @@ export interface SharedApiInterface {
      * @memberof SharedApiInterface
      */
     restartInstance(requestParameters: SharedApiRestartInstanceRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Restore organization
+     * @param {SharedApiRestoreOrgRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApiInterface
+     */
+    restoreOrg(requestParameters: SharedApiRestoreOrgRequest, options?: RawAxiosRequestConfig): AxiosPromise<Org>;
     /**
      *
      * @summary Restore cluster from the Recycle Bin of the Org
@@ -15213,6 +15326,12 @@ export interface SharedApiDeleteOrgRequest {
      * @memberof SharedApiDeleteOrg
      */
     readonly orgName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SharedApiDeleteOrg
+     */
+    readonly orgID: string;
 }
 /**
  * Request parameters for deleteOrgMember operation in SharedApi.
@@ -20551,6 +20670,31 @@ export interface SharedApiPreviewAccountPrivilegeResetRequest {
      */
     readonly allDatabases?: boolean;
 }
+/**
+ * Request parameters for previewOrgDeletion operation in SharedApi.
+ * @export
+ * @interface SharedApiPreviewOrgDeletionRequest
+ */
+export interface SharedApiPreviewOrgDeletionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof SharedApiPreviewOrgDeletion
+     */
+    readonly orgName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SharedApiPreviewOrgDeletion
+     */
+    readonly orgID: string;
+    /**
+     *
+     * @type {OrgDeletionAction}
+     * @memberof SharedApiPreviewOrgDeletion
+     */
+    readonly action: OrgDeletionAction;
+}
 /**
  * Request parameters for produceKafkaTopicMessage operation in SharedApi.
  * @export
@@ -20607,6 +20751,25 @@ export interface SharedApiPromoteClusterRequest {
      */
     readonly body: OpsPromote;
 }
+/**
+ * Request parameters for purgeOrg operation in SharedApi.
+ * @export
+ * @interface SharedApiPurgeOrgRequest
+ */
+export interface SharedApiPurgeOrgRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof SharedApiPurgeOrg
+     */
+    readonly orgName: string;
+    /**
+     *
+     * @type {OrgLifecycleRequest}
+     * @memberof SharedApiPurgeOrg
+     */
+    readonly orgLifecycleRequest: OrgLifecycleRequest;
+}
 /**
  * Request parameters for putElasticsearchSecurityRole operation in SharedApi.
  * @export
@@ -22234,6 +22397,25 @@ export interface SharedApiRestartInstanceRequest {
      */
     readonly instanceName: string;
 }
+/**
+ * Request parameters for restoreOrg operation in SharedApi.
+ * @export
+ * @interface SharedApiRestoreOrgRequest
+ */
+export interface SharedApiRestoreOrgRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof SharedApiRestoreOrg
+     */
+    readonly orgName: string;
+    /**
+     *
+     * @type {OrgLifecycleRequest}
+     * @memberof SharedApiRestoreOrg
+     */
+    readonly orgLifecycleRequest: OrgLifecycleRequest;
+}
 /**
  * Request parameters for restoreRecycleBinCluster operation in SharedApi.
  * @export
@@ -24574,7 +24756,7 @@ export declare class SharedApi extends BaseAPI implements SharedApiInterface {
     exportParameterTemplateFromCluster(requestParameters: SharedApiExportParameterTemplateFromClusterRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
      *
-     * @summary Expose cluster loadbalancer endpoint
+     * @summary Expose cluster endpoint
      * @param {SharedApiExposeClusterRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -26042,6 +26224,15 @@ export declare class SharedApi extends BaseAPI implements SharedApiInterface {
      * @memberof SharedApi
      */
     previewAccountPrivilegeReset(requestParameters: SharedApiPreviewAccountPrivilegeResetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectPrivilegeResetStep[], any, {}>>;
+    /**
+     *
+     * @summary Preview organization deletion or purge
+     * @param {SharedApiPreviewOrgDeletionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApi
+     */
+    previewOrgDeletion(requestParameters: SharedApiPreviewOrgDeletionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgDeletionPreview, any, {}>>;
     /**
      *
      * @summary Produce message to topic
@@ -26060,6 +26251,15 @@ export declare class SharedApi extends BaseAPI implements SharedApiInterface {
      * @memberof SharedApi
      */
     promoteCluster(requestParameters: SharedApiPromoteClusterRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OpsRequestName, any, {}>>;
+    /**
+     *
+     * @summary Purge organization
+     * @param {SharedApiPurgeOrgRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApi
+     */
+    purgeOrg(requestParameters: SharedApiPurgeOrgRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgPurgeResult, any, {}>>;
     /**
      *
      * @summary Create or update Elasticsearch security role
@@ -26329,6 +26529,15 @@ export declare class SharedApi extends BaseAPI implements SharedApiInterface {
      * @memberof SharedApi
      */
     restartInstance(requestParameters: SharedApiRestartInstanceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary Restore organization
+     * @param {SharedApiRestoreOrgRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApi
+     */
+    restoreOrg(requestParameters: SharedApiRestoreOrgRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Org, any, {}>>;
     /**
      *
      * @summary Restore cluster from the Recycle Bin of the Org