@camunda/ccma-api 5.3.0 → 5.4.1

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, 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 } 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';
@@ -219,6 +219,18 @@ export interface GetValueMetricsUsageDataRequest extends RequestBaseParams {
         };
     };
 }
+export interface GetValueMetricsUsageDataPerDayRequest extends RequestBaseParams {
+    params: {
+        orgId: string;
+        /** How many days back from now the read covers. */
+        days: number;
+    };
+}
+export interface GetValueMetricsMetadataRequest extends RequestBaseParams {
+    params: {
+        orgId: string;
+    };
+}
 export interface GetValueMetricsRequest extends RequestBaseParams {
     params: {
         orgId: string;
@@ -373,6 +385,22 @@ export declare class ConsoleAdminService {
     static getClusterPlanType(params: GetClusterPlanTypeRequest): Promise<ClusterPlanTypeDto>;
     static getAllClusterPlanTypes(params: GetAllClusterPlanTypesRequest): Promise<ClusterPlanTypeDto[]>;
     static getValueMetricsUsageData(params: GetValueMetricsUsageDataRequest): Promise<ClusterUsageMetricsData[]>;
+    /**
+     * The value metrics that console counted itself, one row for each cluster
+     * and day of the last `days` days
+     * (`GET api/orgs/:orgId/clusters/usage/value-metrics/:days`).
+     *
+     * This is the source that HDP replaced for a 2025 organization. The
+     * comparison of the two sources reads it on purpose, so it never reads HDP
+     * under this name: a comparison of a series with itself shows nothing.
+     */
+    static getValueMetricsUsageDataPerDay(params: GetValueMetricsUsageDataPerDayRequest): Promise<ClusterUsageMetricsData[]>;
+    /**
+     * The usage metadata of an organization: the unique task users and the
+     * deployed models for each billing period
+     * (`GET api/orgs/:orgId/clusters/usage/value-metrics-metadata`).
+     */
+    static getValueMetricsMetadata(params: GetValueMetricsMetadataRequest): Promise<ClusterUsageMetadataDto[]>;
     static getValueMetrics(params: GetValueMetricsRequest): Promise<ValueMetrics | undefined>;
     static getValueMetricsForAll(params: GetValueMetricsForAllRequest): Promise<ValueMetrics[]>;
     static getTaskUsers(params: GetTaskUsersRequest): Promise<UniqueTaskUser[]>;

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

@@ -645,6 +645,84 @@ class ConsoleAdminService {
     }
     return response.body;
   }
+  /**
+   * The value metrics that console counted itself, one row for each cluster
+   * and day of the last `days` days
+   * (`GET api/orgs/:orgId/clusters/usage/value-metrics/:days`).
+   *
+   * This is the source that HDP replaced for a 2025 organization. The
+   * comparison of the two sources reads it on purpose, so it never reads HDP
+   * under this name: a comparison of a series with itself shows nothing.
+   */
+  static async getValueMetricsUsageDataPerDay(params) {
+    const serviceContext = {
+      method: {
+        name: `ConsoleAdminService.getValueMetricsUsageDataPerDay`,
+        url: `api/orgs/${params.params.orgId}/clusters/usage/value-metrics/${params.params.days}`,
+        normalizedUrl: `api/orgs/:orgId/clusters/usage/value-metrics/:days`,
+        type: "get"
+      },
+      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
+    });
+    if (!response.ok) {
+      throw new HttpError(
+        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,
+        response.status,
+        response.statusText
+      );
+    }
+    return response.body ?? [];
+  }
+  /**
+   * The usage metadata of an organization: the unique task users and the
+   * deployed models for each billing period
+   * (`GET api/orgs/:orgId/clusters/usage/value-metrics-metadata`).
+   */
+  static async getValueMetricsMetadata(params) {
+    const serviceContext = {
+      method: {
+        name: `ConsoleAdminService.getValueMetricsMetadata`,
+        url: `api/orgs/${params.params.orgId}/clusters/usage/value-metrics-metadata`,
+        normalizedUrl: `api/orgs/:orgId/clusters/usage/value-metrics-metadata`,
+        type: "get"
+      },
+      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
+    });
+    if (!response.ok) {
+      throw new HttpError(
+        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,
+        response.status,
+        response.statusText
+      );
+    }
+    return response.body?.metadata ?? [];
+  }
   static async getValueMetrics(params) {
     const serviceContext = {
       method: {