@camunda/ccma-api 5.18.0 → 5.20.0

package/dist/services/console/console.admin.service.d.ts

@@ -1,4 +1,4 @@
-import type { AlertSubscriptionDto, BackupDto, BackupScheduleDto, ByomClientDto, ByomStatus, ClusterBulkOperationAck, ClusterBulkOperationDto, ClusterBulkOperationPostContent, ClusterModificationConfigDto, ClusterModificationDto, ClusterPlanTypeDto, ClusterTtlDto, ClusterUsageMetadataDto, ClusterUsageMetricsData, ConsoleClusterDto, UniqueTaskUser, UpdateClusterTtlBody, ValueMetrics } from '@camunda/ccma-shared-types';
+import type { AlertSubscriptionDto, BackupDto, BackupScheduleDto, ByomClientDto, ByomStatus, ClusterBulkOperationAck, ClusterBulkOperationDto, ClusterBulkOperationPostContent, ClusterModificationConfigDto, ClusterModificationDto, ClusterPlanTypeDto, ClusterTtlDto, ClusterUsageMetadataDto, ClusterUsageMetricsData, ConsoleClusterDto, UniqueTaskUser, UpdateClusterTtlBody, ValueMetrics, ZeebeRebalancingSetting } from '@camunda/ccma-shared-types';
 import type { RequestBaseParams } from '../../types/general.types.js';
 import type { OpenIncident } from '../incident-io/incident-io.service.js';
 import type { ConsoleClusterClientDto } from './console.cluster-clients.service.js';
@@ -331,6 +331,12 @@ export interface AdminClusterNonSpotNodesRequest extends RequestBaseParams {
         nonSpotNodesEnabled: boolean;
     };
 }
+export interface AdminClusterZeebeRebalancingRequest extends RequestBaseParams {
+    params: {
+        clusterId: string;
+    };
+    body: ZeebeRebalancingSetting;
+}
 /** What `GET api/admin/clusters/modifications` answers. */
 export interface ModificationsAnswer {
     clusters: ConsoleClusterDto[];
@@ -368,6 +374,13 @@ export declare class ConsoleAdminService {
      * `availabilityClass` of the spec.
      */
     static updateClusterNonSpotNodes(params: AdminClusterNonSpotNodesRequest): Promise<void>;
+    /**
+     * Set scheduled Zeebe leader rebalancing for a cluster. The body replaces the
+     * stored setting, and `enabled: false` keeps the schedule. The route answers
+     * 404 while the flag `console.zeebeRebalancing` is off, and 400 with field
+     * messages for a setting that `validateZeebeRebalancing` refuses.
+     */
+    static updateZeebeRebalancing(params: AdminClusterZeebeRebalancingRequest): Promise<ZeebeRebalancingSetting>;
     static signalSignup(params: SignalSignupRequest): Promise<void>;
     static unlinkClusterFromModification(params: {
         uuid: string;
@@ -423,10 +436,15 @@ export declare class ConsoleAdminService {
     static getApiClients(params: {
         orgId: string;
     } & RequestBaseParams): Promise<any[] | undefined>;
+    /**
+     * deleteApiClient deletes an API client of any org. The route needs the
+     * `apiClient.delete` console permission and no org membership. `clientUuid`
+     * is the `uuid` of the client, not its OAuth `clientId`.
+     */
     static deleteApiClient(params: {
         orgId: string;
-        clientId: string;
-    } & RequestBaseParams): Promise<void | undefined>;
+        clientUuid: string;
+    } & RequestBaseParams): Promise<void>;
     static wakeCluster(params: {
         clusterId: string;
     } & RequestBaseParams): Promise<void | undefined>;

package/dist/services/console/console.admin.service.js

@@ -235,6 +235,41 @@ class ConsoleAdminService {
       );
     }
   }
+  /**
+   * Set scheduled Zeebe leader rebalancing for a cluster. The body replaces the
+   * stored setting, and `enabled: false` keeps the schedule. The route answers
+   * 404 while the flag `console.zeebeRebalancing` is off, and 400 with field
+   * messages for a setting that `validateZeebeRebalancing` refuses.
+   */
+  static async updateZeebeRebalancing(params) {
+    const serviceContext = {
+      method: {
+        name: "ConsoleAdminService.updateZeebeRebalancing",
+        url: `api/admin/clusters/${params.params.clusterId}/zeebe-rebalancing`,
+        normalizedUrl: "api/admin/clusters/:clusterId/zeebe-rebalancing",
+        type: "patch"
+      },
+      source: params.config.metrics?.source || "unset",
+      target: { name: "console", type: "internal" }
+    };
+    const response = await request({
+      config: params.config,
+      base: { id: "console" },
+      url: serviceContext.method.url,
+      method: serviceContext.method.type,
+      metricsDetails: serviceContext,
+      responseType: "json",
+      body: params.body
+    });
+    if (!response.ok || !response.body) {
+      throw new HttpError(
+        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,
+        response.status,
+        response.statusText
+      );
+    }
+    return response.body;
+  }
   static async signalSignup(params) {
     const serviceContext = {
       method: {
@@ -989,12 +1024,17 @@ class ConsoleAdminService {
     }
     return response.body;
   }
+  /**
+   * deleteApiClient deletes an API client of any org. The route needs the
+   * `apiClient.delete` console permission and no org membership. `clientUuid`
+   * is the `uuid` of the client, not its OAuth `clientId`.
+   */
   static async deleteApiClient(params) {
     const serviceContext = {
       method: {
-        name: `ConsoleAdminService.getBulkClusterPlanUpdate`,
-        url: `api/admin/apiClients/${params.orgId}/clientId/${params.clientId}`,
-        normalizedUrl: `api/apiClients/:orgId/clientId/:clientId`,
+        name: `ConsoleAdminService.deleteApiClient`,
+        url: `api/admin/apiClients/${params.orgId}/client/${params.clientUuid}`,
+        normalizedUrl: `api/admin/apiClients/:orgId/client/:clientUuid`,
         type: "delete"
       },
       source: params.config.metrics?.source || "unset",
@@ -1005,7 +1045,7 @@ class ConsoleAdminService {
       base: {
         id: "console"
       },
-      responseType: "json",
+      responseType: "none",
       url: serviceContext.method.url,
       method: serviceContext.method.type,
       metricsDetails: serviceContext
@@ -1017,7 +1057,6 @@ class ConsoleAdminService {
         response.statusText
       );
     }
-    return response.body;
   }
   static async wakeCluster(params) {
     const serviceContext = {