@uipath/uipath-typescript 1.4.2 → 1.5.1

package/dist/agents/index.d.ts

@@ -300,6 +300,24 @@ declare class BaseService {
     private determineHasMorePages;
 }
 
+/**
+ * Common enum for job state used across services
+ */
+declare enum JobState {
+    Pending = "Pending",
+    Running = "Running",
+    Stopping = "Stopping",
+    Terminating = "Terminating",
+    Faulted = "Faulted",
+    Successful = "Successful",
+    Stopped = "Stopped",
+    Suspended = "Suspended",
+    Resumed = "Resumed",
+    Cancelled = "Cancelled",
+    /** Server-side fallback for an unrecognized or missing job state. */
+    Unknown = "Unknown"
+}
+
 /**
  * Filter fields shared by agent endpoints that accept a
  * folder/agent/project scope (`/Agents/agents`, `/Agents/errors`, etc.).
@@ -326,9 +344,9 @@ declare enum AgentListSortColumn {
     HealthScore = "HealthScore",
     LastIncident = "LastIncident",
     FolderName = "FolderName",
-    /** Quantity of AGU (Agent Units) consumed */
+    /** Quantity of Agent Units consumed */
     QuantityAGU = "QuantityAGU",
-    /** Quantity of PLTU (Platform Units) consumed */
+    /** Quantity of Platform Units consumed */
     QuantityPLTU = "QuantityPLTU",
     FolderPath = "FolderPath"
 }
@@ -338,7 +356,10 @@ declare enum AgentListSortColumn {
 interface AgentListOrderBy {
     /** Column to sort by */
     column: AgentListSortColumn;
-    /** Sort descending. Defaults to false. */
+    /**
+     * Sort descending.
+     * @default false
+     */
     desc?: boolean;
 }
 /**
@@ -372,9 +393,9 @@ interface AgentListItem {
     unitsQuantity: number;
     /** Display name of the units (if any). May be `null` or `""`. */
     unitsName: string | null;
-    /** Quantity of AGU (Agent Units) consumed by this agent */
+    /** Quantity of Agent Units consumed by this agent */
     quantityAGU: number;
-    /** Quantity of PLTU (Platform Units) consumed by this agent */
+    /** Quantity of Platform Units consumed by this agent */
     quantityPLTU: number;
 }
 /**
@@ -429,7 +450,10 @@ declare enum AgentErrorSortColumn {
 interface AgentErrorOrderBy {
     /** Column to sort by */
     column: AgentErrorSortColumn;
-    /** Sort descending. Defaults to false (ascending) server-side. */
+    /**
+     * Sort descending.
+     * @default false
+     */
     desc?: boolean;
 }
 /**
@@ -490,7 +514,10 @@ interface AgentGetErrorsTimelineResponse {
  * Options for getting the agent errors timeline.
  */
 interface AgentGetErrorsTimelineOptions extends AgentFilterOptions {
-    /** Max number of agents to return. Defaults to 10 server-side. */
+    /**
+     * Max number of agents to return.
+     * @default 10
+     */
     limit?: number;
 }
 /**
@@ -499,7 +526,7 @@ interface AgentGetErrorsTimelineOptions extends AgentFilterOptions {
 interface AgentGetConsumptionTimelineResponse {
     /** Bucket timestamp (ISO 8601, UTC) */
     timeSlice: string;
-    /** AGU quantity consumed in this time bucket */
+    /** Agent Units quantity consumed in this time bucket */
     aguConsumption: number;
 }
 /**
@@ -525,6 +552,296 @@ interface AgentGetLatencyTimelineResponse {
  */
 interface AgentGetLatencyTimelineOptions extends AgentFilterOptions {
 }
+/**
+ * A single agent's error count over the requested window, with the first and
+ * last jobs where errors were observed.
+ */
+interface AgentTopErrorCount {
+    /** Agent name */
+    name: string;
+    /** Error count for this agent over the requested window */
+    count: number;
+    /** Agent ID (GUID) */
+    agentId: string;
+    /** First job in the window where this agent reported errors */
+    firstSeenJob: AgentJobInfo;
+    /** Last job in the window where this agent reported errors */
+    lastSeenJob: AgentJobInfo;
+}
+/**
+ * Response from getting the top agents by error count.
+ */
+interface AgentGetTopErrorCountResponse {
+    /** Total error count across all agents in the window. */
+    totalErrors: number;
+    /** Top-N agents ranked by error count. */
+    data: AgentTopErrorCount[];
+}
+/**
+ * Options for getting the top agents by error count.
+ */
+interface AgentGetTopErrorCountOptions extends AgentFilterOptions {
+    /**
+     * Max number of agents to return. Defaults to 10 server-side.
+     * @default 10
+     */
+    limit?: number;
+}
+/**
+ * Agent type, used to filter consumption results.
+ *
+ * Wire format is the string name, per the API's `StringEnumConverter` serialization.
+ */
+declare enum AgentType {
+    Autonomous = "Autonomous",
+    Conversational = "Conversational",
+    Coded = "Coded"
+}
+/**
+ * A single agent's unit consumption over the requested window, with the first
+ * and last jobs where consumption was recorded.
+ */
+interface AgentConsumption {
+    /** Agent ID (GUID) */
+    agentId: string;
+    /** Agent display name */
+    agentName: string;
+    /** Total quantity consumed by this agent. `null` if no consumption is recorded. */
+    consumedQuantity: number | null;
+    /** Agent Units quantity consumed. `null` if no consumption is recorded. */
+    consumedAGUQuantity: number | null;
+    /** Platform Units quantity consumed. `null` if no consumption is recorded. */
+    consumedPLTUQuantity: number | null;
+    /** First job in the window where this agent recorded consumption */
+    firstSeenJob: AgentJobInfo;
+    /** Last job in the window where this agent recorded consumption */
+    lastSeenJob: AgentJobInfo;
+}
+/**
+ * Response from getting the top agents by consumption.
+ */
+interface AgentGetTopConsumptionResponse {
+    /** Window start date. */
+    startDate: string;
+    /** Window end date. */
+    endDate: string;
+    /** Total quantity consumed across all matching agents in the window. */
+    totalConsumed: number;
+    /** Total Agent Units quantity consumed. */
+    totalAGUConsumed: number;
+    /** Total Platform Units quantity consumed. */
+    totalPLTUConsumed: number;
+    /** Limit applied (echoed from the request). */
+    limit: number;
+    /** Top-N agents ranked by consumption. Empty array when no agents matched. */
+    agents: AgentConsumption[];
+}
+/**
+ * Options for getting the top agents by consumption.
+ */
+interface AgentGetTopConsumptionOptions extends AgentFilterOptions {
+    /**
+     * Max number of agents to return. Defaults to 10 server-side.
+     * @default 10
+     */
+    limit?: number;
+    /**
+     * Health-based filter. `true` returns only healthy agents, `false` only
+     * unhealthy. Omit to include both.
+     */
+    healthy?: boolean;
+    /**
+     * Health-score cutoff used when `healthy` is set. Defaults to 75.0
+     * server-side.
+     * @default 75.0
+     */
+    healthThreshold?: number;
+    /**
+     * Filter to specific agent types. Multiple types are combined with `OR` and
+     * sent to the API as a comma-separated string.
+     */
+    agentTypes?: AgentType[];
+}
+/**
+ * Distribution of incidents across types over the requested window.
+ */
+interface AgentGetIncidentDistributionResponse {
+    /** Number of error-type incidents in the window */
+    errorCount: number;
+    /** Number of escalation-type incidents in the window */
+    escalationCount: number;
+    /** Number of policy-type incidents in the window */
+    policyCount: number;
+}
+/**
+ * Options for getting the incident distribution.
+ *
+ * Currently identical to {@link AgentFilterOptions}; named distinctly so that
+ * future per-method filters can be added without a breaking change.
+ */
+interface AgentGetIncidentDistributionOptions extends AgentFilterOptions {
+}
+/**
+ * Per-agent (process + folder) stats within an {@link AgentSummaryPeriod}.
+ */
+interface AgentSummaryEntry {
+    /** Process key (GUID) */
+    processKey: string;
+    /** Folder key (GUID) the agent ran in */
+    folderKey: string;
+    /** Process version */
+    processVersion: string;
+    /** Total job runs in the period */
+    totalJobs: number;
+    /** Number of successful runs in the period */
+    successfulJobs: number;
+    /** Success rate as a percentage (0-100) */
+    successRate: number;
+    /** Average run duration in seconds */
+    averageDurationSeconds: number;
+    /** First job completion timestamp (ISO 8601, UTC) */
+    firstJobFinished: string;
+    /** Last job completion timestamp (ISO 8601, UTC) */
+    lastJobFinished: string;
+    /**
+     * Status of the most recent run, normalized to {@link JobState}. The API's
+     * `Success` label maps to {@link JobState.Successful}; any unrecognized value
+     * becomes {@link JobState.Unknown}.
+     */
+    lastJobStatus: JobState;
+}
+/**
+ * Aggregate stats for a single period within an {@link AgentGetSummaryResponse}
+ * — covers the requested window for either the current period or an optional
+ * lookback period.
+ */
+interface AgentSummaryPeriod {
+    /** Total job runs across all agents in the period */
+    totalJobs: number;
+    /** Number of successful runs across all agents in the period */
+    successfulJobs: number;
+    /** Overall success rate as a percentage (0-100) */
+    successRate: number;
+    /** Average run duration in seconds across all agents in the period */
+    averageDurationSeconds: number;
+    /** Period start time (ISO 8601, UTC) */
+    startTime: string;
+    /** Period end time (ISO 8601, UTC) */
+    endTime: string;
+    /** Per-agent breakdown */
+    agents: AgentSummaryEntry[];
+}
+/**
+ * Response from getting the agent summary.
+ */
+interface AgentGetSummaryResponse {
+    /** Aggregate stats for the requested window. Always present. */
+    currentPeriodSummary: AgentSummaryPeriod;
+    /** Aggregate stats for the prior window of equal length. Only present when `lookbackPeriodAnalysis: true` was sent. */
+    lookbackPeriodSummary?: AgentSummaryPeriod;
+}
+/**
+ * Job execution mode filter accepted by the summary endpoints.
+ *
+ * Wire format is the string name (`"Debug"` / `"Runtime"`), per the API's
+ * `StringEnumConverter` serialization.
+ */
+declare enum AgentExecutionType {
+    /** Test runs */
+    Debug = "Debug",
+    /** Production runs */
+    Runtime = "Runtime"
+}
+/**
+ * Options for getting the agent summary.
+ */
+interface AgentGetSummaryOptions extends AgentFilterOptions {
+    /**
+     * When `true`, it also computes a `lookbackPeriodSummary` for the
+     * prior window of equal length. Defaults to `false` server-side.
+     * @default false
+     */
+    lookbackPeriodAnalysis?: boolean;
+    /** Filter to a specific process by key (GUID). */
+    processKey?: string;
+    /**
+     * Filter to a specific folder by key (GUID).
+     *
+     * The summary endpoint accepts both — `folderKey` selects a
+     * single folder, `folderKeys` filters the lookup to a list of folders.
+     */
+    folderKey?: string;
+    /**
+     * Filter to a specific execution type — `Debug` (test runs) or
+     * `Runtime` (production runs).
+     */
+    executionType?: AgentExecutionType;
+}
+/**
+ * Job-type breakdown of unit consumption — completed jobs vs jobs still in
+ * progress at query time.
+ */
+interface AgentJobConsumptionSummary {
+    /** Units consumed by jobs that have completed in the period */
+    completeJobs: number;
+    /** Units consumed by jobs still in progress at query time */
+    incompleteJobs: number;
+}
+/**
+ * Per-agent (process + folder) unit consumption entry within an
+ * {@link AgentUnitConsumptionPeriod}.
+ */
+interface AgentUnitConsumptionEntry {
+    /** Folder key (GUID) the agent ran in */
+    folderKey: string;
+    /** Process key (GUID) */
+    processKey: string;
+    /** Process version */
+    processVersion: string;
+    /** First job completion timestamp (ISO 8601). `"0001-01-01T00:00:00"` if no completion in the period. */
+    firstJobFinished: string;
+    /** Last job completion timestamp (ISO 8601). `"0001-01-01T00:00:00"` if no completion in the period. */
+    lastJobFinished: string;
+    /** Agent Units consumption for this agent, split by job completion status */
+    agentUnitConsumption: AgentJobConsumptionSummary;
+    /** Platform Units consumption for this agent, split by job completion status */
+    platformUnitConsumption: AgentJobConsumptionSummary;
+}
+/**
+ * Aggregate Agent Units and Platform Units consumption for a single period within an
+ * {@link AgentGetUnitConsumptionSummaryResponse} — covers the requested window
+ * for either the current period or an optional lookback period.
+ */
+interface AgentUnitConsumptionPeriod {
+    /** Total Agent Units consumed across all agents in the period, split by job completion */
+    totalAgentUnitConsumption: AgentJobConsumptionSummary;
+    /** Total Platform Units consumed across all agents in the period, split by job completion */
+    totalPlatformUnitConsumption: AgentJobConsumptionSummary;
+    /** Period start time (ISO 8601, UTC) */
+    startTime: string;
+    /** Period end time (ISO 8601, UTC) */
+    endTime: string;
+    /** Per-agent consumption breakdown */
+    agentConsumption: AgentUnitConsumptionEntry[];
+}
+/**
+ * Response from getting the agent unit consumption summary.
+ */
+interface AgentGetUnitConsumptionSummaryResponse {
+    /** Aggregate consumption for the requested window. Always present. */
+    currentPeriodSummary: AgentUnitConsumptionPeriod;
+    /** Aggregate consumption for the prior window of equal length. Only present when `lookbackPeriodAnalysis: true` was sent. */
+    lookbackPeriodSummary?: AgentUnitConsumptionPeriod;
+}
+/**
+ * Options for getting the agent unit consumption summary.
+ *
+ * Currently identical to {@link AgentGetSummaryOptions} (the API uses the same
+ * `AgentsSummaryRequest` schema for both endpoints); named distinctly so that
+ * future per-method filters can be added without a breaking change.
+ */
+interface AgentGetUnitConsumptionSummaryOptions extends AgentGetSummaryOptions {
+}
 
 /**
  * Service for retrieving runtime data for UiPath Agents.
@@ -666,7 +983,7 @@ interface AgentServiceModel {
      */
     getErrorsTimeline(startTime: Date, endTime: Date, options?: AgentGetErrorsTimelineOptions): Promise<AgentGetErrorsTimelineResponse[]>;
     /**
-     * Retrieves a time-series of AGU (Agent Units) consumption over the requested window.
+     * Retrieves a time-series of Agent Units consumption over the requested window.
      *
      * @param startTime - Inclusive lower bound for the query window
      * @param endTime - Exclusive upper bound for the query window
@@ -678,13 +995,13 @@ interface AgentServiceModel {
      *
      * const agents = new Agents(sdk);
      *
-     * // AGU consumption timeline in May 2025
+     * // Agent Units consumption timeline in May 2025
      * const result = await agents.getConsumptionTimeline(
      *   new Date('2025-05-01T00:00:00Z'),
      *   new Date('2025-06-01T00:00:00Z'),
      * );
      * result.forEach((point) => {
-     *   console.log(`${point.timeSlice}: ${point.aguConsumption} AGU`);
+     *   console.log(`${point.timeSlice}: ${point.aguConsumption} Agent Units`);
      * });
      * ```
      * @example
@@ -738,6 +1055,198 @@ interface AgentServiceModel {
      * ```
      */
     getLatencyTimeline(startTime: Date, endTime: Date, options?: AgentGetLatencyTimelineOptions): Promise<AgentGetLatencyTimelineResponse[]>;
+    /**
+     * Retrieves the top-N agents ranked by error count over the requested window.
+     *
+     * @param startTime - Inclusive lower bound for the query window
+     * @param endTime - Exclusive upper bound for the query window
+     * @param options - Optional filters
+     * @returns Promise resolving to {@link AgentGetTopErrorCountResponse}
+     * @example
+     * ```typescript
+     * import { Agents } from '@uipath/uipath-typescript/agents';
+     *
+     * const agents = new Agents(sdk);
+     *
+     * // Top agents by error count in May 2025
+     * const result = await agents.getTopErrorCount(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     * );
+     * result.data.forEach((agent) => {
+     *   console.log(`${agent.name}: ${agent.count} errors`);
+     * });
+     * ```
+     * @example
+     * ```typescript
+     * // Scope to specific folders and top 5 agents
+     * const result = await agents.getTopErrorCount(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     *   {
+     *     folderKeys: ['<folderKey1>'],
+     *     limit: 5,
+     *   },
+     * );
+     * ```
+     */
+    getTopErrorCount(startTime: Date, endTime: Date, options?: AgentGetTopErrorCountOptions): Promise<AgentGetTopErrorCountResponse>;
+    /**
+     * Retrieves the top-N agents ranked by unit consumption over the requested window.
+     *
+     * @param startTime - Inclusive lower bound for the query window
+     * @param endTime - Exclusive upper bound for the query window
+     * @param options - Optional filters
+     * @returns Promise resolving to {@link AgentGetTopConsumptionResponse}
+     * @example
+     * ```typescript
+     * import { Agents } from '@uipath/uipath-typescript/agents';
+     *
+     * const agents = new Agents(sdk);
+     *
+     * // Top agents by consumption in May 2025
+     * const result = await agents.getTopConsumption(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     * );
+     * console.log(`Total consumed: ${result.totalConsumed}`);
+     * result.agents.forEach((agent) => {
+     *   console.log(`${agent.agentName}: ${agent.consumedQuantity}`);
+     * });
+     * ```
+     * @example
+     * ```typescript
+     * import { Agents, AgentType } from '@uipath/uipath-typescript/agents';
+     *
+     * const agents = new Agents(sdk);
+     *
+     * // Top 5 healthy autonomous agents by consumption
+     * const result = await agents.getTopConsumption(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     *   {
+     *     limit: 5,
+     *     healthy: true,
+     *     agentTypes: [AgentType.Autonomous],
+     *   },
+     * );
+     * ```
+     */
+    getTopConsumption(startTime: Date, endTime: Date, options?: AgentGetTopConsumptionOptions): Promise<AgentGetTopConsumptionResponse>;
+    /**
+     * Retrieves breakdown of agent incidents count — errors, escalations,
+     * and policy violations over a requested window.
+     *
+     * @param startTime - Inclusive lower bound for the query window
+     * @param endTime - Exclusive upper bound for the query window
+     * @param options - Optional filters
+     * @returns Promise resolving to {@link AgentGetIncidentDistributionResponse}
+     * @example
+     * ```typescript
+     * import { Agents } from '@uipath/uipath-typescript/agents';
+     *
+     * const agents = new Agents(sdk);
+     *
+     * // Incident distribution in May 2025
+     * const result = await agents.getIncidentDistribution(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     * );
+     * console.log(`Errors: ${result.errorCount}, Escalations: ${result.escalationCount}, Policy: ${result.policyCount}`);
+     * ```
+     * @example
+     * ```typescript
+     * // Scope to specific folders
+     * const result = await agents.getIncidentDistribution(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     *   {
+     *     folderKeys: ['<folderKey1>'],
+     *   },
+     * );
+     * ```
+     */
+    getIncidentDistribution(startTime: Date, endTime: Date, options?: AgentGetIncidentDistributionOptions): Promise<AgentGetIncidentDistributionResponse>;
+    /**
+     * Retrieves a job-execution summary for the requested window: overall totals
+     * (total jobs, successful jobs, success rate, average duration) alongside a
+     * per-agent breakdown. When `lookbackPeriodAnalysis` is enabled, a comparable
+     * summary for the preceding window of equal length is included too.
+     *
+     * @param startTime - Inclusive lower bound for the query window
+     * @param endTime - Exclusive upper bound for the query window
+     * @param options - Optional filters
+     * @returns Promise resolving to {@link AgentGetSummaryResponse}
+     * @example
+     * ```typescript
+     * import { Agents } from '@uipath/uipath-typescript/agents';
+     *
+     * const agents = new Agents(sdk);
+     *
+     * // Summary for May 2025
+     * const result = await agents.getSummary(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     * );
+     * console.log(`Success rate: ${result.currentPeriodSummary.successRate}%`);
+     * ```
+     * @example
+     * ```typescript
+     * import { Agents, AgentExecutionType } from '@uipath/uipath-typescript/agents';
+     *
+     * const agents = new Agents(sdk);
+     *
+     * // Runtime-only summary with lookback comparison
+     * const result = await agents.getSummary(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     *   {
+     *     lookbackPeriodAnalysis: true,
+     *     executionType: AgentExecutionType.Runtime,
+     *   },
+     * );
+     * ```
+     */
+    getSummary(startTime: Date, endTime: Date, options?: AgentGetSummaryOptions): Promise<AgentGetSummaryResponse>;
+    /**
+     * Retrieves an aggregate Agent Units and Platform Units consumption summary per agent over the
+     * requested window.
+     *
+     * @param startTime - Inclusive lower bound for the query window
+     * @param endTime - Exclusive upper bound for the query window
+     * @param options - Optional filters
+     * @returns Promise resolving to {@link AgentGetUnitConsumptionSummaryResponse}
+     * @example
+     * ```typescript
+     * import { Agents } from '@uipath/uipath-typescript/agents';
+     *
+     * const agents = new Agents(sdk);
+     *
+     * // Unit consumption summary for May 2025
+     * const result = await agents.getUnitConsumptionSummary(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     * );
+     * console.log(`Agent Units complete jobs: ${result.currentPeriodSummary.totalAgentUnitConsumption.completeJobs}`);
+     * ```
+     * @example
+     * ```typescript
+     * import { Agents, AgentExecutionType } from '@uipath/uipath-typescript/agents';
+     *
+     * const agents = new Agents(sdk);
+     *
+     * // Runtime-only summary with lookback comparison
+     * const result = await agents.getUnitConsumptionSummary(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     *   {
+     *     lookbackPeriodAnalysis: true,
+     *     executionType: AgentExecutionType.Runtime,
+     *   },
+     * );
+     * ```
+     */
+    getUnitConsumptionSummary(startTime: Date, endTime: Date, options?: AgentGetUnitConsumptionSummaryOptions): Promise<AgentGetUnitConsumptionSummaryResponse>;
 }
 
 /**
@@ -877,7 +1386,7 @@ declare class AgentService extends BaseService implements AgentServiceModel {
      */
     getErrorsTimeline(startTime: Date, endTime: Date, options?: AgentGetErrorsTimelineOptions): Promise<AgentGetErrorsTimelineResponse[]>;
     /**
-     * Retrieves a time-series of AGU (Agent Units) consumption over the requested window.
+     * Retrieves a time-series of Agent Units consumption over the requested window.
      *
      * @param startTime - Inclusive lower bound for the query window
      * @param endTime - Exclusive upper bound for the query window
@@ -889,13 +1398,13 @@ declare class AgentService extends BaseService implements AgentServiceModel {
      *
      * const agents = new Agents(sdk);
      *
-     * // AGU consumption timeline in May 2025
+     * // Agent Units consumption timeline in May 2025
      * const result = await agents.getConsumptionTimeline(
      *   new Date('2025-05-01T00:00:00Z'),
      *   new Date('2025-06-01T00:00:00Z'),
      * );
      * result.forEach((point) => {
-     *   console.log(`${point.timeSlice}: ${point.aguConsumption} AGU`);
+     *   console.log(`${point.timeSlice}: ${point.aguConsumption} Agent Units`);
      * });
      * ```
      * @example
@@ -949,6 +1458,198 @@ declare class AgentService extends BaseService implements AgentServiceModel {
      * ```
      */
     getLatencyTimeline(startTime: Date, endTime: Date, options?: AgentGetLatencyTimelineOptions): Promise<AgentGetLatencyTimelineResponse[]>;
+    /**
+     * Retrieves the top-N agents ranked by error count over the requested window.
+     *
+     * @param startTime - Inclusive lower bound for the query window
+     * @param endTime - Exclusive upper bound for the query window
+     * @param options - Optional filters
+     * @returns Promise resolving to {@link AgentGetTopErrorCountResponse}
+     * @example
+     * ```typescript
+     * import { Agents } from '@uipath/uipath-typescript/agents';
+     *
+     * const agents = new Agents(sdk);
+     *
+     * // Top agents by error count in May 2025
+     * const result = await agents.getTopErrorCount(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     * );
+     * result.data.forEach((agent) => {
+     *   console.log(`${agent.name}: ${agent.count} errors`);
+     * });
+     * ```
+     * @example
+     * ```typescript
+     * // Scope to specific folders and top 5 agents
+     * const result = await agents.getTopErrorCount(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     *   {
+     *     folderKeys: ['<folderKey1>'],
+     *     limit: 5,
+     *   },
+     * );
+     * ```
+     */
+    getTopErrorCount(startTime: Date, endTime: Date, options?: AgentGetTopErrorCountOptions): Promise<AgentGetTopErrorCountResponse>;
+    /**
+     * Retrieves the top-N agents ranked by unit consumption over the requested window.
+     *
+     * @param startTime - Inclusive lower bound for the query window
+     * @param endTime - Exclusive upper bound for the query window
+     * @param options - Optional filters
+     * @returns Promise resolving to {@link AgentGetTopConsumptionResponse}
+     * @example
+     * ```typescript
+     * import { Agents } from '@uipath/uipath-typescript/agents';
+     *
+     * const agents = new Agents(sdk);
+     *
+     * // Top agents by consumption in May 2025
+     * const result = await agents.getTopConsumption(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     * );
+     * console.log(`Total consumed: ${result.totalConsumed}`);
+     * result.agents.forEach((agent) => {
+     *   console.log(`${agent.agentName}: ${agent.consumedQuantity}`);
+     * });
+     * ```
+     * @example
+     * ```typescript
+     * import { Agents, AgentType } from '@uipath/uipath-typescript/agents';
+     *
+     * const agents = new Agents(sdk);
+     *
+     * // Top 5 healthy autonomous agents by consumption
+     * const result = await agents.getTopConsumption(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     *   {
+     *     limit: 5,
+     *     healthy: true,
+     *     agentTypes: [AgentType.Autonomous],
+     *   },
+     * );
+     * ```
+     */
+    getTopConsumption(startTime: Date, endTime: Date, options?: AgentGetTopConsumptionOptions): Promise<AgentGetTopConsumptionResponse>;
+    /**
+     * Retrieves breakdown of agent incidents count — errors, escalations,
+     * and policy violations over a requested window.
+     *
+     * @param startTime - Inclusive lower bound for the query window
+     * @param endTime - Exclusive upper bound for the query window
+     * @param options - Optional filters
+     * @returns Promise resolving to {@link AgentGetIncidentDistributionResponse}
+     * @example
+     * ```typescript
+     * import { Agents } from '@uipath/uipath-typescript/agents';
+     *
+     * const agents = new Agents(sdk);
+     *
+     * // Incident distribution in May 2025
+     * const result = await agents.getIncidentDistribution(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     * );
+     * console.log(`Errors: ${result.errorCount}, Escalations: ${result.escalationCount}, Policy: ${result.policyCount}`);
+     * ```
+     * @example
+     * ```typescript
+     * // Scope to specific folders
+     * const result = await agents.getIncidentDistribution(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     *   {
+     *     folderKeys: ['<folderKey1>'],
+     *   },
+     * );
+     * ```
+     */
+    getIncidentDistribution(startTime: Date, endTime: Date, options?: AgentGetIncidentDistributionOptions): Promise<AgentGetIncidentDistributionResponse>;
+    /**
+     * Retrieves a job-execution summary for the requested window: overall totals
+     * (total jobs, successful jobs, success rate, average duration) alongside a
+     * per-agent breakdown. When `lookbackPeriodAnalysis` is enabled, a comparable
+     * summary for the preceding window of equal length is included too.
+     *
+     * @param startTime - Inclusive lower bound for the query window
+     * @param endTime - Exclusive upper bound for the query window
+     * @param options - Optional filters
+     * @returns Promise resolving to {@link AgentGetSummaryResponse}
+     * @example
+     * ```typescript
+     * import { Agents } from '@uipath/uipath-typescript/agents';
+     *
+     * const agents = new Agents(sdk);
+     *
+     * // Summary for May 2025
+     * const result = await agents.getSummary(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     * );
+     * console.log(`Success rate: ${result.currentPeriodSummary.successRate}%`);
+     * ```
+     * @example
+     * ```typescript
+     * import { Agents, AgentExecutionType } from '@uipath/uipath-typescript/agents';
+     *
+     * const agents = new Agents(sdk);
+     *
+     * // Runtime-only summary with lookback comparison
+     * const result = await agents.getSummary(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     *   {
+     *     lookbackPeriodAnalysis: true,
+     *     executionType: AgentExecutionType.Runtime,
+     *   },
+     * );
+     * ```
+     */
+    getSummary(startTime: Date, endTime: Date, options?: AgentGetSummaryOptions): Promise<AgentGetSummaryResponse>;
+    /**
+     * Retrieves an aggregate Agent Units and Platform Units consumption summary per agent over the
+     * requested window.
+     *
+     * @param startTime - Inclusive lower bound for the query window
+     * @param endTime - Exclusive upper bound for the query window
+     * @param options - Optional filters
+     * @returns Promise resolving to {@link AgentGetUnitConsumptionSummaryResponse}
+     * @example
+     * ```typescript
+     * import { Agents } from '@uipath/uipath-typescript/agents';
+     *
+     * const agents = new Agents(sdk);
+     *
+     * // Unit consumption summary for May 2025
+     * const result = await agents.getUnitConsumptionSummary(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     * );
+     * console.log(`Agent Units complete jobs: ${result.currentPeriodSummary.totalAgentUnitConsumption.completeJobs}`);
+     * ```
+     * @example
+     * ```typescript
+     * import { Agents, AgentExecutionType } from '@uipath/uipath-typescript/agents';
+     *
+     * const agents = new Agents(sdk);
+     *
+     * // Runtime-only summary with lookback comparison
+     * const result = await agents.getUnitConsumptionSummary(
+     *   new Date('2025-05-01T00:00:00Z'),
+     *   new Date('2025-06-01T00:00:00Z'),
+     *   {
+     *     lookbackPeriodAnalysis: true,
+     *     executionType: AgentExecutionType.Runtime,
+     *   },
+     * );
+     * ```
+     */
+    getUnitConsumptionSummary(startTime: Date, endTime: Date, options?: AgentGetUnitConsumptionSummaryOptions): Promise<AgentGetUnitConsumptionSummaryResponse>;
     /**
      * Builds the common POST request body shared by the agent filter endpoints —
      * the required time window plus any optional folder/agent/project/process
@@ -957,5 +1658,5 @@ declare class AgentService extends BaseService implements AgentServiceModel {
     private buildAgentFilterBody;
 }
 
-export { AgentErrorSortColumn, AgentListSortColumn, AgentService as Agents };
-export type { AgentError, AgentErrorOrderBy, AgentFilterOptions, AgentGetAllOptions, AgentGetConsumptionTimelineOptions, AgentGetConsumptionTimelineResponse, AgentGetErrorsOptions, AgentGetErrorsTimelineOptions, AgentGetErrorsTimelineResponse, AgentGetLatencyTimelineOptions, AgentGetLatencyTimelineResponse, AgentJobInfo, AgentListItem, AgentListOrderBy, AgentServiceModel };
+export { AgentErrorSortColumn, AgentExecutionType, AgentListSortColumn, AgentType, AgentService as Agents };
+export type { AgentConsumption, AgentError, AgentErrorOrderBy, AgentFilterOptions, AgentGetAllOptions, AgentGetConsumptionTimelineOptions, AgentGetConsumptionTimelineResponse, AgentGetErrorsOptions, AgentGetErrorsTimelineOptions, AgentGetErrorsTimelineResponse, AgentGetIncidentDistributionOptions, AgentGetIncidentDistributionResponse, AgentGetLatencyTimelineOptions, AgentGetLatencyTimelineResponse, AgentGetSummaryOptions, AgentGetSummaryResponse, AgentGetTopConsumptionOptions, AgentGetTopConsumptionResponse, AgentGetTopErrorCountOptions, AgentGetTopErrorCountResponse, AgentGetUnitConsumptionSummaryOptions, AgentGetUnitConsumptionSummaryResponse, AgentJobConsumptionSummary, AgentJobInfo, AgentListItem, AgentListOrderBy, AgentServiceModel, AgentSummaryEntry, AgentSummaryPeriod, AgentTopErrorCount, AgentUnitConsumptionEntry, AgentUnitConsumptionPeriod };