@uipath/uipath-typescript 1.5.0 → 1.5.1

package/dist/maestro-processes/index.d.ts

@@ -75,6 +75,12 @@ interface TimelineOptions {
      * @default TimeInterval.Day
      */
     groupBy?: TimeInterval;
+    /** Filter by package identifier */
+    packageId?: string;
+    /** Filter by package version */
+    version?: string;
+    /** Filter by one or more process keys. Pass `['<processKey>']` for a single process. */
+    processKeys?: string[];
 }
 /**
  * Final instance statuses returned by the instance status timeline endpoint.
@@ -102,6 +108,17 @@ interface InstanceStatusTimelineResponse {
     /** Number of instances with this status in the time bucket */
     count: number;
 }
+/**
+ * Incident count within a specific time bucket.
+ */
+interface IncidentTimelineResponse {
+    /** Start of the time bucket in local timezone (ISO 8601, e.g. `"2026-05-04T00:00:00"`) */
+    startTime: string;
+    /** End of the time bucket in local timezone (ISO 8601, e.g. `"2026-05-11T00:00:00"`) */
+    endTime: string;
+    /** Number of incidents that occurred within this time bucket */
+    count: number;
+}
 /**
  * Response for the top duration Insights endpoint
  */
@@ -504,7 +521,7 @@ interface MaestroProcessesServiceModel {
      *
      * @param startTime - Start of the time range to query
      * @param endTime - End of the time range to query
-     * @param options - Optional settings for time bucketing granularity
+     * @param options - Optional settings for filtering and time bucket granularity
      * @returns Promise resolving to an array of {@link InstanceStatusTimelineResponse}
      *
      * @example
@@ -531,11 +548,62 @@ interface MaestroProcessesServiceModel {
      *
      * @example
      * ```typescript
+     * // Filter to a specific process
+     * const filtered = await maestroProcesses.getInstanceStatusTimeline(startTime, endTime, {
+     *   processKeys: ['<processKey>'],
+     * });
+     * ```
+     *
+     * @example
+     * ```typescript
      * // Get all-time data (from Unix epoch to now)
      * const allTime = await maestroProcesses.getInstanceStatusTimeline(new Date(0), new Date());
      * ```
      */
     getInstanceStatusTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<InstanceStatusTimelineResponse[]>;
+    /**
+     * Get incident counts aggregated by time bucket for maestro processes.
+     *
+     * Returns time-grouped counts of incidents that occurred within each bucket,
+     * useful for rendering incident time-series charts. Use `groupBy` to control
+     * the time bucket size (hour, day, or week) — defaults to day if not provided.
+     *
+     * @param startTime - Start of the time range to query
+     * @param endTime - End of the time range to query
+     * @param options - Optional settings for filtering and time bucket granularity
+     * @returns Promise resolving to an array of {@link IncidentTimelineResponse}
+     *
+     * @example
+     * ```typescript
+     * // Get daily incident counts for the last 7 days
+     * const now = new Date();
+     * const sevenDaysAgo = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
+     * const incidents = await maestroProcesses.getIncidentsTimeline(sevenDaysAgo, now);
+     *
+     * for (const incident of incidents) {
+     *   console.log(`${incident.startTime} → ${incident.endTime}: ${incident.count} incidents`);
+     * }
+     * ```
+     *
+     * @example
+     * ```typescript
+     * import { TimeInterval } from '@uipath/uipath-typescript/maestro-processes';
+     *
+     * // Get weekly breakdown
+     * const incidents = await maestroProcesses.getIncidentsTimeline(startTime, endTime, {
+     *   groupBy: TimeInterval.Week,
+     * });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Filter to a specific process
+     * const filtered = await maestroProcesses.getIncidentsTimeline(startTime, endTime, {
+     *   processKeys: ['<processKey>'],
+     * });
+     * ```
+     */
+    getIncidentsTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<IncidentTimelineResponse[]>;
     /**
      * Get the top 5 processes ranked by total duration within a time range.
      *
@@ -675,6 +743,24 @@ interface ProcessMethods {
      * @returns Promise resolving to {@link InstanceStats}
      */
     getInstanceStats(startTime: Date, endTime: Date, packageVersion: string): Promise<InstanceStats>;
+    /**
+     * Get instance status counts aggregated by date for this process.
+     *
+     * @param startTime - Start of the time range to query
+     * @param endTime - End of the time range to query
+     * @param options - Optional settings for filtering and time bucket granularity (processKey is auto-captured from this process)
+     * @returns Promise resolving to an array of {@link InstanceStatusTimelineResponse}
+     */
+    getInstanceStatusTimeline(startTime: Date, endTime: Date, options?: Omit<TimelineOptions, 'processKeys'>): Promise<InstanceStatusTimelineResponse[]>;
+    /**
+     * Get incident counts aggregated by time bucket for this process.
+     *
+     * @param startTime - Start of the time range to query
+     * @param endTime - End of the time range to query
+     * @param options - Optional settings for filtering and time bucket granularity (processKey is auto-captured from this process)
+     * @returns Promise resolving to an array of {@link IncidentTimelineResponse}
+     */
+    getIncidentsTimeline(startTime: Date, endTime: Date, options?: Omit<TimelineOptions, 'processKeys'>): Promise<IncidentTimelineResponse[]>;
 }
 type MaestroProcessGetAllResponse = RawMaestroProcessGetAllResponse & ProcessMethods;
 /**
@@ -943,7 +1029,7 @@ interface ProcessInstancesServiceModel {
      */
     getAll<T extends ProcessInstanceGetAllWithPaginationOptions = ProcessInstanceGetAllWithPaginationOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ProcessInstanceGetResponse> : NonPaginatedResponse<ProcessInstanceGetResponse>>;
     /**
-     * Get a process instance by ID with operation methods (cancel, pause, resume)
+     * Get a process instance by ID with operation methods (cancel, pause, resume, retry)
      * @param id The ID of the instance to retrieve
      * @param folderKey The folder key for authorization
      * @returns Promise resolving to a process instance
@@ -1062,6 +1148,35 @@ interface ProcessInstancesServiceModel {
      * @returns Promise resolving to operation result with instance data
      */
     resume(instanceId: string, folderKey: string, options?: ProcessInstanceOperationOptions): Promise<OperationResponse<ProcessInstanceOperationResponse>>;
+    /**
+     * Retry a faulted process instance
+     *
+     * Re-runs the failed elements of the instance (and the elements that follow) within the
+     * same instance, spawning new jobs. Use to recover from transient/flaky failures.
+     * @param instanceId The ID of the instance to retry
+     * @param folderKey The folder key for authorization
+     * @param options Optional retry options with comment
+     * @returns Promise resolving to operation result with instance data
+     * @example
+     * ```typescript
+     * // Retry a faulted process instance
+     * const result = await processInstances.retry(
+     *   <instanceId>,
+     *   <folderKey>
+     * );
+     *
+     * // Or using instance method
+     * const instance = await processInstances.getById(
+     *   <instanceId>,
+     *   <folderKey>
+     * );
+     * if (instance.latestRunStatus === 'Faulted') {
+     *   const result = await instance.retry({ comment: 'Retrying flaky failure' });
+     *   console.log(`Retried: ${result.success}`);
+     * }
+     * ```
+     */
+    retry(instanceId: string, folderKey: string, options?: ProcessInstanceOperationOptions): Promise<OperationResponse<ProcessInstanceOperationResponse>>;
     /**
      * Get global variables for a process instance
      *
@@ -1142,6 +1257,13 @@ interface ProcessInstanceMethods {
      * @returns Promise resolving to operation result
      */
     resume(options?: ProcessInstanceOperationOptions): Promise<OperationResponse<ProcessInstanceOperationResponse>>;
+    /**
+     * Retries this faulted process instance
+     *
+     * @param options - Optional retry options with comment
+     * @returns Promise resolving to operation result
+     */
+    retry(options?: ProcessInstanceOperationOptions): Promise<OperationResponse<ProcessInstanceOperationResponse>>;
     /**
      * Gets incidents for this process instance
      *
@@ -1562,7 +1684,7 @@ declare class MaestroProcessesService extends BaseService implements MaestroProc
      *
      * @param startTime - Start of the time range to query
      * @param endTime - End of the time range to query
-     * @param options - Optional settings for time bucketing granularity
+     * @param options - Optional settings for filtering and time bucket granularity
      * @returns Promise resolving to an array of {@link InstanceStatusTimelineResponse}
      *
      * @example
@@ -1589,11 +1711,62 @@ declare class MaestroProcessesService extends BaseService implements MaestroProc
      *
      * @example
      * ```typescript
+     * // Filter to a specific process
+     * const filtered = await maestroProcesses.getInstanceStatusTimeline(startTime, endTime, {
+     *   processKeys: ['<processKey>'],
+     * });
+     * ```
+     *
+     * @example
+     * ```typescript
      * // Get all-time data (from Unix epoch to now)
      * const allTime = await maestroProcesses.getInstanceStatusTimeline(new Date(0), new Date());
      * ```
      */
     getInstanceStatusTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<InstanceStatusTimelineResponse[]>;
+    /**
+     * Get incident counts aggregated by time bucket for maestro processes.
+     *
+     * Returns time-grouped counts of incidents that occurred within each bucket,
+     * useful for rendering incident time-series charts. Use `groupBy` to control
+     * the time bucket size (hour, day, or week) — defaults to day if not provided.
+     *
+     * @param startTime - Start of the time range to query
+     * @param endTime - End of the time range to query
+     * @param options - Optional settings for filtering and time bucket granularity
+     * @returns Promise resolving to an array of {@link IncidentTimelineResponse}
+     *
+     * @example
+     * ```typescript
+     * // Get daily incident counts for the last 7 days
+     * const now = new Date();
+     * const sevenDaysAgo = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
+     * const incidents = await maestroProcesses.getIncidentsTimeline(sevenDaysAgo, now);
+     *
+     * for (const incident of incidents) {
+     *   console.log(`${incident.startTime} → ${incident.endTime}: ${incident.count} incidents`);
+     * }
+     * ```
+     *
+     * @example
+     * ```typescript
+     * import { TimeInterval } from '@uipath/uipath-typescript/maestro-processes';
+     *
+     * // Get weekly breakdown
+     * const incidents = await maestroProcesses.getIncidentsTimeline(startTime, endTime, {
+     *   groupBy: TimeInterval.Week,
+     * });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Filter to a specific process
+     * const filtered = await maestroProcesses.getIncidentsTimeline(startTime, endTime, {
+     *   processKeys: ['<processKey>'],
+     * });
+     * ```
+     */
+    getIncidentsTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<IncidentTimelineResponse[]>;
     /**
      * Get the top 10 processes ranked by failure count within a time range.
      *
@@ -1790,7 +1963,7 @@ declare class ProcessInstancesService extends BaseService implements ProcessInst
      */
     getAll<T extends ProcessInstanceGetAllWithPaginationOptions = ProcessInstanceGetAllWithPaginationOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ProcessInstanceGetResponse> : NonPaginatedResponse<ProcessInstanceGetResponse>>;
     /**
-     * Get a process instance by ID with operation methods (cancel, pause, resume)
+     * Get a process instance by ID with operation methods (cancel, pause, resume, retry)
      * @param id The ID of the instance to retrieve
      * @param folderKey The folder key for authorization
      * @returns Promise<ProcessInstanceGetResponse>
@@ -1851,6 +2024,17 @@ declare class ProcessInstancesService extends BaseService implements ProcessInst
      * @returns Promise resolving to operation result with updated instance data
      */
     resume(instanceId: string, folderKey: string, options?: ProcessInstanceOperationOptions): Promise<OperationResponse<ProcessInstanceOperationResponse>>;
+    /**
+     * Retry a faulted process instance
+     *
+     * Re-runs the failed elements of the instance (and the elements that follow) within
+     * the same instance, spawning new jobs. Use to recover from transient/flaky failures.
+     * @param instanceId The ID of the instance to retry
+     * @param folderKey The folder key for authorization
+     * @param options Optional retry options with comment
+     * @returns Promise resolving to operation result with updated instance data
+     */
+    retry(instanceId: string, folderKey: string, options?: ProcessInstanceOperationOptions): Promise<OperationResponse<ProcessInstanceOperationResponse>>;
     /**
      * Parses BPMN XML to extract variable metadata from uipath:inputOutput elements
      * @private
@@ -1919,4 +2103,4 @@ declare class ProcessIncidentsService extends BaseService implements ProcessInci
 }
 
 export { DebugMode, InstanceFinalStatus, MaestroProcessesService as MaestroProcesses, MaestroProcessesService, ProcessIncidentSeverity, ProcessIncidentStatus, ProcessIncidentType, ProcessIncidentsService as ProcessIncidents, ProcessIncidentsService, ProcessInstancesService as ProcessInstances, ProcessInstancesService, TimeInterval, createProcessInstanceWithMethods, createProcessWithMethods };
-export type { BpmnXmlString, DurationStats, ElementGetTopFailedCountResponse, ElementMetaData, ElementStats, GetTopBaseResponse, GetTopDurationResponse, GetTopFaultedCountResponse, GetTopRunCountResponse, GlobalVariableMetaData, InstanceStats, InstanceStatusTimelineResponse, MaestroProcessGetAllResponse, MaestroProcessStatsRequest, MaestroProcessesServiceModel, ProcessGetTopDurationResponse, ProcessGetTopFaultedCountResponse, ProcessGetTopRunCountResponse, ProcessIncidentGetAllResponse, ProcessIncidentGetResponse, ProcessIncidentsServiceModel, ProcessInstanceExecutionHistoryResponse, ProcessInstanceGetAllOptions, ProcessInstanceGetAllWithPaginationOptions, ProcessInstanceGetResponse, ProcessInstanceGetVariablesOptions, ProcessInstanceGetVariablesResponse, ProcessInstanceMethods, ProcessInstanceOperationOptions, ProcessInstanceOperationResponse, ProcessInstanceRun, ProcessInstancesServiceModel, ProcessMethods, RawMaestroProcessGetAllResponse, RawProcessInstanceGetResponse, TimelineOptions, TopQueryOptions };
+export type { BpmnXmlString, DurationStats, ElementGetTopFailedCountResponse, ElementMetaData, ElementStats, GetTopBaseResponse, GetTopDurationResponse, GetTopFaultedCountResponse, GetTopRunCountResponse, GlobalVariableMetaData, IncidentTimelineResponse, InstanceStats, InstanceStatusTimelineResponse, MaestroProcessGetAllResponse, MaestroProcessStatsRequest, MaestroProcessesServiceModel, ProcessGetTopDurationResponse, ProcessGetTopFaultedCountResponse, ProcessGetTopRunCountResponse, ProcessIncidentGetAllResponse, ProcessIncidentGetResponse, ProcessIncidentsServiceModel, ProcessInstanceExecutionHistoryResponse, ProcessInstanceGetAllOptions, ProcessInstanceGetAllWithPaginationOptions, ProcessInstanceGetResponse, ProcessInstanceGetVariablesOptions, ProcessInstanceGetVariablesResponse, ProcessInstanceMethods, ProcessInstanceOperationOptions, ProcessInstanceOperationResponse, ProcessInstanceRun, ProcessInstancesServiceModel, ProcessMethods, RawMaestroProcessGetAllResponse, RawProcessInstanceGetResponse, TimelineOptions, TopQueryOptions };