@breign/client 1.0.111 → 1.0.113

package/dist/apis/AgentApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AdvancedFlowEditorUio, AdvancedFlowEditorUpdateRequestUio, AgentDuplicateRequestUio, AgentFlowCreateUio, AgentFlowUio, AgentMetricsEventUio, AgentMetricsOverviewUio, AgentModuleUio, AgentPatchUio, AgentRequestUio, AgentSubscriptionUio, AgentUio, AgentUsageMetricsUio, BodyWithIdUio, ChatUio, ConversationAttachmentDownloadUrlUio, DeleteMessageAudio200ResponseUio, FileCreationRequestUio, FileCreationResponseUio, FlowEditorUio, FlowEditorUpdateRequestUio, MessageAudioDownloadUrlUio, S3UploadBodyUio } from '../models/index';
+import type { AdvancedFlowEditorUio, AdvancedFlowEditorUpdateRequestUio, AgentDuplicateRequestUio, AgentFlowCreateUio, AgentFlowUio, AgentMetricsEventUio, AgentMetricsOverviewUio, AgentModuleUio, AgentPatchUio, AgentRequestUio, AgentSubscriptionUio, AgentUio, AgentUsageMetricsUio, BodyWithIdUio, ChatUio, ConversationAttachmentDownloadUrlUio, DeleteMessageAudio200ResponseUio, EphemeralInstancesMetricsResponseUio, FileCreationRequestUio, FileCreationResponseUio, FlowEditorUio, FlowEditorUpdateRequestUio, MessageAudioDownloadUrlUio, OrgUsageMetricsResponseUio, S3UploadBodyUio } from '../models/index';
 export interface AddModuleRequest {
     agentId: string;
     agentModuleUio: AgentModuleUio;
@@ -53,19 +53,31 @@ export interface GetAgentConversationByIdRequest {
 }
 export interface GetAgentMetricsRequest {
     agentId: string;
-    startDate?: Date;
-    endDate?: Date;
+    startDate?: string;
+    endDate?: string;
+}
+export interface GetAgentMetricsEphemeralInstancesRequest {
+    agentId: string;
+    startDate?: string;
+    endDate?: string;
+    granularity?: GetAgentMetricsEphemeralInstancesGranularityEnum;
 }
 export interface GetAgentMetricsEventsRequest {
     agentId: string;
     offset?: number;
-    startDate?: Date;
-    endDate?: Date;
+    startDate?: string;
+    endDate?: string;
 }
 export interface GetAgentMetricsOverviewRequest {
     agentId: string;
-    startDate?: Date;
-    endDate?: Date;
+    startDate?: string;
+    endDate?: string;
+}
+export interface GetAgentMetricsUsageRequest {
+    agentId: string;
+    startDate?: string;
+    endDate?: string;
+    granularity?: GetAgentMetricsUsageGranularityEnum;
 }
 export interface GetAgentsRequest {
     isCreator?: boolean;
@@ -277,7 +289,17 @@ export declare class AgentApi extends runtime.BaseAPI {
      * Retrieves detailed usage metrics for a specific agent (admin only)
      * Get detailed agent metrics
      */
-    getAgentMetrics(agentId: string, startDate?: Date, endDate?: Date, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AgentUsageMetricsUio>>;
+    getAgentMetrics(agentId: string, startDate?: string, endDate?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AgentUsageMetricsUio>>;
+    /**
+     * Returns ephemeral instance creation counts over time for an agent
+     * Get ephemeral instances metrics for an agent
+     */
+    getAgentMetricsEphemeralInstancesRaw(requestParameters: GetAgentMetricsEphemeralInstancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EphemeralInstancesMetricsResponseUio>>;
+    /**
+     * Returns ephemeral instance creation counts over time for an agent
+     * Get ephemeral instances metrics for an agent
+     */
+    getAgentMetricsEphemeralInstances(agentId: string, startDate?: string, endDate?: string, granularity?: GetAgentMetricsEphemeralInstancesGranularityEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EphemeralInstancesMetricsResponseUio>;
     /**
      * Retrieves detailed metric events for a specific agent (admin only)
      * Get agent metrics events
@@ -287,7 +309,7 @@ export declare class AgentApi extends runtime.BaseAPI {
      * Retrieves detailed metric events for a specific agent (admin only)
      * Get agent metrics events
      */
-    getAgentMetricsEvents(agentId: string, offset?: number, startDate?: Date, endDate?: Date, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AgentMetricsEventUio>>;
+    getAgentMetricsEvents(agentId: string, offset?: number, startDate?: string, endDate?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AgentMetricsEventUio>>;
     /**
      * Retrieves usage metrics overview for a specific agent
      * Get agent metrics overview
@@ -297,7 +319,17 @@ export declare class AgentApi extends runtime.BaseAPI {
      * Retrieves usage metrics overview for a specific agent
      * Get agent metrics overview
      */
-    getAgentMetricsOverview(agentId: string, startDate?: Date, endDate?: Date, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentMetricsOverviewUio>;
+    getAgentMetricsOverview(agentId: string, startDate?: string, endDate?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentMetricsOverviewUio>;
+    /**
+     * Returns LLM requests and token usage over time for a specific agent
+     * Get usage metrics for an agent
+     */
+    getAgentMetricsUsageRaw(requestParameters: GetAgentMetricsUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrgUsageMetricsResponseUio>>;
+    /**
+     * Returns LLM requests and token usage over time for a specific agent
+     * Get usage metrics for an agent
+     */
+    getAgentMetricsUsage(agentId: string, startDate?: string, endDate?: string, granularity?: GetAgentMetricsUsageGranularityEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrgUsageMetricsResponseUio>;
     /**
      * Get all agents accessible to user
      * Get all agents
@@ -501,6 +533,24 @@ export declare class AgentApi extends runtime.BaseAPI {
      */
     upsertFlowEditor(agentId: string, flowEditorUpdateRequestUio: FlowEditorUpdateRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }
+/**
+ * @export
+ */
+export declare const GetAgentMetricsEphemeralInstancesGranularityEnum: {
+    readonly Hour: "hour";
+    readonly Day: "day";
+    readonly Week: "week";
+};
+export type GetAgentMetricsEphemeralInstancesGranularityEnum = typeof GetAgentMetricsEphemeralInstancesGranularityEnum[keyof typeof GetAgentMetricsEphemeralInstancesGranularityEnum];
+/**
+ * @export
+ */
+export declare const GetAgentMetricsUsageGranularityEnum: {
+    readonly Hour: "hour";
+    readonly Day: "day";
+    readonly Week: "week";
+};
+export type GetAgentMetricsUsageGranularityEnum = typeof GetAgentMetricsUsageGranularityEnum[keyof typeof GetAgentMetricsUsageGranularityEnum];
 /**
  * @export
  */

package/dist/apis/AgentApi.js

@@ -46,7 +46,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListOrganizationAgentsProviderSourceEnum = exports.GetConversationsForAgentMessageReactionEnum = exports.GetConversationsForAgentSortOrderEnum = exports.GetAgentsProviderSourceEnum = exports.AgentApi = void 0;
+exports.ListOrganizationAgentsProviderSourceEnum = exports.GetConversationsForAgentMessageReactionEnum = exports.GetConversationsForAgentSortOrderEnum = exports.GetAgentsProviderSourceEnum = exports.GetAgentMetricsUsageGranularityEnum = exports.GetAgentMetricsEphemeralInstancesGranularityEnum = exports.AgentApi = void 0;
 const runtime = __importStar(require("../runtime"));
 const index_1 = require("../models/index");
 /**
@@ -406,10 +406,10 @@ class AgentApi extends runtime.BaseAPI {
         }
         const queryParameters = {};
         if (requestParameters['startDate'] != null) {
-            queryParameters['startDate'] = requestParameters['startDate'].toISOString();
+            queryParameters['startDate'] = requestParameters['startDate'];
         }
         if (requestParameters['endDate'] != null) {
-            queryParameters['endDate'] = requestParameters['endDate'].toISOString();
+            queryParameters['endDate'] = requestParameters['endDate'];
         }
         const headerParameters = {};
         if (this.configuration && this.configuration.apiKey) {
@@ -431,6 +431,44 @@ class AgentApi extends runtime.BaseAPI {
         const response = await this.getAgentMetricsRaw({ agentId: agentId, startDate: startDate, endDate: endDate }, initOverrides);
         return await response.value();
     }
+    /**
+     * Returns ephemeral instance creation counts over time for an agent
+     * Get ephemeral instances metrics for an agent
+     */
+    async getAgentMetricsEphemeralInstancesRaw(requestParameters, initOverrides) {
+        if (requestParameters['agentId'] == null) {
+            throw new runtime.RequiredError('agentId', 'Required parameter "agentId" was null or undefined when calling getAgentMetricsEphemeralInstances().');
+        }
+        const queryParameters = {};
+        if (requestParameters['startDate'] != null) {
+            queryParameters['startDate'] = requestParameters['startDate'];
+        }
+        if (requestParameters['endDate'] != null) {
+            queryParameters['endDate'] = requestParameters['endDate'];
+        }
+        if (requestParameters['granularity'] != null) {
+            queryParameters['granularity'] = requestParameters['granularity'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+        const response = await this.request({
+            path: `/agents/{agentId}/metrics/ephemeral-instances`.replace(`{${"agentId"}}`, encodeURIComponent(String(requestParameters['agentId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.EphemeralInstancesMetricsResponseUioFromJSON)(jsonValue));
+    }
+    /**
+     * Returns ephemeral instance creation counts over time for an agent
+     * Get ephemeral instances metrics for an agent
+     */
+    async getAgentMetricsEphemeralInstances(agentId, startDate, endDate, granularity, initOverrides) {
+        const response = await this.getAgentMetricsEphemeralInstancesRaw({ agentId: agentId, startDate: startDate, endDate: endDate, granularity: granularity }, initOverrides);
+        return await response.value();
+    }
     /**
      * Retrieves detailed metric events for a specific agent (admin only)
      * Get agent metrics events
@@ -444,10 +482,10 @@ class AgentApi extends runtime.BaseAPI {
             queryParameters['offset'] = requestParameters['offset'];
         }
         if (requestParameters['startDate'] != null) {
-            queryParameters['startDate'] = requestParameters['startDate'].toISOString();
+            queryParameters['startDate'] = requestParameters['startDate'];
         }
         if (requestParameters['endDate'] != null) {
-            queryParameters['endDate'] = requestParameters['endDate'].toISOString();
+            queryParameters['endDate'] = requestParameters['endDate'];
         }
         const headerParameters = {};
         if (this.configuration && this.configuration.apiKey) {
@@ -479,10 +517,10 @@ class AgentApi extends runtime.BaseAPI {
         }
         const queryParameters = {};
         if (requestParameters['startDate'] != null) {
-            queryParameters['startDate'] = requestParameters['startDate'].toISOString();
+            queryParameters['startDate'] = requestParameters['startDate'];
         }
         if (requestParameters['endDate'] != null) {
-            queryParameters['endDate'] = requestParameters['endDate'].toISOString();
+            queryParameters['endDate'] = requestParameters['endDate'];
         }
         const headerParameters = {};
         if (this.configuration && this.configuration.apiKey) {
@@ -504,6 +542,44 @@ class AgentApi extends runtime.BaseAPI {
         const response = await this.getAgentMetricsOverviewRaw({ agentId: agentId, startDate: startDate, endDate: endDate }, initOverrides);
         return await response.value();
     }
+    /**
+     * Returns LLM requests and token usage over time for a specific agent
+     * Get usage metrics for an agent
+     */
+    async getAgentMetricsUsageRaw(requestParameters, initOverrides) {
+        if (requestParameters['agentId'] == null) {
+            throw new runtime.RequiredError('agentId', 'Required parameter "agentId" was null or undefined when calling getAgentMetricsUsage().');
+        }
+        const queryParameters = {};
+        if (requestParameters['startDate'] != null) {
+            queryParameters['startDate'] = requestParameters['startDate'];
+        }
+        if (requestParameters['endDate'] != null) {
+            queryParameters['endDate'] = requestParameters['endDate'];
+        }
+        if (requestParameters['granularity'] != null) {
+            queryParameters['granularity'] = requestParameters['granularity'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+        const response = await this.request({
+            path: `/agents/{agentId}/metrics/usage`.replace(`{${"agentId"}}`, encodeURIComponent(String(requestParameters['agentId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.OrgUsageMetricsResponseUioFromJSON)(jsonValue));
+    }
+    /**
+     * Returns LLM requests and token usage over time for a specific agent
+     * Get usage metrics for an agent
+     */
+    async getAgentMetricsUsage(agentId, startDate, endDate, granularity, initOverrides) {
+        const response = await this.getAgentMetricsUsageRaw({ agentId: agentId, startDate: startDate, endDate: endDate, granularity: granularity }, initOverrides);
+        return await response.value();
+    }
     /**
      * Get all agents accessible to user
      * Get all agents
@@ -1192,6 +1268,22 @@ class AgentApi extends runtime.BaseAPI {
     }
 }
 exports.AgentApi = AgentApi;
+/**
+ * @export
+ */
+exports.GetAgentMetricsEphemeralInstancesGranularityEnum = {
+    Hour: 'hour',
+    Day: 'day',
+    Week: 'week'
+};
+/**
+ * @export
+ */
+exports.GetAgentMetricsUsageGranularityEnum = {
+    Hour: 'hour',
+    Day: 'day',
+    Week: 'week'
+};
 /**
  * @export
  */

package/dist/apis/MetricsApi.d.ts

@@ -10,14 +10,50 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { MetricForAgentUio, MetricUio } from '../models/index';
+import type { EphemeralInstancesMetricsResponseUio, MetricForAgentUio, MetricForDayInnerUio, MetricUio, MetricsBrainsAgentResponseUio, MetricsTopAgentsResponseInnerUio, MetricsTopAgentsUsageResponseInnerUio, MetricsUsersResponseUio, OrgUsageMetricsResponseUio } from '../models/index';
 export interface GetMetricsRequest {
-    startDate?: Date;
-    endDate?: Date;
+    startDate?: string;
+    endDate?: string;
 }
 export interface GetMetricsAgentsRequest {
-    startDate?: Date;
-    endDate?: Date;
+    startDate?: string;
+    endDate?: string;
+}
+export interface GetMetricsBrainsAgentRequest {
+    organizationId: string;
+    agentId: string;
+}
+export interface GetMetricsDayMetricsRequest {
+    organizationId: string;
+}
+export interface GetMetricsOrganizationEphemeralInstancesRequest {
+    organizationId: string;
+    startDate?: string;
+    endDate?: string;
+    granularity?: GetMetricsOrganizationEphemeralInstancesGranularityEnum;
+}
+export interface GetMetricsOrganizationUsageRequest {
+    organizationId: string;
+    startDate?: string;
+    endDate?: string;
+    granularity?: GetMetricsOrganizationUsageGranularityEnum;
+}
+export interface GetMetricsTopAgentsRequest {
+    organizationId: string;
+    startDate?: string;
+    endDate?: string;
+    agentsIds?: Array<string>;
+}
+export interface GetMetricsTopAgentsUsageRequest {
+    organizationId: string;
+    startDate?: string;
+    endDate?: string;
+    agentsIds?: Array<string>;
+}
+export interface GetMetricsUsersVisitorsRequest {
+    organizationId: string;
+    startDate?: string;
+    endDate?: string;
 }
 /**
  *
@@ -32,7 +68,7 @@ export declare class MetricsApi extends runtime.BaseAPI {
      * Retrieves usage metrics for all agents within a date range (admin only)
      * Get usage metrics
      */
-    getMetrics(startDate?: Date, endDate?: Date, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<MetricUio>>;
+    getMetrics(startDate?: string, endDate?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<MetricUio>>;
     /**
      * Retrieves usage metrics broken down by agent within a date range (admin only)
      * Get agent-specific metrics
@@ -42,5 +78,93 @@ export declare class MetricsApi extends runtime.BaseAPI {
      * Retrieves usage metrics broken down by agent within a date range (admin only)
      * Get agent-specific metrics
      */
-    getMetricsAgents(startDate?: Date, endDate?: Date, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<MetricForAgentUio>>;
+    getMetricsAgents(startDate?: string, endDate?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<MetricForAgentUio>>;
+    /**
+     * Retrieves metrics for a brain agent
+     * Get metrics for a brain agent
+     */
+    getMetricsBrainsAgentRaw(requestParameters: GetMetricsBrainsAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MetricsBrainsAgentResponseUio>>;
+    /**
+     * Retrieves metrics for a brain agent
+     * Get metrics for a brain agent
+     */
+    getMetricsBrainsAgent(organizationId: string, agentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MetricsBrainsAgentResponseUio>;
+    /**
+     * Retrieves usage metrics broken down by day within a date range (admin only)
+     * Get day-specific metrics
+     */
+    getMetricsDayMetricsRaw(requestParameters: GetMetricsDayMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Array<MetricForDayInnerUio>>>>;
+    /**
+     * Retrieves usage metrics broken down by day within a date range (admin only)
+     * Get day-specific metrics
+     */
+    getMetricsDayMetrics(organizationId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Array<MetricForDayInnerUio>>>;
+    /**
+     * Returns ephemeral instance creation counts over time for all agents in the organization
+     * Get ephemeral instances metrics for an organization
+     */
+    getMetricsOrganizationEphemeralInstancesRaw(requestParameters: GetMetricsOrganizationEphemeralInstancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EphemeralInstancesMetricsResponseUio>>;
+    /**
+     * Returns ephemeral instance creation counts over time for all agents in the organization
+     * Get ephemeral instances metrics for an organization
+     */
+    getMetricsOrganizationEphemeralInstances(organizationId: string, startDate?: string, endDate?: string, granularity?: GetMetricsOrganizationEphemeralInstancesGranularityEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EphemeralInstancesMetricsResponseUio>;
+    /**
+     * Returns LLM requests and token usage over time for all agents in the organization
+     * Get usage metrics for an organization
+     */
+    getMetricsOrganizationUsageRaw(requestParameters: GetMetricsOrganizationUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrgUsageMetricsResponseUio>>;
+    /**
+     * Returns LLM requests and token usage over time for all agents in the organization
+     * Get usage metrics for an organization
+     */
+    getMetricsOrganizationUsage(organizationId: string, startDate?: string, endDate?: string, granularity?: GetMetricsOrganizationUsageGranularityEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrgUsageMetricsResponseUio>;
+    /**
+     * Retrieves usage metrics broken down by top agents within a date range (admin only)
+     * Get top agents metrics
+     */
+    getMetricsTopAgentsRaw(requestParameters: GetMetricsTopAgentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<MetricsTopAgentsResponseInnerUio>>>;
+    /**
+     * Retrieves usage metrics broken down by top agents within a date range (admin only)
+     * Get top agents metrics
+     */
+    getMetricsTopAgents(organizationId: string, startDate?: string, endDate?: string, agentsIds?: Array<string>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<MetricsTopAgentsResponseInnerUio>>;
+    /**
+     * Retrieves usage metrics broken down by top agents within a date range (admin only)
+     * Get top agents usage metrics
+     */
+    getMetricsTopAgentsUsageRaw(requestParameters: GetMetricsTopAgentsUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<MetricsTopAgentsUsageResponseInnerUio>>>;
+    /**
+     * Retrieves usage metrics broken down by top agents within a date range (admin only)
+     * Get top agents usage metrics
+     */
+    getMetricsTopAgentsUsage(organizationId: string, startDate?: string, endDate?: string, agentsIds?: Array<string>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<MetricsTopAgentsUsageResponseInnerUio>>;
+    /**
+     * Retrieves usage metrics broken down by users within a date range (admin only)
+     * Get users metrics
+     */
+    getMetricsUsersVisitorsRaw(requestParameters: GetMetricsUsersVisitorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MetricsUsersResponseUio>>;
+    /**
+     * Retrieves usage metrics broken down by users within a date range (admin only)
+     * Get users metrics
+     */
+    getMetricsUsersVisitors(organizationId: string, startDate?: string, endDate?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MetricsUsersResponseUio>;
 }
+/**
+ * @export
+ */
+export declare const GetMetricsOrganizationEphemeralInstancesGranularityEnum: {
+    readonly Hour: "hour";
+    readonly Day: "day";
+    readonly Week: "week";
+};
+export type GetMetricsOrganizationEphemeralInstancesGranularityEnum = typeof GetMetricsOrganizationEphemeralInstancesGranularityEnum[keyof typeof GetMetricsOrganizationEphemeralInstancesGranularityEnum];
+/**
+ * @export
+ */
+export declare const GetMetricsOrganizationUsageGranularityEnum: {
+    readonly Hour: "hour";
+    readonly Day: "day";
+    readonly Week: "week";
+};
+export type GetMetricsOrganizationUsageGranularityEnum = typeof GetMetricsOrganizationUsageGranularityEnum[keyof typeof GetMetricsOrganizationUsageGranularityEnum];