kb-cloud-client-typescript 2.3.0-beta.0 → 2.3.0-beta.10

package/src/internalapi/.openapi-generator/FILES

@@ -78,3 +78,4 @@ models/service-ref.ts
 models/static-cluster.ts
 models/storage-create.ts
 models/storage.ts
+models/tag.ts

package/src/internalapi/apis/cluster-api.ts

@@ -342,10 +342,12 @@ export const ClusterApiAxiosParamCreator = function (configuration?: Configurati
          * @param {Array<string>} [tagKeys] A list of tags\&#39; keys
          * @param {Array<string>} [tagValues] A list of tags\&#39; values corresponding to the tagKeys
          * @param {number} [licenseId] license id
+         * @param {string} [endpointHost] Case-insensitive substring to match against the host part of cached cluster endpoints
+         * @param {boolean} [includeEndpoints] Whether to include cached user-visible endpoints in each cluster item
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listCluster: async (orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listCluster: async (orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, endpointHost?: string, includeEndpoints?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'orgName' is not null or undefined
             assertParamExists('listCluster', 'orgName', orgName)
             const localVarPath = `/internal/v1/organizations/{orgName}/clusters`
@@ -397,6 +399,14 @@ export const ClusterApiAxiosParamCreator = function (configuration?: Configurati
                 localVarQueryParameter['licenseId'] = licenseId;
             }
 
+            if (endpointHost !== undefined) {
+                localVarQueryParameter['endpointHost'] = endpointHost;
+            }
+
+            if (includeEndpoints !== undefined) {
+                localVarQueryParameter['includeEndpoints'] = includeEndpoints;
+            }
+
 
     
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -621,11 +631,13 @@ export const ClusterApiFp = function(configuration?: Configuration) {
          * @param {Array<string>} [tagKeys] A list of tags\&#39; keys
          * @param {Array<string>} [tagValues] A list of tags\&#39; values corresponding to the tagKeys
          * @param {number} [licenseId] license id
+         * @param {string} [endpointHost] Case-insensitive substring to match against the host part of cached cluster endpoints
+         * @param {boolean} [includeEndpoints] Whether to include cached user-visible endpoints in each cluster item
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listCluster(orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterList>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listCluster(orgName, clusterDefinition, environmentName, environmentType, tagKey, tagValue, tagKeys, tagValues, licenseId, options);
+        async listCluster(orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, endpointHost?: string, includeEndpoints?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterList>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listCluster(orgName, clusterDefinition, environmentName, environmentType, tagKey, tagValue, tagKeys, tagValues, licenseId, endpointHost, includeEndpoints, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['ClusterApi.listCluster']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -748,7 +760,7 @@ export const ClusterApiFactory = function (configuration?: Configuration, basePa
          * @throws {RequiredError}
          */
         listCluster(requestParameters: ClusterApiListClusterRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClusterList> {
-            return localVarFp.listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, options).then((request) => request(axios, basePath));
+            return localVarFp.listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.endpointHost, requestParameters.includeEndpoints, options).then((request) => request(axios, basePath));
         },
         /**
          * 
@@ -1082,6 +1094,20 @@ export interface ClusterApiListClusterRequest {
      * @memberof ClusterApiListCluster
      */
     readonly licenseId?: number
+
+    /**
+     * Case-insensitive substring to match against the host part of cached cluster endpoints
+     * @type {string}
+     * @memberof ClusterApiListCluster
+     */
+    readonly endpointHost?: string
+
+    /**
+     * Whether to include cached user-visible endpoints in each cluster item
+     * @type {boolean}
+     * @memberof ClusterApiListCluster
+     */
+    readonly includeEndpoints?: boolean
 }
 
 /**
@@ -1240,7 +1266,7 @@ export class ClusterApi extends BaseAPI implements ClusterApiInterface {
      * @memberof ClusterApi
      */
     public listCluster(requestParameters: ClusterApiListClusterRequest, options?: RawAxiosRequestConfig) {
-        return ClusterApiFp(this.configuration).listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, options).then((request) => request(this.axios, this.basePath));
+        return ClusterApiFp(this.configuration).listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.endpointHost, requestParameters.includeEndpoints, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/src/internalapi/models/cluster-list-item.ts

@@ -16,6 +16,12 @@
 // May contain unused imports in some cases
 // @ts-ignore
 import type { ClusterType } from './cluster-type';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Endpoint } from './endpoint';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Tag } from './tag';
 
 /**
  * KubeBlocks cluster information
@@ -179,6 +185,24 @@ export interface ClusterListItem {
      * @memberof ClusterListItem
      */
     'orgName'?: string;
+    /**
+     * Name of project, it is the alias of environment namespace
+     * @type {string}
+     * @memberof ClusterListItem
+     */
+    'project'?: string;
+    /**
+     * Tags bound to the cluster
+     * @type {Array<Tag>}
+     * @memberof ClusterListItem
+     */
+    'tags'?: Array<Tag>;
+    /**
+     * Cached user-visible endpoints of the cluster; omitted unless includeEndpoints is true
+     * @type {Array<Endpoint>}
+     * @memberof ClusterListItem
+     */
+    'endpoints'?: Array<Endpoint>;
 }
 
 

package/src/internalapi/models/index.ts

@@ -53,3 +53,4 @@ export * from './service-ref';
 export * from './static-cluster';
 export * from './storage';
 export * from './storage-create';
+export * from './tag';

package/src/internalapi/models/tag.ts

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud Internal API
+ * The Internal API is using for interaction of ApeCloud platform microservices. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * tag info
+ * @export
+ * @interface Tag
+ */
+export interface Tag {
+    /**
+     * The id of the tag
+     * @type {string}
+     * @memberof Tag
+     */
+    'id': string;
+    /**
+     * the key of the tag
+     * @type {string}
+     * @memberof Tag
+     */
+    'key'?: string;
+    /**
+     * The value corresponding to the key
+     * @type {string}
+     * @memberof Tag
+     */
+    'value'?: string;
+}
+

package/src/internalapi.yaml

@@ -486,6 +486,17 @@ paths:
           description: license id
           schema:
             type: integer
+        - name: endpointHost
+          in: query
+          description: Case-insensitive substring to match against the host part of cached cluster endpoints
+          schema:
+            type: string
+        - name: includeEndpoints
+          in: query
+          description: Whether to include cached user-visible endpoints in each cluster item
+          schema:
+            type: boolean
+            default: false
       responses:
         '200':
           description: A successful response.
@@ -1789,6 +1800,88 @@ components:
         - public
         - private
       default: public
+    tag:
+      description: tag info
+      properties:
+        id:
+          description: The id of the tag
+          format: int64
+          type: string
+        key:
+          description: the key of the tag
+          type: string
+        value:
+          description: The value corresponding to the key
+          type: string
+      required:
+        - id
+      type: object
+    endpointType:
+      description: Type of endpoint
+      type: string
+      enum:
+        - ClusterIP
+        - NodePort
+        - LoadBalancer
+        - PodIP
+        - HostNetwork
+        - PodFQDN
+    endpointNetworkType:
+      description: Network type of endpoint
+      type: string
+      enum:
+        - Internet
+        - Intranet
+    endpoint:
+      description: Endpoint is the information of cluster endpoints
+      properties:
+        title:
+          description: title of the endpoint
+          type: string
+        component:
+          description: Component type name
+          type: string
+        hosts:
+          description: Endpoint hosts
+          type: array
+          items:
+            type: string
+        port:
+          description: Endpoint port
+          type: integer
+          format: int32
+        type:
+          $ref: '#/components/schemas/endpointType'
+        networkType:
+          $ref: '#/components/schemas/endpointNetworkType'
+        serviceName:
+          description: Service name of endpoint
+          type: string
+        podService:
+          description: Pod service name of endpoint
+          type: boolean
+        portName:
+          description: Port name of endpoint
+          type: string
+        instances:
+          description: Endpoint backend instances
+          type: array
+          items:
+            type: string
+        mutable:
+          description: Whether the endpoint is mutable
+          type: boolean
+      required:
+        - title
+        - component
+        - hosts
+        - port
+        - type
+        - networkType
+        - serviceName
+        - portName
+        - mutable
+      type: object
     clusterListItem:
       description: KubeBlocks cluster information
       properties:
@@ -1895,6 +1988,20 @@ components:
         orgName:
           description: Org Name
           type: string
+        project:
+          description: Name of project, it is the alias of environment namespace
+          type: string
+        tags:
+          description: Tags bound to the cluster
+          items:
+            $ref: '#/components/schemas/tag'
+          type: array
+        endpoints:
+          description: Cached user-visible endpoints of the cluster; omitted unless includeEndpoints is true
+          items:
+            $ref: '#/components/schemas/endpoint'
+          type: array
+          x-omitempty: true
       required:
         - cloudProvider
         - createdAt
@@ -1960,72 +2067,6 @@ components:
           items:
             $ref: '#/components/schemas/serviceRef'
       description: ClusterUpdate is the payload to update a KubeBlocks cluster
-    endpointType:
-      description: Type of endpoint
-      type: string
-      enum:
-        - ClusterIP
-        - NodePort
-        - LoadBalancer
-        - PodIP
-        - HostNetwork
-        - PodFQDN
-    endpointNetworkType:
-      description: Network type of endpoint
-      type: string
-      enum:
-        - Internet
-        - Intranet
-    endpoint:
-      description: Endpoint is the information of cluster endpoints
-      properties:
-        title:
-          description: title of the endpoint
-          type: string
-        component:
-          description: Component type name
-          type: string
-        hosts:
-          description: Endpoint hosts
-          type: array
-          items:
-            type: string
-        port:
-          description: Endpoint port
-          type: integer
-          format: int32
-        type:
-          $ref: '#/components/schemas/endpointType'
-        networkType:
-          $ref: '#/components/schemas/endpointNetworkType'
-        serviceName:
-          description: Service name of endpoint
-          type: string
-        podService:
-          description: Pod service name of endpoint
-          type: boolean
-        portName:
-          description: Port name of endpoint
-          type: string
-        instances:
-          description: Endpoint backend instances
-          type: array
-          items:
-            type: string
-        mutable:
-          description: Whether the endpoint is mutable
-          type: boolean
-      required:
-        - title
-        - component
-        - hosts
-        - port
-        - type
-        - networkType
-        - serviceName
-        - portName
-        - mutable
-      type: object
     endpointList:
       required:
         - items

package/src/openapi/.openapi-generator/FILES

@@ -20,6 +20,7 @@ apis/billing-api.ts
 apis/blue-green-deployment-api.ts
 apis/class-api.ts
 apis/class-types-api.ts
+apis/clickhouse-api.ts
 apis/cluster-alert-switch-api.ts
 apis/cluster-api.ts
 apis/cluster-log-api.ts
@@ -229,6 +230,8 @@ models/cdc-worker-template.ts
 models/certificate-issuer.ts
 models/certificate.ts
 models/channel-status.ts
+models/ck-account-type.ts
+models/ck-account.ts
 models/class-type.ts
 models/class.ts
 models/cluster-alert-summary.ts
@@ -299,6 +302,7 @@ models/console.ts
 models/consumer-group-describe.ts
 models/consumer-group.ts
 models/cpu.ts
+models/create-clickhouse-account-request.ts
 models/create-ipwhitelist-request.ts
 models/create-pg-extension-resp.ts
 models/create-topic-request.ts
@@ -512,6 +516,7 @@ models/feature-pre-release-type.ts
 models/feature.ts
 models/file-entry-list.ts
 models/file-entry.ts
+models/get-clickhouse-role-grants200-response-inner.ts
 models/global-pricing.ts
 models/ha-history-list.ts
 models/ha-history.ts
@@ -587,6 +592,8 @@ models/koordinator-reservation-summary.ts
 models/kubeblocks-endpoint.ts
 models/license-option.ts
 models/license.ts
+models/list-clickhouse-account-roles200-response-privileges-inner.ts
+models/list-clickhouse-account-roles200-response.ts
 models/load-balancer-available-type.ts
 models/load-balancer-ipam-status.ts
 models/load-balancer-status.ts
@@ -842,6 +849,7 @@ models/redis-workbench-execute-request.ts
 models/redis-workbench-execute-response.ts
 models/ref.ts
 models/related-cluster-list-item.ts
+models/replication-check-option.ts
 models/replication-metadata-object.ts
 models/replication-object-node.ts
 models/replication-object-query.ts
@@ -859,6 +867,8 @@ models/restore-status-actions-inner.ts
 models/restore-status-conditions-inner.ts
 models/restore-status.ts
 models/restore.ts
+models/revoke-clickhouse-role-privileges-request-privileges-inner.ts
+models/revoke-clickhouse-role-privileges-request.ts
 models/role-create.ts
 models/role-list.ts
 models/role-update.ts
@@ -929,6 +939,8 @@ models/topic.ts
 models/tpcc.ts
 models/update-authenticated-user-password-request.ts
 models/update-broker-config-request.ts
+models/update-clickhouse-account-password-request.ts
+models/update-clickhouse-account-roles-request.ts
 models/update-topic-config-request.ts
 models/urlcheck.ts
 models/user-org-list.ts

package/src/openapi/api.ts

@@ -32,6 +32,7 @@ export * from './apis/billing-api';
 export * from './apis/blue-green-deployment-api';
 export * from './apis/class-api';
 export * from './apis/class-types-api';
+export * from './apis/clickhouse-api';
 export * from './apis/cluster-api';
 export * from './apis/cluster-alert-switch-api';
 export * from './apis/cluster-log-api';