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

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

@@ -39,6 +39,47 @@ import type { TaskTypeList } from '../models';
  */
 export const TaskApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * Forcefully abort a running task. Pending steps or OpsRequests are cancelled, running ones are aborted.
+         * @summary Force abort a task
+         * @param {string} taskId ID of the task
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        abortTask: async (taskId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'taskId' is not null or undefined
+            assertParamExists('abortTask', 'taskId', taskId)
+            const localVarPath = `/admin/v1/tasks/{taskId}/abort`
+                .replace(`{${"taskId"}}`, encodeURIComponent(String(taskId)));
+            // 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: 'POST', ...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,
+            };
+        },
         /**
          * Cancel a task by taskID.
          * @summary Cancel a task
@@ -473,6 +514,19 @@ export const TaskApiAxiosParamCreator = function (configuration?: Configuration)
 export const TaskApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = TaskApiAxiosParamCreator(configuration)
     return {
+        /**
+         * Forcefully abort a running task. Pending steps or OpsRequests are cancelled, running ones are aborted.
+         * @summary Force abort a task
+         * @param {string} taskId ID of the task
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async abortTask(taskId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.abortTask(taskId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['TaskApi.abortTask']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Cancel a task by taskID.
          * @summary Cancel a task
@@ -610,6 +664,16 @@ export const TaskApiFp = function(configuration?: Configuration) {
 export const TaskApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = TaskApiFp(configuration)
     return {
+        /**
+         * Forcefully abort a running task. Pending steps or OpsRequests are cancelled, running ones are aborted.
+         * @summary Force abort a task
+         * @param {TaskApiAbortTaskRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        abortTask(requestParameters: TaskApiAbortTaskRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.abortTask(requestParameters.taskId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Cancel a task by taskID.
          * @summary Cancel a task
@@ -708,6 +772,16 @@ export const TaskApiFactory = function (configuration?: Configuration, basePath?
  * @interface TaskApi
  */
 export interface TaskApiInterface {
+    /**
+     * Forcefully abort a running task. Pending steps or OpsRequests are cancelled, running ones are aborted.
+     * @summary Force abort a task
+     * @param {TaskApiAbortTaskRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TaskApiInterface
+     */
+    abortTask(requestParameters: TaskApiAbortTaskRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+
     /**
      * Cancel a task by taskID.
      * @summary Cancel a task
@@ -799,6 +873,20 @@ export interface TaskApiInterface {
 
 }
 
+/**
+ * Request parameters for abortTask operation in TaskApi.
+ * @export
+ * @interface TaskApiAbortTaskRequest
+ */
+export interface TaskApiAbortTaskRequest {
+    /**
+     * ID of the task
+     * @type {string}
+     * @memberof TaskApiAbortTask
+     */
+    readonly taskId: string
+}
+
 /**
  * Request parameters for cancelTask operation in TaskApi.
  * @export
@@ -995,6 +1083,18 @@ export interface TaskApiStopTaskRequest {
  * @extends {BaseAPI}
  */
 export class TaskApi extends BaseAPI implements TaskApiInterface {
+    /**
+     * Forcefully abort a running task. Pending steps or OpsRequests are cancelled, running ones are aborted.
+     * @summary Force abort a task
+     * @param {TaskApiAbortTaskRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TaskApi
+     */
+    public abortTask(requestParameters: TaskApiAbortTaskRequest, options?: RawAxiosRequestConfig) {
+        return TaskApiFp(this.configuration).abortTask(requestParameters.taskId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Cancel a task by taskID.
      * @summary Cancel a task

package/src/adminapi/models/alert-cluster-silence.ts

@@ -30,7 +30,7 @@ export interface AlertClusterSilence {
      */
     'enabled': boolean;
     /**
-     * Alert names to silence. Empty or omitted means all cluster alerts.
+     * Alert names to silence. Empty or omitted means all alerts for the resource.
      * @type {Array<string>}
      * @memberof AlertClusterSilence
      */

package/src/adminapi/models/alert-cluster.ts

@@ -18,19 +18,19 @@
 import type { AlertClusterSilence } from './alert-cluster-silence';
 
 /**
- * Cluster-scoped alert settings. PATCH updates only supplied fields; settings apply to both tenant and administrator notifications.
+ * Resource-scoped alert settings, shared by cluster and node endpoints. PATCH updates only supplied fields. Cluster settings apply to both tenant and administrator notifications.
  * @export
  * @interface AlertCluster
  */
 export interface AlertCluster {
     /**
-     * Disable all cluster alerts. Existing rule and silence settings are preserved.
+     * Disable all alerts for the resource. Existing rule and silence settings are preserved.
      * @type {boolean}
      * @memberof AlertCluster
      */
     'disabled'?: boolean | null;
     /**
-     * Alert names disabled only for this cluster. An empty array clears all rule overrides; omission preserves them.
+     * Alert names disabled only for this resource. An empty array clears all rule overrides; omission preserves them.
      * @type {Array<string>}
      * @memberof AlertCluster
      */

package/src/adminapi/models/component-item-create.ts

@@ -29,6 +29,12 @@ import type { InstanceTemplateCreate } from './instance-template-create';
  * @interface ComponentItemCreate
  */
 export interface ComponentItemCreate {
+    /**
+     * User-provided component annotations, merged over chart defaults. Platform-managed keys cannot be overridden. Omitted or empty preserves defaults; empty string values are literal values, not deletions.
+     * @type {{ [key: string]: string; }}
+     * @memberof ComponentItemCreate
+     */
+    'annotations'?: { [key: string]: string; };
     /**
      * Optional host group in this environment and the explicitly selected availabilityZone. Requires availabilityZone; no upper-level host group is inherited.
      * @type {string}

package/src/adminapi/models/component-item.ts

@@ -29,6 +29,12 @@ import type { InstanceTemplateCreate } from './instance-template-create';
  * @interface ComponentItem
  */
 export interface ComponentItem {
+    /**
+     * User-provided component annotations. Does not include chart defaults or system-generated values.
+     * @type {{ [key: string]: string; }}
+     * @memberof ComponentItem
+     */
+    'annotations'?: { [key: string]: string; };
     /**
      * Optional host group in this environment. Explicit placement does not inherit an upper-level host group.
      * @type {string}

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

@@ -80,6 +80,12 @@ export interface ComponentOption {
      * @memberof ComponentOption
      */
     'main'?: boolean;
+    /**
+     * Whether to show the component annotations editor during cluster creation. Omitted or false hides the editor. This is a UI visibility hint and does not restrict the cluster creation API. Applies to this component in every engine mode, including sharding templates, on KubeBlocks 0.9 and 1.0.
+     * @type {boolean}
+     * @memberof ComponentOption
+     */
+    'customAnnotations'?: boolean;
     /**
      * whether the component supports custom secret
      * @type {boolean}

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

@@ -19,6 +19,9 @@ import type { EngineOptionLicenseFile } from './engine-option-license-file';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { LicenseOption } from './license-option';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { NetworkMode } from './network-mode';
 
 /**
  * 
@@ -50,6 +53,18 @@ export interface EngineOptionLicense {
      * @memberof EngineOptionLicense
      */
     'allowedTypes'?: Array<string>;
+    /**
+     * Engine versions that support license installation. Entries match an exact service version or its major version according to the main component version rule. Omit or leave empty for unrestricted versions.
+     * @type {Array<string>}
+     * @memberof EngineOptionLicense
+     */
+    'versions'?: Array<string>;
+    /**
+     * Effective cluster network modes that support license installation. Omit or leave empty for unrestricted network modes.
+     * @type {Array<NetworkMode>}
+     * @memberof EngineOptionLicense
+     */
+    'networkModes'?: Array<NetworkMode>;
     /**
      * 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/adminapi/models/index.ts

@@ -814,15 +814,24 @@ export * from './oracle-tablespace-expand-action';
 export * from './oracle-tablespace-file';
 export * from './oracle-tablespace-file-spec';
 export * from './org';
+export * from './org-configuration-item';
+export * from './org-configuration-summary';
 export * from './org-create';
+export * from './org-deletion-action';
+export * from './org-deletion-blocker';
+export * from './org-deletion-preview';
+export * from './org-lifecycle-request';
 export * from './org-member';
 export * from './org-member-add';
 export * from './org-member-list';
 export * from './org-member-update';
 export * from './org-parameter';
 export * from './org-parameter-constraints';
+export * from './org-purge-result';
 export * from './org-resource-quota';
 export * from './org-resource-quota-and-usage';
+export * from './org-retained-resource';
+export * from './org-status';
 export * from './org-tags-list';
 export * from './org-update';
 export * from './organization-item';

package/src/adminapi/models/ops-expose-type.ts

@@ -15,14 +15,15 @@
 
 
 /**
- * Specifies the type of exposure for the KubeBlocks cluster.
+ * Specifies the type of exposure for the KubeBlocks cluster. Internal exposure creates an internal-ro ClusterIP service and requires readonly=true; it is independent of vpc and internet exposure.
  * @export
  * @enum {string}
  */
 
 export const OpsExposeType = {
     vpc: 'vpc',
-    internet: 'internet'
+    internet: 'internet',
+    internal: 'internal'
 } as const;
 
 export type OpsExposeType = typeof OpsExposeType[keyof typeof OpsExposeType];

package/src/adminapi/models/ops-expose.ts

@@ -42,7 +42,7 @@ export interface OpsExpose {
      */
     'enable': boolean;
     /**
-     * 
+     * Select the configured read-only role. Must be true for internal exposure.
      * @type {boolean}
      * @memberof OpsExpose
      */

package/src/adminapi/models/org-configuration-item.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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
+ * @interface OrgConfigurationItem
+ */
+export interface OrgConfigurationItem {
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgConfigurationItem
+     */
+    'id': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgConfigurationItem
+     */
+    'displayName': string;
+}
+

package/src/adminapi/models/org-configuration-summary.ts

@@ -0,0 +1,63 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OrgConfigurationItem } from './org-configuration-item';
+
+/**
+ * 
+ * @export
+ * @interface OrgConfigurationSummary
+ */
+export interface OrgConfigurationSummary {
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgConfigurationSummary
+     */
+    'type': string;
+    /**
+     * 
+     * @type {number}
+     * @memberof OrgConfigurationSummary
+     */
+    'count': number;
+    /**
+     * 
+     * @type {Array<OrgConfigurationItem>}
+     * @memberof OrgConfigurationSummary
+     */
+    'items': Array<OrgConfigurationItem>;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof OrgConfigurationSummary
+     */
+    'truncated': boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgConfigurationSummary
+     */
+    'actionEffect': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgConfigurationSummary
+     */
+    'purgeEffect': string;
+}
+

package/src/adminapi/models/org-deletion-action.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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 OrgDeletionAction = {
+    delete: 'delete',
+    purge: 'purge'
+} as const;
+
+export type OrgDeletionAction = typeof OrgDeletionAction[keyof typeof OrgDeletionAction];
+
+
+

package/src/adminapi/models/org-deletion-blocker.ts

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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
+ * @interface OrgDeletionBlocker
+ */
+export interface OrgDeletionBlocker {
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgDeletionBlocker
+     */
+    'code': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgDeletionBlocker
+     */
+    'resourceType': string;
+    /**
+     * 
+     * @type {number}
+     * @memberof OrgDeletionBlocker
+     */
+    'count': number;
+}
+

package/src/adminapi/models/org-deletion-preview.ts

@@ -0,0 +1,93 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OrgConfigurationSummary } from './org-configuration-summary';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OrgDeletionBlocker } from './org-deletion-blocker';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OrgRetainedResource } from './org-retained-resource';
+
+/**
+ * 
+ * @export
+ * @interface OrgDeletionPreview
+ */
+export interface OrgDeletionPreview {
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgDeletionPreview
+     */
+    'orgID': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgDeletionPreview
+     */
+    'name': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgDeletionPreview
+     */
+    'status': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgDeletionPreview
+     */
+    'expiredAt': string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgDeletionPreview
+     */
+    'purgeError'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgDeletionPreview
+     */
+    'action': string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof OrgDeletionPreview
+     */
+    'canProceed': boolean;
+    /**
+     * 
+     * @type {Array<OrgDeletionBlocker>}
+     * @memberof OrgDeletionPreview
+     */
+    'blockers': Array<OrgDeletionBlocker>;
+    /**
+     * 
+     * @type {Array<OrgConfigurationSummary>}
+     * @memberof OrgDeletionPreview
+     */
+    'configurations': Array<OrgConfigurationSummary>;
+    /**
+     * 
+     * @type {Array<OrgRetainedResource>}
+     * @memberof OrgDeletionPreview
+     */
+    'retainedResources': Array<OrgRetainedResource>;
+}
+

package/src/adminapi/models/org-lifecycle-request.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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
+ * @interface OrgLifecycleRequest
+ */
+export interface OrgLifecycleRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgLifecycleRequest
+     */
+    'orgID': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgLifecycleRequest
+     */
+    'expectedExpiredAt': string;
+}
+

package/src/adminapi/models/org-purge-result.ts

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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
+ * @interface OrgPurgeResult
+ */
+export interface OrgPurgeResult {
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgPurgeResult
+     */
+    'orgID'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgPurgeResult
+     */
+    'status'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrgPurgeResult
+     */
+    'expiredAt'?: string;
+}
+