@uipath/uipath-typescript 1.3.7 → 1.3.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/dist/assets/index.cjs +64 -274
  2. package/dist/assets/index.d.ts +1 -0
  3. package/dist/assets/index.mjs +64 -274
  4. package/dist/attachments/index.cjs +62 -271
  5. package/dist/attachments/index.d.ts +1 -0
  6. package/dist/attachments/index.mjs +62 -271
  7. package/dist/buckets/index.cjs +93 -274
  8. package/dist/buckets/index.d.ts +51 -1
  9. package/dist/buckets/index.mjs +93 -274
  10. package/dist/cases/index.cjs +580 -336
  11. package/dist/cases/index.d.ts +690 -3
  12. package/dist/cases/index.mjs +581 -337
  13. package/dist/conversational-agent/index.cjs +110 -285
  14. package/dist/conversational-agent/index.d.ts +63 -12
  15. package/dist/conversational-agent/index.mjs +110 -286
  16. package/dist/core/index.cjs +39 -289
  17. package/dist/core/index.d.ts +9 -98
  18. package/dist/core/index.mjs +40 -275
  19. package/dist/document-understanding/index.cjs +18 -1
  20. package/dist/document-understanding/index.d.ts +636 -610
  21. package/dist/document-understanding/index.mjs +18 -1
  22. package/dist/entities/index.cjs +64 -274
  23. package/dist/entities/index.d.ts +1 -0
  24. package/dist/entities/index.mjs +64 -274
  25. package/dist/feedback/index.cjs +313 -276
  26. package/dist/feedback/index.d.ts +418 -12
  27. package/dist/feedback/index.mjs +313 -276
  28. package/dist/index.cjs +777 -297
  29. package/dist/index.d.ts +2005 -721
  30. package/dist/index.mjs +777 -283
  31. package/dist/index.umd.js +966 -162
  32. package/dist/jobs/index.cjs +64 -274
  33. package/dist/jobs/index.d.ts +1 -0
  34. package/dist/jobs/index.mjs +64 -274
  35. package/dist/maestro-processes/index.cjs +1789 -1686
  36. package/dist/maestro-processes/index.d.ts +431 -2
  37. package/dist/maestro-processes/index.mjs +1790 -1687
  38. package/dist/processes/index.cjs +64 -274
  39. package/dist/processes/index.d.ts +1 -0
  40. package/dist/processes/index.mjs +64 -274
  41. package/dist/queues/index.cjs +64 -274
  42. package/dist/queues/index.d.ts +1 -0
  43. package/dist/queues/index.mjs +64 -274
  44. package/dist/tasks/index.cjs +64 -274
  45. package/dist/tasks/index.d.ts +1 -0
  46. package/dist/tasks/index.mjs +64 -274
  47. package/package.json +8 -10
package/dist/index.d.ts CHANGED
@@ -1,3 +1,6 @@
1
+ import * as _uipath_core_telemetry from '@uipath/core-telemetry';
2
+ import { TelemetryContext } from '@uipath/core-telemetry';
3
+
1
4
  /**
2
5
  * Authentication token information
3
6
  */
@@ -276,6 +279,7 @@ interface RequestWithPaginationOptions extends RequestSpec {
276
279
  offsetParam?: string;
277
280
  tokenParam?: string;
278
281
  countParam?: string;
282
+ convertToSkip?: boolean;
279
283
  };
280
284
  };
281
285
  }
@@ -2667,10 +2671,107 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
2667
2671
  getById<T extends ChoiceSetGetByIdOptions = ChoiceSetGetByIdOptions>(choiceSetId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ChoiceSetGetResponse> : NonPaginatedResponse<ChoiceSetGetResponse>>;
2668
2672
  }
2669
2673
 
2674
+ /**
2675
+ * Insights Types
2676
+ * Shared types for Maestro insights analytics endpoints
2677
+ */
2678
+ /**
2679
+ * Optional filters for Insights "top" endpoint queries.
2680
+ * All fields are optional — pass any combination to narrow results.
2681
+ */
2682
+ interface TopQueryOptions {
2683
+ /** Filter by package identifier */
2684
+ packageId?: string;
2685
+ /** Filter by process key */
2686
+ processKey?: string;
2687
+ /** Filter by package version */
2688
+ version?: string;
2689
+ }
2690
+ /**
2691
+ * Common fields returned by all Insights "top" endpoints
2692
+ */
2693
+ interface GetTopBaseResponse {
2694
+ /** The package identifier */
2695
+ packageId: string;
2696
+ /** The unique process key */
2697
+ processKey: string;
2698
+ }
2699
+ /**
2700
+ * Response for the top run count Insights endpoint
2701
+ */
2702
+ interface GetTopRunCountResponse extends GetTopBaseResponse {
2703
+ /** Number of times the process was run in the given time range */
2704
+ runCount: number;
2705
+ }
2706
+ /**
2707
+ * Response for the top failure count Insights endpoint
2708
+ */
2709
+ interface GetTopFaultedCountResponse extends GetTopBaseResponse {
2710
+ /** Number of faulted instances in the given time range */
2711
+ faultedCount: number;
2712
+ }
2713
+ /**
2714
+ * Time bucketing granularity for insights time-series queries.
2715
+ *
2716
+ * Controls how data points are grouped on the time axis.
2717
+ */
2718
+ declare enum TimeInterval {
2719
+ /** Group data points by hour */
2720
+ Hour = "HOUR",
2721
+ /** Group data points by day */
2722
+ Day = "DAY",
2723
+ /** Group data points by week */
2724
+ Week = "WEEK"
2725
+ }
2726
+ /**
2727
+ * Options for insights time-series queries.
2728
+ */
2729
+ interface TimelineOptions {
2730
+ /**
2731
+ * How to group data points on the time axis.
2732
+ * @default TimeInterval.Day
2733
+ */
2734
+ groupBy?: TimeInterval;
2735
+ }
2736
+ /**
2737
+ * Final instance statuses returned by the instance status timeline endpoint.
2738
+ *
2739
+ * Only includes statuses where the instance has finished execution — Completed, Faulted, or Cancelled.
2740
+ * Active statuses like Running or Paused are not included.
2741
+ */
2742
+ declare enum InstanceFinalStatus {
2743
+ /** Instance completed successfully */
2744
+ Completed = "Completed",
2745
+ /** Instance encountered an error */
2746
+ Faulted = "Faulted",
2747
+ /** Instance was cancelled */
2748
+ Cancelled = "Cancelled"
2749
+ }
2750
+ /**
2751
+ * Instance count for a process with a given status
2752
+ * within a specific time bucket.
2753
+ */
2754
+ interface InstanceStatusTimelineResponse {
2755
+ /** Start of the time bucket in local timezone (e.g. `"5/8/2026 12:00:00 AM"`) */
2756
+ startTime: string;
2757
+ /** Instance status */
2758
+ status: InstanceFinalStatus;
2759
+ /** Number of instances with this status in the time bucket */
2760
+ count: number;
2761
+ }
2762
+ /**
2763
+ * Response for the top duration Insights endpoint
2764
+ */
2765
+ interface GetTopDurationResponse extends GetTopBaseResponse {
2766
+ /** Total execution duration in milliseconds */
2767
+ duration: number;
2768
+ }
2769
+
2670
2770
  /**
2671
2771
  * Maestro Process Types
2672
2772
  * Types and interfaces for Maestro process management
2673
2773
  */
2774
+
2674
2775
  /**
2675
2776
  * Process information with instance statistics
2676
2777
  */
@@ -2710,6 +2811,27 @@ interface RawMaestroProcessGetAllResponse {
2710
2811
  /** Process instance count - canceling */
2711
2812
  cancelingCount: number;
2712
2813
  }
2814
+ /**
2815
+ * Response for a single entry in top processes by run count
2816
+ */
2817
+ interface ProcessGetTopRunCountResponse extends GetTopRunCountResponse {
2818
+ /** Human-readable process name */
2819
+ name: string;
2820
+ }
2821
+ /**
2822
+ * Response for a single entry in top processes by failure count
2823
+ */
2824
+ interface ProcessGetTopFaultedCountResponse extends GetTopFaultedCountResponse {
2825
+ /** Human-readable process name */
2826
+ name: string;
2827
+ }
2828
+ /**
2829
+ * Response for a single entry in top processes by duration
2830
+ */
2831
+ interface ProcessGetTopDurationResponse extends GetTopDurationResponse {
2832
+ /** Human-readable process name */
2833
+ name: string;
2834
+ }
2713
2835
 
2714
2836
  /**
2715
2837
  * Process Incident Status
@@ -2837,6 +2959,161 @@ interface MaestroProcessesServiceModel {
2837
2959
  * ```
2838
2960
  */
2839
2961
  getIncidents(processKey: string, folderKey: string): Promise<ProcessIncidentGetResponse[]>;
2962
+ /**
2963
+ * Get the top 5 processes ranked by run count within a time range.
2964
+ *
2965
+ * Returns an array of up to 5 processes sorted by how many times they were executed,
2966
+ * useful for identifying the most active processes in a given period.
2967
+ *
2968
+ * @param startTime - Start of the time range to query
2969
+ * @param endTime - End of the time range to query
2970
+ * @param options - Optional filters (packageId, processKey, version)
2971
+ * @returns Promise resolving to an array of {@link ProcessGetTopRunCountResponse}
2972
+ * @example
2973
+ * ```typescript
2974
+ * import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
2975
+ *
2976
+ * const maestroProcesses = new MaestroProcesses(sdk);
2977
+ *
2978
+ * // Get top processes by run count for the last 7 days
2979
+ * const topProcesses = await maestroProcesses.getTopRunCount(
2980
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
2981
+ * new Date()
2982
+ * );
2983
+ *
2984
+ * for (const process of topProcesses) {
2985
+ * console.log(`${process.packageId}: ${process.runCount} runs`);
2986
+ * }
2987
+ * ```
2988
+ *
2989
+ * @example
2990
+ * ```typescript
2991
+ * // Get top processes by run count for a specific package
2992
+ * const filtered = await maestroProcesses.getTopRunCount(
2993
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
2994
+ * new Date(),
2995
+ * { packageId: '<packageId>' }
2996
+ * );
2997
+ * ```
2998
+ */
2999
+ getTopRunCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopRunCountResponse[]>;
3000
+ /**
3001
+ * Get the top 10 processes ranked by failure count within a time range.
3002
+ *
3003
+ * Returns an array of up to 10 processes sorted by how many instances faulted,
3004
+ * useful for identifying the most error-prone processes in a given period.
3005
+ *
3006
+ * @param startTime - Start of the time range to query
3007
+ * @param endTime - End of the time range to query
3008
+ * @param options - Optional filters (packageId, processKey, version)
3009
+ * @returns Promise resolving to an array of {@link ProcessGetTopFaultedCountResponse}
3010
+ * @example
3011
+ * ```typescript
3012
+ * import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
3013
+ *
3014
+ * const maestroProcesses = new MaestroProcesses(sdk);
3015
+ *
3016
+ * // Get top processes by faulted count for the last 7 days
3017
+ * const topFailing = await maestroProcesses.getTopFaultedCount(
3018
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
3019
+ * new Date()
3020
+ * );
3021
+ *
3022
+ * for (const process of topFailing) {
3023
+ * console.log(`${process.packageId}: ${process.faultedCount} failures`);
3024
+ * }
3025
+ * ```
3026
+ *
3027
+ * @example
3028
+ * ```typescript
3029
+ * // Get top processes by faulted count for a specific package
3030
+ * const filtered = await maestroProcesses.getTopFaultedCount(
3031
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
3032
+ * new Date(),
3033
+ * { packageId: '<packageId>' }
3034
+ * );
3035
+ * ```
3036
+ */
3037
+ getTopFaultedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopFaultedCountResponse[]>;
3038
+ /**
3039
+ * Get all instances status counts aggregated by date for maestro processes.
3040
+ *
3041
+ * Returns time-grouped counts of instances grouped by status (Completed, Faulted, Cancelled),
3042
+ * useful for rendering time-series charts. Use `groupBy` to control the time bucket size
3043
+ * (hour, day, or week) — defaults to day if not provided.
3044
+ *
3045
+ * @param startTime - Start of the time range to query
3046
+ * @param endTime - End of the time range to query
3047
+ * @param options - Optional settings for time bucketing granularity
3048
+ * @returns Promise resolving to an array of {@link InstanceStatusTimelineResponse}
3049
+ *
3050
+ * @example
3051
+ * ```typescript
3052
+ * // Get daily instance status for the last 7 days
3053
+ * const now = new Date();
3054
+ * const sevenDaysAgo = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
3055
+ * const statuses = await maestroProcesses.getInstanceStatusTimeline(sevenDaysAgo, now);
3056
+ *
3057
+ * for (const entry of statuses) {
3058
+ * console.log(`${entry.startTime} — ${entry.status}: ${entry.count}`);
3059
+ * }
3060
+ * ```
3061
+ *
3062
+ * @example
3063
+ * ```typescript
3064
+ * import { TimeInterval } from '@uipath/uipath-typescript/maestro-processes';
3065
+ *
3066
+ * // Get hourly breakdown
3067
+ * const statuses = await maestroProcesses.getInstanceStatusTimeline(startTime, endTime, {
3068
+ * groupBy: TimeInterval.Hour,
3069
+ * });
3070
+ * ```
3071
+ *
3072
+ * @example
3073
+ * ```typescript
3074
+ * // Get all-time data (from Unix epoch to now)
3075
+ * const allTime = await maestroProcesses.getInstanceStatusTimeline(new Date(0), new Date());
3076
+ * ```
3077
+ */
3078
+ getInstanceStatusTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<InstanceStatusTimelineResponse[]>;
3079
+ /**
3080
+ * Get the top 5 processes ranked by total duration within a time range.
3081
+ *
3082
+ * Returns an array of up to 5 processes sorted by their total execution time,
3083
+ * useful for identifying the longest-running processes in a given period.
3084
+ *
3085
+ * @param startTime - Start of the time range to query
3086
+ * @param endTime - End of the time range to query
3087
+ * @param options - Optional filters (packageId, processKey, version)
3088
+ * @returns Promise resolving to an array of {@link ProcessGetTopDurationResponse}
3089
+ * @example
3090
+ * ```typescript
3091
+ * import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
3092
+ *
3093
+ * const maestroProcesses = new MaestroProcesses(sdk);
3094
+ *
3095
+ * // Get top processes by duration for the last 7 days
3096
+ * const topProcesses = await maestroProcesses.getTopExecutionDuration(
3097
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
3098
+ * new Date()
3099
+ * );
3100
+ *
3101
+ * for (const process of topProcesses) {
3102
+ * console.log(`${process.packageId}: ${process.duration}ms total`);
3103
+ * }
3104
+ * ```
3105
+ *
3106
+ * @example
3107
+ * ```typescript
3108
+ * // Get top processes by duration for a specific package
3109
+ * const filtered = await maestroProcesses.getTopExecutionDuration(
3110
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
3111
+ * new Date(),
3112
+ * { packageId: '<packageId>' }
3113
+ * );
3114
+ * ```
3115
+ */
3116
+ getTopExecutionDuration(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopDurationResponse[]>;
2840
3117
  }
2841
3118
  interface ProcessMethods {
2842
3119
  /**
@@ -3375,6 +3652,7 @@ interface ProcessIncidentsServiceModel {
3375
3652
  * Maestro Cases Types
3376
3653
  * Types and interfaces for Maestro case management
3377
3654
  */
3655
+
3378
3656
  /**
3379
3657
  * Case information with instance statistics
3380
3658
  */
@@ -3414,6 +3692,27 @@ interface CaseGetAllResponse {
3414
3692
  /** Case instance count - canceling */
3415
3693
  cancelingCount: number;
3416
3694
  }
3695
+ /**
3696
+ * Response for a single entry in top cases by run count
3697
+ */
3698
+ interface CaseGetTopRunCountResponse extends GetTopRunCountResponse {
3699
+ /** Human-readable case name */
3700
+ name: string;
3701
+ }
3702
+ /**
3703
+ * Response for a single entry in top cases by failure count
3704
+ */
3705
+ interface CaseGetTopFaultedCountResponse extends GetTopFaultedCountResponse {
3706
+ /** Human-readable case name */
3707
+ name: string;
3708
+ }
3709
+ /**
3710
+ * Response for a single entry in top cases by duration
3711
+ */
3712
+ interface CaseGetTopDurationResponse extends GetTopDurationResponse {
3713
+ /** Human-readable case name */
3714
+ name: string;
3715
+ }
3417
3716
 
3418
3717
  /**
3419
3718
  * Maestro Cases Models
@@ -3454,6 +3753,161 @@ interface CasesServiceModel {
3454
3753
  * ```
3455
3754
  */
3456
3755
  getAll(): Promise<CaseGetAllResponse[]>;
3756
+ /**
3757
+ * Get the top 5 case processes ranked by run count within a time range.
3758
+ *
3759
+ * Returns an array of up to 5 case processes sorted by how many times they were executed,
3760
+ * useful for identifying the most active case processes in a given period.
3761
+ *
3762
+ * @param startTime - Start of the time range to query
3763
+ * @param endTime - End of the time range to query
3764
+ * @param options - Optional filters (packageId, processKey, version)
3765
+ * @returns Promise resolving to an array of {@link CaseGetTopRunCountResponse}
3766
+ * @example
3767
+ * ```typescript
3768
+ * import { Cases } from '@uipath/uipath-typescript/cases';
3769
+ *
3770
+ * const cases = new Cases(sdk);
3771
+ *
3772
+ * // Get top case processes by run count for the last 7 days
3773
+ * const topProcesses = await cases.getTopRunCount(
3774
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
3775
+ * new Date()
3776
+ * );
3777
+ *
3778
+ * for (const process of topProcesses) {
3779
+ * console.log(`${process.packageId}: ${process.runCount} runs`);
3780
+ * }
3781
+ * ```
3782
+ *
3783
+ * @example
3784
+ * ```typescript
3785
+ * // Get top case processes by run count for a specific package
3786
+ * const filtered = await cases.getTopRunCount(
3787
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
3788
+ * new Date(),
3789
+ * { packageId: '<packageId>' }
3790
+ * );
3791
+ * ```
3792
+ */
3793
+ getTopRunCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopRunCountResponse[]>;
3794
+ /**
3795
+ * Get the top 10 case processes ranked by failure count within a time range.
3796
+ *
3797
+ * Returns an array of up to 10 case processes sorted by how many instances faulted,
3798
+ * useful for identifying the most error-prone case processes in a given period.
3799
+ *
3800
+ * @param startTime - Start of the time range to query
3801
+ * @param endTime - End of the time range to query
3802
+ * @param options - Optional filters (packageId, processKey, version)
3803
+ * @returns Promise resolving to an array of {@link CaseGetTopFaultedCountResponse}
3804
+ * @example
3805
+ * ```typescript
3806
+ * import { Cases } from '@uipath/uipath-typescript/cases';
3807
+ *
3808
+ * const cases = new Cases(sdk);
3809
+ *
3810
+ * // Get top case processes by faulted count for the last 7 days
3811
+ * const topFailing = await cases.getTopFaultedCount(
3812
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
3813
+ * new Date()
3814
+ * );
3815
+ *
3816
+ * for (const process of topFailing) {
3817
+ * console.log(`${process.packageId}: ${process.faultedCount} failures`);
3818
+ * }
3819
+ * ```
3820
+ *
3821
+ * @example
3822
+ * ```typescript
3823
+ * // Get top case processes by faulted count for a specific package
3824
+ * const filtered = await cases.getTopFaultedCount(
3825
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
3826
+ * new Date(),
3827
+ * { packageId: '<packageId>' }
3828
+ * );
3829
+ * ```
3830
+ */
3831
+ getTopFaultedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopFaultedCountResponse[]>;
3832
+ /**
3833
+ * Get all instances status counts aggregated by date for case management processes.
3834
+ *
3835
+ * Returns time-grouped counts of case instances grouped by status (Completed, Faulted, Cancelled),
3836
+ * useful for rendering time-series charts. Use `groupBy` to control the time bucket size
3837
+ * (hour, day, or week) — defaults to day if not provided.
3838
+ *
3839
+ * @param startTime - Start of the time range to query
3840
+ * @param endTime - End of the time range to query
3841
+ * @param options - Optional settings for time bucketing granularity
3842
+ * @returns Promise resolving to an array of {@link InstanceStatusTimelineResponse}
3843
+ *
3844
+ * @example
3845
+ * ```typescript
3846
+ * // Get daily instance status for the last 7 days
3847
+ * const now = new Date();
3848
+ * const sevenDaysAgo = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
3849
+ * const statuses = await cases.getInstanceStatusTimeline(sevenDaysAgo, now);
3850
+ *
3851
+ * for (const entry of statuses) {
3852
+ * console.log(`${entry.startTime} — ${entry.status}: ${entry.count}`);
3853
+ * }
3854
+ * ```
3855
+ *
3856
+ * @example
3857
+ * ```typescript
3858
+ * import { TimeInterval } from '@uipath/uipath-typescript/cases';
3859
+ *
3860
+ * // Get weekly breakdown
3861
+ * const statuses = await cases.getInstanceStatusTimeline(startTime, endTime, {
3862
+ * groupBy: TimeInterval.Week,
3863
+ * });
3864
+ * ```
3865
+ *
3866
+ * @example
3867
+ * ```typescript
3868
+ * // Get all-time data (from Unix epoch to now)
3869
+ * const allTime = await cases.getInstanceStatusTimeline(new Date(0), new Date());
3870
+ * ```
3871
+ */
3872
+ getInstanceStatusTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<InstanceStatusTimelineResponse[]>;
3873
+ /**
3874
+ * Get the top 5 case processes ranked by total duration within a time range.
3875
+ *
3876
+ * Returns an array of up to 5 case processes sorted by their total execution time,
3877
+ * useful for identifying the longest-running case processes in a given period.
3878
+ *
3879
+ * @param startTime - Start of the time range to query
3880
+ * @param endTime - End of the time range to query
3881
+ * @param options - Optional filters (packageId, processKey, version)
3882
+ * @returns Promise resolving to an array of {@link CaseGetTopDurationResponse}
3883
+ * @example
3884
+ * ```typescript
3885
+ * import { Cases } from '@uipath/uipath-typescript/cases';
3886
+ *
3887
+ * const cases = new Cases(sdk);
3888
+ *
3889
+ * // Get top case processes by duration for the last 7 days
3890
+ * const topProcesses = await cases.getTopExecutionDuration(
3891
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
3892
+ * new Date()
3893
+ * );
3894
+ *
3895
+ * for (const process of topProcesses) {
3896
+ * console.log(`${process.packageId}: ${process.duration}ms total`);
3897
+ * }
3898
+ * ```
3899
+ *
3900
+ * @example
3901
+ * ```typescript
3902
+ * // Get top case processes by duration for a specific package
3903
+ * const filtered = await cases.getTopExecutionDuration(
3904
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
3905
+ * new Date(),
3906
+ * { packageId: '<packageId>' }
3907
+ * );
3908
+ * ```
3909
+ */
3910
+ getTopExecutionDuration(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopDurationResponse[]>;
3457
3911
  }
3458
3912
 
3459
3913
  /**
@@ -3543,6 +3997,113 @@ interface CaseAppConfig {
3543
3997
  caseSummary?: string;
3544
3998
  overview?: CaseAppOverview[];
3545
3999
  }
4000
+ /**
4001
+ * SLA status for a case instance
4002
+ */
4003
+ declare enum SlaSummaryStatus {
4004
+ /** Case is within SLA deadline */
4005
+ ON_TRACK = "On Track",
4006
+ /** Case is approaching SLA deadline based on at-risk percentage threshold */
4007
+ AT_RISK = "At Risk",
4008
+ /** Case has exceeded SLA deadline */
4009
+ OVERDUE = "Overdue",
4010
+ /** Case instance has completed */
4011
+ COMPLETED = "Completed",
4012
+ /** SLA status cannot be determined (no SLA deadline defined) */
4013
+ UNKNOWN = "Unknown"
4014
+ }
4015
+ /**
4016
+ * Instance status values for case instances and process instances
4017
+ */
4018
+ declare enum InstanceStatus {
4019
+ /** Instance status not yet populated by the backend */
4020
+ UNKNOWN = "",
4021
+ CANCELLED = "Cancelled",
4022
+ CANCELING = "Canceling",
4023
+ COMPLETED = "Completed",
4024
+ FAULTED = "Faulted",
4025
+ PAUSED = "Paused",
4026
+ PAUSING = "Pausing",
4027
+ PENDING = "Pending",
4028
+ RESUMING = "Resuming",
4029
+ RETRYING = "Retrying",
4030
+ RUNNING = "Running",
4031
+ UPGRADING = "Upgrading"
4032
+ }
4033
+ /**
4034
+ * SLA summary response for a single case instance
4035
+ */
4036
+ interface SlaSummaryResponse {
4037
+ /** Unique identifier of the case instance */
4038
+ caseInstanceId: string;
4039
+ /** Folder key that the case instance belongs to */
4040
+ folderKey: string;
4041
+ /** Display name of the SLA rule */
4042
+ name: string;
4043
+ /** Human-readable reference number for a case instance */
4044
+ externalId: string;
4045
+ /** Summary text for the case instance — may be empty */
4046
+ caseSummary: string;
4047
+ /** Unique key of the process associated with the case instance */
4048
+ processKey: string;
4049
+ /** SLA deadline timestamp in UTC (ISO 8601 format) */
4050
+ slaDueTime: string;
4051
+ /** Current SLA status indicating whether the deadline is met, at risk, or breached */
4052
+ slaStatus: SlaSummaryStatus;
4053
+ /** Index of the escalation rule currently applied to the SLA */
4054
+ escalationRuleIndex: string;
4055
+ escalationRuleType: EscalationTriggerType;
4056
+ /** Current status of the case instance */
4057
+ instanceStatus: InstanceStatus;
4058
+ /** Last modification timestamp in UTC (ISO 8601 format) */
4059
+ lastModifiedTime: string;
4060
+ }
4061
+ /**
4062
+ * Options for querying SLA summary
4063
+ */
4064
+ type CaseInstanceSlaSummaryOptions = PaginationOptions & {
4065
+ /** Filter to a specific case instance */
4066
+ caseInstanceId?: string;
4067
+ /** Filter by event start time in UTC */
4068
+ startTimeUtc?: Date;
4069
+ /** Filter by event end time in UTC */
4070
+ endTimeUtc?: Date;
4071
+ };
4072
+ /**
4073
+ * Stage SLA summary for a single stage within a case instance (from Insights RTM)
4074
+ */
4075
+ interface CaseInstanceStageSLAStage {
4076
+ /** Stage element identifier */
4077
+ elementId: string;
4078
+ /** Stage display name */
4079
+ name: string;
4080
+ /** Current execution status of the stage */
4081
+ latestStatus: string;
4082
+ /** SLA deadline timestamp in UTC (e.g. `"9/17/2025 8:35:38 PM"`) or empty string if no SLA is configured */
4083
+ slaDueTime: string;
4084
+ /** SLA status for this stage */
4085
+ slaStatus: SlaSummaryStatus;
4086
+ /** Index of the current escalation rule */
4087
+ escalationRuleIndex: string;
4088
+ /** Type of the current escalation rule */
4089
+ escalationRuleType: EscalationTriggerType;
4090
+ }
4091
+ /**
4092
+ * Stages SLA summary for a single case instance (from Insights RTM)
4093
+ */
4094
+ interface CaseInstanceStageSLAResponse {
4095
+ /** Case instance identifier */
4096
+ caseInstanceId: string;
4097
+ /** Stages within this case instance */
4098
+ stages: CaseInstanceStageSLAStage[];
4099
+ }
4100
+ /**
4101
+ * Options for querying stages SLA summary
4102
+ */
4103
+ interface CaseInstanceStageSLAOptions {
4104
+ /** Filter to a specific case instance */
4105
+ caseInstanceId?: string;
4106
+ }
3546
4107
  /**
3547
4108
  * Case stage task type
3548
4109
  */
@@ -3601,7 +4162,9 @@ interface EscalationAction {
3601
4162
  */
3602
4163
  declare enum EscalationTriggerType {
3603
4164
  SLA_BREACHED = "sla-breached",
3604
- AT_RISK = "at-risk"
4165
+ AT_RISK = "at-risk",
4166
+ /** Default value when no escalation rule is defined */
4167
+ NONE = "None"
3605
4168
  }
3606
4169
  /**
3607
4170
  * Escalation rule trigger metadata
@@ -4264,6 +4827,11 @@ declare function createTaskWithMethods(taskData: RawTaskGetResponse | RawTaskCre
4264
4827
  * const caseInstances = new CaseInstances(sdk);
4265
4828
  * const allInstances = await caseInstances.getAll();
4266
4829
  * ```
4830
+ *
4831
+ * !!! note
4832
+ * Methods that rely on the Insights Real-Time Monitoring service (`getSlaSummary`, `getStagesSlaSummary`)
4833
+ * may have up to ~1 minute latency before reflecting the latest updates. See
4834
+ * [Real-Time Monitoring Overview](https://docs.uipath.com/insights/automation-cloud/latest/user-guide/real-time-monitoring-overview) for details.
4267
4835
  */
4268
4836
  interface CaseInstancesServiceModel {
4269
4837
  /**
@@ -4495,6 +5063,71 @@ interface CaseInstancesServiceModel {
4495
5063
  * ```
4496
5064
  */
4497
5065
  getActionTasks<T extends TaskGetAllOptions = TaskGetAllOptions>(caseInstanceId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<TaskGetResponse> : NonPaginatedResponse<TaskGetResponse>>;
5066
+ /**
5067
+ * Get SLA summary for all case instances across folders.
5068
+ *
5069
+ * Returns SLA status, due times, escalation info, and instance metadata for each case instance.
5070
+ * The default page size is 50, so only the top 50 items are returned when no pagination options are provided.
5071
+ *
5072
+ * @param options - Optional filtering and pagination options
5073
+ * @returns Promise resolving to {@link SlaSummaryResponse}, paginated or non-paginated based on options
5074
+ * @example
5075
+ * ```typescript
5076
+ * // Non-paginated (returns top 50 items by default)
5077
+ * const summary = await caseInstances.getSlaSummary();
5078
+ * console.log(`Found ${summary.totalCount} cases`);
5079
+ *
5080
+ * // Filter by case instance ID
5081
+ * const filtered = await caseInstances.getSlaSummary({
5082
+ * caseInstanceId: '<caseInstanceId>'
5083
+ * });
5084
+ *
5085
+ * // Filter by time range
5086
+ * const timeFiltered = await caseInstances.getSlaSummary({
5087
+ * startTimeUtc: new Date('2026-01-01'),
5088
+ * endTimeUtc: new Date('2026-01-31')
5089
+ * });
5090
+ *
5091
+ * // With pagination
5092
+ * const page1 = await caseInstances.getSlaSummary({ pageSize: 25 });
5093
+ * if (page1.hasNextPage) {
5094
+ * const page2 = await caseInstances.getSlaSummary({ cursor: page1.nextCursor });
5095
+ * }
5096
+ *
5097
+ * // Jump to specific page
5098
+ * const page3 = await caseInstances.getSlaSummary({ jumpToPage: 3, pageSize: 25 });
5099
+ * ```
5100
+ */
5101
+ getSlaSummary<T extends CaseInstanceSlaSummaryOptions = CaseInstanceSlaSummaryOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<SlaSummaryResponse> : NonPaginatedResponse<SlaSummaryResponse>>;
5102
+ /**
5103
+ * Get stages SLA summary for case instances across folders.
5104
+ *
5105
+ * Returns stage-level SLA status and escalation information for each case instance, aggregated from Insights Real-Time Monitoring.
5106
+ *
5107
+ * @param options - Optional filtering options
5108
+ * @returns Promise resolving to an array of {@link CaseInstanceStageSLAResponse}
5109
+ * @example
5110
+ * ```typescript
5111
+ * // Get stages SLA summary for all case instances
5112
+ * const stagesSla = await caseInstances.getStagesSlaSummary();
5113
+ * for (const item of stagesSla) {
5114
+ * console.log(`Instance: ${item.caseInstanceId}`);
5115
+ * for (const stage of item.stages) {
5116
+ * console.log(` Stage: ${stage.name} - SLA Status: ${stage.slaStatus}, Due: ${stage.slaDueTime}`);
5117
+ * }
5118
+ * }
5119
+ *
5120
+ * // Filter by case instance ID
5121
+ * const filtered = await caseInstances.getStagesSlaSummary({
5122
+ * caseInstanceId: '<caseInstanceId>'
5123
+ * });
5124
+ *
5125
+ * // Using bound method on a case instance
5126
+ * const instance = await caseInstances.getById('<instanceId>', '<folderKey>');
5127
+ * const stagesSla = await instance.getStagesSlaSummary();
5128
+ * ```
5129
+ */
5130
+ getStagesSlaSummary(options?: CaseInstanceStageSLAOptions): Promise<CaseInstanceStageSLAResponse[]>;
4498
5131
  }
4499
5132
  interface CaseInstanceMethods {
4500
5133
  /**
@@ -4544,6 +5177,20 @@ interface CaseInstanceMethods {
4544
5177
  * @returns Promise resolving to human in the loop tasks associated with the case instance
4545
5178
  */
4546
5179
  getActionTasks<T extends TaskGetAllOptions = TaskGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<TaskGetResponse> : NonPaginatedResponse<TaskGetResponse>>;
5180
+ /**
5181
+ * Gets the SLA summary for this case instance.
5182
+ * The default page size is 50, so only the top 50 items are returned when no pagination options are provided.
5183
+ *
5184
+ * @param options - Optional time range filtering and pagination options
5185
+ * @returns Promise resolving to SLA summary items for this case instance
5186
+ */
5187
+ getSlaSummary<T extends Omit<CaseInstanceSlaSummaryOptions, 'caseInstanceId'> = Omit<CaseInstanceSlaSummaryOptions, 'caseInstanceId'>>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<SlaSummaryResponse> : NonPaginatedResponse<SlaSummaryResponse>>;
5188
+ /**
5189
+ * Gets the stages SLA summary for this case instance.
5190
+ *
5191
+ * @returns Promise resolving to an array of stage SLA summary items for this case instance
5192
+ */
5193
+ getStagesSlaSummary(): Promise<CaseInstanceStageSLAResponse[]>;
4547
5194
  }
4548
5195
  type CaseInstanceGetResponse = RawCaseInstanceGetResponse & CaseInstanceMethods;
4549
5196
  /**
@@ -4590,6 +5237,161 @@ declare class MaestroProcessesService extends BaseService implements MaestroProc
4590
5237
  * Get incidents for a specific process
4591
5238
  */
4592
5239
  getIncidents(processKey: string, folderKey: string): Promise<ProcessIncidentGetResponse[]>;
5240
+ /**
5241
+ * Get the top 5 processes ranked by run count within a time range.
5242
+ *
5243
+ * Returns an array of up to 5 processes sorted by how many times they were executed,
5244
+ * useful for identifying the most active processes in a given period.
5245
+ *
5246
+ * @param startTime - Start of the time range to query
5247
+ * @param endTime - End of the time range to query
5248
+ * @param options - Optional filters (packageId, processKey, version)
5249
+ * @returns Promise resolving to an array of {@link ProcessGetTopRunCountResponse}
5250
+ * @example
5251
+ * ```typescript
5252
+ * import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
5253
+ *
5254
+ * const maestroProcesses = new MaestroProcesses(sdk);
5255
+ *
5256
+ * // Get top processes by run count for the last 7 days
5257
+ * const topProcesses = await maestroProcesses.getTopRunCount(
5258
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
5259
+ * new Date()
5260
+ * );
5261
+ *
5262
+ * for (const process of topProcesses) {
5263
+ * console.log(`${process.packageId}: ${process.runCount} runs`);
5264
+ * }
5265
+ * ```
5266
+ *
5267
+ * @example
5268
+ * ```typescript
5269
+ * // Get top processes by run count for a specific package
5270
+ * const filtered = await maestroProcesses.getTopRunCount(
5271
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
5272
+ * new Date(),
5273
+ * { packageId: '<packageId>' }
5274
+ * );
5275
+ * ```
5276
+ */
5277
+ getTopRunCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopRunCountResponse[]>;
5278
+ /**
5279
+ * Get all instances status counts aggregated by date for maestro processes.
5280
+ *
5281
+ * Returns time-grouped counts of instances grouped by status (Completed, Faulted, Cancelled),
5282
+ * useful for rendering time-series charts. Use `groupBy` to control the time bucket size
5283
+ * (hour, day, or week) — defaults to day if not provided.
5284
+ *
5285
+ * @param startTime - Start of the time range to query
5286
+ * @param endTime - End of the time range to query
5287
+ * @param options - Optional settings for time bucketing granularity
5288
+ * @returns Promise resolving to an array of {@link InstanceStatusTimelineResponse}
5289
+ *
5290
+ * @example
5291
+ * ```typescript
5292
+ * // Get daily instance status for the last 7 days
5293
+ * const now = new Date();
5294
+ * const sevenDaysAgo = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
5295
+ * const statuses = await maestroProcesses.getInstanceStatusTimeline(sevenDaysAgo, now);
5296
+ *
5297
+ * for (const entry of statuses) {
5298
+ * console.log(`${entry.startTime} — ${entry.status}: ${entry.count}`);
5299
+ * }
5300
+ * ```
5301
+ *
5302
+ * @example
5303
+ * ```typescript
5304
+ * import { TimeInterval } from '@uipath/uipath-typescript/maestro-processes';
5305
+ *
5306
+ * // Get hourly breakdown
5307
+ * const statuses = await maestroProcesses.getInstanceStatusTimeline(startTime, endTime, {
5308
+ * groupBy: TimeInterval.Hour,
5309
+ * });
5310
+ * ```
5311
+ *
5312
+ * @example
5313
+ * ```typescript
5314
+ * // Get all-time data (from Unix epoch to now)
5315
+ * const allTime = await maestroProcesses.getInstanceStatusTimeline(new Date(0), new Date());
5316
+ * ```
5317
+ */
5318
+ getInstanceStatusTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<InstanceStatusTimelineResponse[]>;
5319
+ /**
5320
+ * Get the top 10 processes ranked by failure count within a time range.
5321
+ *
5322
+ * Returns an array of up to 10 processes sorted by how many instances faulted,
5323
+ * useful for identifying the most error-prone processes in a given period.
5324
+ *
5325
+ * @param startTime - Start of the time range to query
5326
+ * @param endTime - End of the time range to query
5327
+ * @param options - Optional filters (packageId, processKey, version)
5328
+ * @returns Promise resolving to an array of {@link ProcessGetTopFaultedCountResponse}
5329
+ * @example
5330
+ * ```typescript
5331
+ * import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
5332
+ *
5333
+ * const maestroProcesses = new MaestroProcesses(sdk);
5334
+ *
5335
+ * // Get top processes by faulted count for the last 7 days
5336
+ * const topFailing = await maestroProcesses.getTopFaultedCount(
5337
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
5338
+ * new Date()
5339
+ * );
5340
+ *
5341
+ * for (const process of topFailing) {
5342
+ * console.log(`${process.packageId}: ${process.faultedCount} failures`);
5343
+ * }
5344
+ * ```
5345
+ *
5346
+ * @example
5347
+ * ```typescript
5348
+ * // Get top processes by faulted count for a specific package
5349
+ * const filtered = await maestroProcesses.getTopFaultedCount(
5350
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
5351
+ * new Date(),
5352
+ * { packageId: '<packageId>' }
5353
+ * );
5354
+ * ```
5355
+ */
5356
+ getTopFaultedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopFaultedCountResponse[]>;
5357
+ /**
5358
+ * Get the top 5 processes ranked by total duration within a time range.
5359
+ *
5360
+ * Returns an array of up to 5 processes sorted by their total execution time,
5361
+ * useful for identifying the longest-running processes in a given period.
5362
+ *
5363
+ * @param startTime - Start of the time range to query
5364
+ * @param endTime - End of the time range to query
5365
+ * @param options - Optional filters (packageId, processKey, version)
5366
+ * @returns Promise resolving to an array of {@link ProcessGetTopDurationResponse}
5367
+ * @example
5368
+ * ```typescript
5369
+ * import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
5370
+ *
5371
+ * const maestroProcesses = new MaestroProcesses(sdk);
5372
+ *
5373
+ * // Get top processes by duration for the last 7 days
5374
+ * const topProcesses = await maestroProcesses.getTopExecutionDuration(
5375
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
5376
+ * new Date()
5377
+ * );
5378
+ *
5379
+ * for (const process of topProcesses) {
5380
+ * console.log(`${process.packageId}: ${process.duration}ms total`);
5381
+ * }
5382
+ * ```
5383
+ *
5384
+ * @example
5385
+ * ```typescript
5386
+ * // Get top processes by duration for a specific package
5387
+ * const filtered = await maestroProcesses.getTopExecutionDuration(
5388
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
5389
+ * new Date(),
5390
+ * { packageId: '<packageId>' }
5391
+ * );
5392
+ * ```
5393
+ */
5394
+ getTopExecutionDuration(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopDurationResponse[]>;
4593
5395
  }
4594
5396
 
4595
5397
  declare class ProcessInstancesService extends BaseService implements ProcessInstancesServiceModel {
@@ -4769,6 +5571,161 @@ declare class CasesService extends BaseService implements CasesServiceModel {
4769
5571
  * ```
4770
5572
  */
4771
5573
  getAll(): Promise<CaseGetAllResponse[]>;
5574
+ /**
5575
+ * Get the top 5 case processes ranked by run count within a time range.
5576
+ *
5577
+ * Returns an array of up to 5 case processes sorted by how many times they were executed,
5578
+ * useful for identifying the most active case processes in a given period.
5579
+ *
5580
+ * @param startTime - Start of the time range to query
5581
+ * @param endTime - End of the time range to query
5582
+ * @param options - Optional filters (packageId, processKey, version)
5583
+ * @returns Promise resolving to an array of {@link CaseGetTopRunCountResponse}
5584
+ * @example
5585
+ * ```typescript
5586
+ * import { Cases } from '@uipath/uipath-typescript/cases';
5587
+ *
5588
+ * const cases = new Cases(sdk);
5589
+ *
5590
+ * // Get top case processes by run count for the last 7 days
5591
+ * const topProcesses = await cases.getTopRunCount(
5592
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
5593
+ * new Date()
5594
+ * );
5595
+ *
5596
+ * for (const process of topProcesses) {
5597
+ * console.log(`${process.packageId}: ${process.runCount} runs`);
5598
+ * }
5599
+ * ```
5600
+ *
5601
+ * @example
5602
+ * ```typescript
5603
+ * // Get top case processes by run count for a specific package
5604
+ * const filtered = await cases.getTopRunCount(
5605
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
5606
+ * new Date(),
5607
+ * { packageId: '<packageId>' }
5608
+ * );
5609
+ * ```
5610
+ */
5611
+ getTopRunCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopRunCountResponse[]>;
5612
+ /**
5613
+ * Get all instances status counts aggregated by date for case management processes.
5614
+ *
5615
+ * Returns time-grouped counts of case instances grouped by status (Completed, Faulted, Cancelled),
5616
+ * useful for rendering time-series charts. Use `groupBy` to control the time bucket size
5617
+ * (hour, day, or week) — defaults to day if not provided.
5618
+ *
5619
+ * @param startTime - Start of the time range to query
5620
+ * @param endTime - End of the time range to query
5621
+ * @param options - Optional settings for time bucketing granularity
5622
+ * @returns Promise resolving to an array of {@link InstanceStatusTimelineResponse}
5623
+ *
5624
+ * @example
5625
+ * ```typescript
5626
+ * // Get daily instance status for the last 7 days
5627
+ * const now = new Date();
5628
+ * const sevenDaysAgo = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
5629
+ * const statuses = await cases.getInstanceStatusTimeline(sevenDaysAgo, now);
5630
+ *
5631
+ * for (const entry of statuses) {
5632
+ * console.log(`${entry.startTime} — ${entry.status}: ${entry.count}`);
5633
+ * }
5634
+ * ```
5635
+ *
5636
+ * @example
5637
+ * ```typescript
5638
+ * import { TimeInterval } from '@uipath/uipath-typescript/cases';
5639
+ *
5640
+ * // Get weekly breakdown
5641
+ * const statuses = await cases.getInstanceStatusTimeline(startTime, endTime, {
5642
+ * groupBy: TimeInterval.Week,
5643
+ * });
5644
+ * ```
5645
+ *
5646
+ * @example
5647
+ * ```typescript
5648
+ * // Get all-time data (from Unix epoch to now)
5649
+ * const allTime = await cases.getInstanceStatusTimeline(new Date(0), new Date());
5650
+ * ```
5651
+ */
5652
+ getInstanceStatusTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<InstanceStatusTimelineResponse[]>;
5653
+ /**
5654
+ * Get the top 10 case processes ranked by failure count within a time range.
5655
+ *
5656
+ * Returns an array of up to 10 case processes sorted by how many instances faulted,
5657
+ * useful for identifying the most error-prone case processes in a given period.
5658
+ *
5659
+ * @param startTime - Start of the time range to query
5660
+ * @param endTime - End of the time range to query
5661
+ * @param options - Optional filters (packageId, processKey, version)
5662
+ * @returns Promise resolving to an array of {@link CaseGetTopFaultedCountResponse}
5663
+ * @example
5664
+ * ```typescript
5665
+ * import { Cases } from '@uipath/uipath-typescript/cases';
5666
+ *
5667
+ * const cases = new Cases(sdk);
5668
+ *
5669
+ * // Get top case processes by faulted count for the last 7 days
5670
+ * const topFailing = await cases.getTopFaultedCount(
5671
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
5672
+ * new Date()
5673
+ * );
5674
+ *
5675
+ * for (const process of topFailing) {
5676
+ * console.log(`${process.packageId}: ${process.faultedCount} failures`);
5677
+ * }
5678
+ * ```
5679
+ *
5680
+ * @example
5681
+ * ```typescript
5682
+ * // Get top case processes by faulted count for a specific package
5683
+ * const filtered = await cases.getTopFaultedCount(
5684
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
5685
+ * new Date(),
5686
+ * { packageId: '<packageId>' }
5687
+ * );
5688
+ * ```
5689
+ */
5690
+ getTopFaultedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopFaultedCountResponse[]>;
5691
+ /**
5692
+ * Get the top 5 case processes ranked by total duration within a time range.
5693
+ *
5694
+ * Returns an array of up to 5 case processes sorted by their total execution time,
5695
+ * useful for identifying the longest-running case processes in a given period.
5696
+ *
5697
+ * @param startTime - Start of the time range to query
5698
+ * @param endTime - End of the time range to query
5699
+ * @param options - Optional filters (packageId, processKey, version)
5700
+ * @returns Promise resolving to an array of {@link CaseGetTopDurationResponse}
5701
+ * @example
5702
+ * ```typescript
5703
+ * import { Cases } from '@uipath/uipath-typescript/cases';
5704
+ *
5705
+ * const cases = new Cases(sdk);
5706
+ *
5707
+ * // Get top case processes by duration for the last 7 days
5708
+ * const topProcesses = await cases.getTopExecutionDuration(
5709
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
5710
+ * new Date()
5711
+ * );
5712
+ *
5713
+ * for (const process of topProcesses) {
5714
+ * console.log(`${process.packageId}: ${process.duration}ms total`);
5715
+ * }
5716
+ * ```
5717
+ *
5718
+ * @example
5719
+ * ```typescript
5720
+ * // Get top case processes by duration for a specific package
5721
+ * const filtered = await cases.getTopExecutionDuration(
5722
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
5723
+ * new Date(),
5724
+ * { packageId: '<packageId>' }
5725
+ * );
5726
+ * ```
5727
+ */
5728
+ getTopExecutionDuration(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopDurationResponse[]>;
4772
5729
  /**
4773
5730
  * Extract a readable case name from the packageId
4774
5731
  * @param packageId - The full package identifier
@@ -4959,6 +5916,71 @@ declare class CaseInstancesService extends BaseService implements CaseInstancesS
4959
5916
  * @returns Promise resolving to human in the loop tasks associated with the case instance
4960
5917
  */
4961
5918
  getActionTasks<T extends TaskGetAllOptions = TaskGetAllOptions>(caseInstanceId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<TaskGetResponse> : NonPaginatedResponse<TaskGetResponse>>;
5919
+ /**
5920
+ * Get SLA summary for all case instances across folders.
5921
+ *
5922
+ * Returns SLA status, due times, escalation info, and instance metadata for each case instance.
5923
+ * The default page size is 50, so only the top 50 items are returned when no pagination options are provided.
5924
+ *
5925
+ * @param options - Optional filtering and pagination options
5926
+ * @returns Promise resolving to {@link SlaSummaryResponse}, paginated or non-paginated based on options
5927
+ * @example
5928
+ * ```typescript
5929
+ * // Non-paginated (returns top 50 items by default)
5930
+ * const summary = await caseInstances.getSlaSummary();
5931
+ * console.log(`Found ${summary.totalCount} cases`);
5932
+ *
5933
+ * // Filter by case instance ID
5934
+ * const filtered = await caseInstances.getSlaSummary({
5935
+ * caseInstanceId: '<caseInstanceId>'
5936
+ * });
5937
+ *
5938
+ * // Filter by time range
5939
+ * const timeFiltered = await caseInstances.getSlaSummary({
5940
+ * startTimeUtc: new Date('2026-01-01'),
5941
+ * endTimeUtc: new Date('2026-01-31')
5942
+ * });
5943
+ *
5944
+ * // With pagination
5945
+ * const page1 = await caseInstances.getSlaSummary({ pageSize: 25 });
5946
+ * if (page1.hasNextPage) {
5947
+ * const page2 = await caseInstances.getSlaSummary({ cursor: page1.nextCursor });
5948
+ * }
5949
+ *
5950
+ * // Jump to specific page
5951
+ * const page3 = await caseInstances.getSlaSummary({ jumpToPage: 3, pageSize: 25 });
5952
+ * ```
5953
+ */
5954
+ getSlaSummary<T extends CaseInstanceSlaSummaryOptions = CaseInstanceSlaSummaryOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<SlaSummaryResponse> : NonPaginatedResponse<SlaSummaryResponse>>;
5955
+ /**
5956
+ * Get stages SLA summary for case instances across folders.
5957
+ *
5958
+ * Returns stage-level SLA status and escalation information for each case instance, aggregated from Insights Real-Time Monitoring.
5959
+ *
5960
+ * @param options - Optional filtering options
5961
+ * @returns Promise resolving to an array of {@link CaseInstanceStageSLAResponse}
5962
+ * @example
5963
+ * ```typescript
5964
+ * // Get stages SLA summary for all case instances
5965
+ * const stagesSla = await caseInstances.getStagesSlaSummary();
5966
+ * for (const item of stagesSla) {
5967
+ * console.log(`Instance: ${item.caseInstanceId}`);
5968
+ * for (const stage of item.stages) {
5969
+ * console.log(` Stage: ${stage.name} - SLA Status: ${stage.slaStatus}, Due: ${stage.slaDueTime}`);
5970
+ * }
5971
+ * }
5972
+ *
5973
+ * // Filter by case instance ID
5974
+ * const filtered = await caseInstances.getStagesSlaSummary({
5975
+ * caseInstanceId: '<caseInstanceId>'
5976
+ * });
5977
+ *
5978
+ * // Using bound method on a case instance
5979
+ * const instance = await caseInstances.getById('<instanceId>', '<folderKey>');
5980
+ * const stagesSla = await instance.getStagesSlaSummary();
5981
+ * ```
5982
+ */
5983
+ getStagesSlaSummary(options?: CaseInstanceStageSLAOptions): Promise<CaseInstanceStageSLAResponse[]>;
4962
5984
  }
4963
5985
 
4964
5986
  /**
@@ -5273,6 +6295,11 @@ type BucketGetAllOptions = RequestOptions & PaginationOptions & {
5273
6295
  };
5274
6296
  interface BucketGetByIdOptions extends BaseOptions {
5275
6297
  }
6298
+ /**
6299
+ * Options for getting a single bucket by name
6300
+ */
6301
+ interface BucketGetByNameOptions extends FolderScopedOptions {
6302
+ }
5276
6303
  /**
5277
6304
  * Maps header names to their values
5278
6305
  *
@@ -5478,11 +6505,31 @@ interface BucketServiceModel {
5478
6505
  * {@link BucketGetResponse}
5479
6506
  * @example
5480
6507
  * ```typescript
5481
- * // Get bucket by ID
5482
- * const bucket = await buckets.getById(<bucketId>, <folderId>);
6508
+ * // Get bucket by ID
6509
+ * const bucket = await buckets.getById(<bucketId>, <folderId>);
6510
+ * ```
6511
+ */
6512
+ getById(bucketId: number, folderId: number, options?: BucketGetByIdOptions): Promise<BucketGetResponse>;
6513
+ /**
6514
+ * Retrieves a single orchestrator storage bucket by name.
6515
+ *
6516
+ * @param name - Bucket name to search for
6517
+ * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
6518
+ * @returns Promise resolving to a single bucket
6519
+ * {@link BucketGetResponse}
6520
+ * @example
6521
+ * ```typescript
6522
+ * // By folder ID
6523
+ * await buckets.getByName('MyBucket', { folderId: <folderId> });
6524
+ *
6525
+ * // By folder key (GUID)
6526
+ * await buckets.getByName('MyBucket', { folderKey: '<folderKey>' });
6527
+ *
6528
+ * // By folder path
6529
+ * await buckets.getByName('MyBucket', { folderPath: '<folderPath>' });
5483
6530
  * ```
5484
6531
  */
5485
- getById(bucketId: number, folderId: number, options?: BucketGetByIdOptions): Promise<BucketGetResponse>;
6532
+ getByName(name: string, options?: BucketGetByNameOptions): Promise<BucketGetResponse>;
5486
6533
  /**
5487
6534
  * Gets metadata for files in a bucket with optional filtering and pagination
5488
6535
  *
@@ -5581,6 +6628,30 @@ declare class BucketService extends FolderScopedService implements BucketService
5581
6628
  * ```
5582
6629
  */
5583
6630
  getById(id: number, folderId: number, options?: BucketGetByIdOptions): Promise<BucketGetResponse>;
6631
+ /**
6632
+ * Retrieves a single orchestrator storage bucket by name.
6633
+ *
6634
+ * @param name - Bucket name to search for
6635
+ * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
6636
+ * @returns Promise resolving to a single bucket
6637
+ * {@link BucketGetResponse}
6638
+ * @example
6639
+ * ```typescript
6640
+ * import { Buckets } from '@uipath/uipath-typescript/buckets';
6641
+ *
6642
+ * const buckets = new Buckets(sdk);
6643
+ *
6644
+ * // By folder ID
6645
+ * await buckets.getByName('MyBucket', { folderId: <folderId> });
6646
+ *
6647
+ * // By folder key (GUID)
6648
+ * await buckets.getByName('MyBucket', { folderKey: '<folderKey>' });
6649
+ *
6650
+ * // By folder path
6651
+ * await buckets.getByName('MyBucket', { folderPath: '<folderPath>' });
6652
+ * ```
6653
+ */
6654
+ getByName(name: string, options?: BucketGetByNameOptions): Promise<BucketGetResponse>;
5584
6655
  /**
5585
6656
  * Gets all buckets across folders with optional filtering and folder scoping
5586
6657
  *
@@ -7436,6 +8507,15 @@ declare function loadFromMetaTags(): MetaTagConfig | null;
7436
8507
  declare const ConversationMap: {
7437
8508
  [key: string]: string;
7438
8509
  };
8510
+ /**
8511
+ * Maps API filter param names (left) to SDK-facing names (right) for the conversation list endpoint.
8512
+ * Used by `getAll` to translate SDK filters to the field names the backend expects. Kept separate
8513
+ * from `ConversationMap` because `label`/`search` would otherwise collide with the `label` field
8514
+ * on create/update payloads.
8515
+ */
8516
+ declare const ConversationGetAllFilterMap: {
8517
+ [key: string]: string;
8518
+ };
7439
8519
  /**
7440
8520
  * Maps fields for Exchange entity to ensure consistent SDK naming
7441
8521
  */
@@ -11024,8 +12104,12 @@ interface ConversationServiceModel {
11024
12104
  /**
11025
12105
  * Gets all conversations with optional filtering and pagination
11026
12106
  *
12107
+ * The method returns either:
12108
+ * - A NonPaginatedResponse with items array (when no pagination parameters are provided)
12109
+ * - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
12110
+ *
11027
12111
  * @param options - Options for querying conversations including optional pagination parameters
11028
- * @returns Promise resolving to either an array of conversations NonPaginatedResponse<ConversationGetResponse> or a PaginatedResponse<ConversationGetResponse> when pagination options are used
12112
+ * @returns Promise resolving to either an array of conversations {@link NonPaginatedResponse}<{@link ConversationGetResponse}> or a {@link PaginatedResponse}<{@link ConversationGetResponse}> when pagination options are used
11029
12113
  *
11030
12114
  * @example Basic usage - get all conversations
11031
12115
  * ```typescript
@@ -11056,6 +12140,14 @@ interface ConversationServiceModel {
11056
12140
  * pageSize: 20
11057
12141
  * });
11058
12142
  * ```
12143
+ *
12144
+ * @example Filter by agent and search by label
12145
+ * ```typescript
12146
+ * const filtered = await conversationalAgent.conversations.getAll({
12147
+ * agentId: <agentId>,
12148
+ * label: 'budget'
12149
+ * });
12150
+ * ```
11059
12151
  */
11060
12152
  getAll<T extends ConversationGetAllOptions = ConversationGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ConversationGetResponse> : NonPaginatedResponse<ConversationGetResponse>>;
11061
12153
  /**
@@ -11448,6 +12540,14 @@ interface ConversationUpdateOptions {
11448
12540
  type ConversationGetAllOptions = PaginationOptions & {
11449
12541
  /** Sort order for conversations */
11450
12542
  sort?: SortOrder;
12543
+ /** GUID key of the agent to filter conversations by. */
12544
+ agentKey?: string;
12545
+ /** Numeric ID of the agent to filter conversations by. */
12546
+ agentId?: number;
12547
+ /**
12548
+ * Case-insensitive substring filter applied to conversation labels (1–100 chars).
12549
+ */
12550
+ label?: string;
11451
12551
  };
11452
12552
  /**
11453
12553
  * File upload access details for uploading file content to blob storage
@@ -11593,8 +12693,10 @@ interface RawAgentGetResponse {
11593
12693
  description: string;
11594
12694
  /** Process version */
11595
12695
  processVersion: string;
11596
- /** Process key identifier */
12696
+ /** Process key identifier (a dotted-path string like `Solution.Package.Agent`) */
11597
12697
  processKey: string;
12698
+ /** GUID key of the agent release */
12699
+ releaseKey?: string;
11598
12700
  /** Folder ID */
11599
12701
  folderId: number;
11600
12702
  /** Feed ID */
@@ -12042,6 +13144,7 @@ interface ConversationalAgentOptions {
12042
13144
  /**
12043
13145
  * Represents a category that can be associated with feedback.
12044
13146
  * Default categories (Output, Agent Error, Agent Plan Execution) are auto-created per tenant.
13147
+ * Used as nested objects inside {@link FeedbackResponse}.
12045
13148
  */
12046
13149
  interface FeedbackCategory {
12047
13150
  /** Unique identifier of the feedback category */
@@ -12057,6 +13160,24 @@ interface FeedbackCategory {
12057
13160
  /** Whether this category applies to negative feedback */
12058
13161
  isNegative: boolean;
12059
13162
  }
13163
+ /**
13164
+ * A feedback category returned by {@link FeedbackServiceModel.getCategories}, {@link FeedbackServiceModel.createCategory}.
13165
+ * Fields are transformed to camelCase SDK conventions (createdAt → createdTime).
13166
+ */
13167
+ interface FeedbackCategoryResponse {
13168
+ /** Unique identifier of the feedback category */
13169
+ id: string;
13170
+ /** Category name (max 256 characters, unique per tenant) */
13171
+ category: string;
13172
+ /** Timestamp when the category was created */
13173
+ createdTime: string;
13174
+ /** Whether this is a system default category (e.g., Output, Agent Error, Agent Plan Execution) */
13175
+ isDefault: boolean;
13176
+ /** Whether this category applies to positive feedback */
13177
+ isPositive: boolean;
13178
+ /** Whether this category applies to negative feedback */
13179
+ isNegative: boolean;
13180
+ }
12060
13181
  /**
12061
13182
  * Status of a feedback entry in the review workflow
12062
13183
  */
@@ -12071,7 +13192,7 @@ declare enum FeedbackStatus {
12071
13192
  /**
12072
13193
  * Complete feedback object returned from the API
12073
13194
  */
12074
- interface FeedbackGetResponse {
13195
+ interface FeedbackResponse {
12075
13196
  /** Unique identifier of the feedback entry */
12076
13197
  id: string;
12077
13198
  /** Trace identifier linking feedback to a specific agent execution */
@@ -12101,6 +13222,12 @@ interface FeedbackGetResponse {
12101
13222
  /** Timestamp when the feedback was last updated */
12102
13223
  updatedTime: string;
12103
13224
  }
13225
+ /**
13226
+ * Feedback object returned by getAll and getById.
13227
+ * Extends {@link FeedbackResponse} — use this type for getAll/getById return values.
13228
+ */
13229
+ interface FeedbackGetResponse extends FeedbackResponse {
13230
+ }
12104
13231
  /**
12105
13232
  * Options shared across feedback operations
12106
13233
  */
@@ -12108,6 +13235,45 @@ interface FeedbackOptions {
12108
13235
  /** Folder key for authorization */
12109
13236
  folderKey: string;
12110
13237
  }
13238
+ /**
13239
+ * A category reference used when creating or updating feedback
13240
+ */
13241
+ interface FeedbackCategoryInput {
13242
+ /** Unique identifier of the category */
13243
+ id: string;
13244
+ /** Category name (e.g., 'Output', 'Agent Error', 'Agent Plan Execution') */
13245
+ category: string;
13246
+ }
13247
+ /**
13248
+ * Options for submitting a new feedback entry
13249
+ */
13250
+ interface FeedbackSubmitOptions extends FeedbackOptions {
13251
+ /** Span identifier representing a specific operation within the trace */
13252
+ spanId?: string;
13253
+ /** Identifier of the agent that generated the response being reviewed */
13254
+ agentId?: string;
13255
+ /** Version of the agent at the time the feedback was given (max 100 characters) */
13256
+ agentVersion?: string;
13257
+ /** Span type (e.g., 'agentRun', 'llm', 'tool', 'retriever') (max 100 characters) */
13258
+ spanType?: string;
13259
+ /** Optional text comment provided by the user (max 4000 characters) */
13260
+ comment?: string;
13261
+ /** Optional metadata string associated with the feedback (max 4000 characters) */
13262
+ metadata?: string;
13263
+ /** Categories to associate with this feedback entry */
13264
+ categories?: FeedbackCategoryInput[];
13265
+ }
13266
+ /**
13267
+ * Options for updating an existing feedback entry
13268
+ */
13269
+ interface FeedbackUpdateOptions extends FeedbackOptions {
13270
+ /** Optional text comment provided by the user (max 4000 characters) */
13271
+ comment?: string;
13272
+ /** Optional metadata string associated with the feedback (max 4000 characters) */
13273
+ metadata?: string;
13274
+ /** Categories to associate with this feedback entry */
13275
+ categories?: FeedbackCategoryInput[];
13276
+ }
12111
13277
  /**
12112
13278
  * Options for retrieving multiple feedback entries
12113
13279
  */
@@ -12123,6 +13289,32 @@ type FeedbackGetAllOptions = PaginationOptions & {
12123
13289
  /** Filter by OpenTelemetry span identifier */
12124
13290
  spanId?: string;
12125
13291
  };
13292
+ /**
13293
+ * Options for creating a new feedback category
13294
+ */
13295
+ interface FeedbackCreateCategoryOptions {
13296
+ /** Whether the category applies to positive feedback (defaults to true) */
13297
+ isPositive?: boolean;
13298
+ /** Whether the category applies to negative feedback (defaults to true) */
13299
+ isNegative?: boolean;
13300
+ }
13301
+ /**
13302
+ * Options for deleting a feedback category.
13303
+ * Note: system default categories (Output, Agent Error, Agent Plan Execution) cannot be deleted — attempting to do so returns a 409 Conflict.
13304
+ */
13305
+ interface FeedbackDeleteCategoryOptions {
13306
+ /** When true, deletes the category even if it has associated feedback entries */
13307
+ forceDelete?: boolean;
13308
+ }
13309
+ /**
13310
+ * Options for retrieving feedback categories
13311
+ */
13312
+ type FeedbackGetCategoriesOptions = PaginationOptions & {
13313
+ /** Filter by whether the category applies to positive feedback */
13314
+ isPositive?: boolean;
13315
+ /** Filter by whether the category applies to negative feedback */
13316
+ isNegative?: boolean;
13317
+ };
12126
13318
 
12127
13319
  /**
12128
13320
  * Service for managing UiPath Agent Feedback.
@@ -12148,10 +13340,10 @@ interface FeedbackServiceModel {
12148
13340
  * Gets all feedback across all agents in the tenant, with optional filters.
12149
13341
  *
12150
13342
  * Retrieves a list of feedback entries, optionally filtered by agent, trace, span, status, or agent version.
12151
- * When no pagination options are provided, the API returns up to 100 items. When pagination options are provided without a pageSize, the SDK defaults to 50 items per page.
13343
+ * When no pagination options are provided, the SDK returns up to 100 items. When pagination options are provided without a pageSize, the SDK defaults to 50 items per page.
12152
13344
  *
12153
13345
  * @param options - Optional query parameters for filtering and pagination
12154
- * @returns Promise resolving to {@link NonPaginatedResponse} of {@link FeedbackGetResponse} without pagination options, or {@link PaginatedResponse} of {@link FeedbackGetResponse} when pagination options are used.
13346
+ * @returns Promise resolving to {@link NonPaginatedResponse} of {@link FeedbackResponse} without pagination options, or {@link PaginatedResponse} of {@link FeedbackResponse} when pagination options are used.
12155
13347
  * @example
12156
13348
  * ```typescript
12157
13349
  * import { Feedback, FeedbackStatus } from '@uipath/uipath-typescript/feedback';
@@ -12181,13 +13373,13 @@ interface FeedbackServiceModel {
12181
13373
  * });
12182
13374
  * ```
12183
13375
  */
12184
- getAll<T extends FeedbackGetAllOptions = FeedbackGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<FeedbackGetResponse> : NonPaginatedResponse<FeedbackGetResponse>>;
13376
+ getAll<T extends FeedbackGetAllOptions = FeedbackGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<FeedbackResponse> : NonPaginatedResponse<FeedbackResponse>>;
12185
13377
  /**
12186
13378
  * Gets a single feedback entry by its feedback ID.
12187
13379
  *
12188
13380
  * @param id - Feedback ID (GUID) of the feedback entry
12189
13381
  * @param options - Required options including folderKey for folder-level authorization {@link FeedbackOptions}
12190
- * @returns Promise resolving to {@link FeedbackGetResponse}
13382
+ * @returns Promise resolving to {@link FeedbackResponse}
12191
13383
  * @example
12192
13384
  * ```typescript
12193
13385
  * import { Feedback } from '@uipath/uipath-typescript/feedback';
@@ -12198,11 +13390,169 @@ interface FeedbackServiceModel {
12198
13390
  * const allFeedback = await feedback.getAll({ pageSize: 10 });
12199
13391
  * const feedbackId = allFeedback.items[0].id;
12200
13392
  * const folderKey = allFeedback.items[0].folderKey;
13393
+ *
12201
13394
  * const item = await feedback.getById(feedbackId, { folderKey });
12202
13395
  * console.log(item.isPositive, item.comment, item.status);
12203
13396
  * ```
12204
13397
  */
12205
- getById(id: string, options: FeedbackOptions): Promise<FeedbackGetResponse>;
13398
+ getById(id: string, options: FeedbackOptions): Promise<FeedbackResponse>;
13399
+ /**
13400
+ * Submits a feedback entry.
13401
+ *
13402
+ * @param traceId - Trace identifier linking feedback to a specific agent execution
13403
+ * @param isPositive - Whether the feedback is positive (thumbs up) or negative (thumbs down)
13404
+ * @param options - Additional feedback data and folderKey for authorization {@link FeedbackSubmitOptions}
13405
+ * @returns Promise resolving to the submitted {@link FeedbackResponse}
13406
+ * @example
13407
+ * ```typescript
13408
+ * import { Feedback } from '@uipath/uipath-typescript/feedback';
13409
+ *
13410
+ * const feedback = new Feedback(sdk);
13411
+ *
13412
+ * // Obtain traceId and folderKey from an existing feedback entry
13413
+ * const allFeedback = await feedback.getAll({ pageSize: 1 });
13414
+ * const traceId = allFeedback.items[0].traceId;
13415
+ * const folderKey = allFeedback.items[0].folderKey!;
13416
+ *
13417
+ * const item = await feedback.submit(traceId, true, { folderKey });
13418
+ * console.log(item.id, item.status);
13419
+ * ```
13420
+ */
13421
+ submit(traceId: string, isPositive: boolean, options: FeedbackSubmitOptions): Promise<FeedbackResponse>;
13422
+ /**
13423
+ * Updates already submitted feedback.
13424
+ *
13425
+ * @param id - Feedback ID (GUID) of the entry to update
13426
+ * @param isPositive - Whether the feedback is positive (thumbs up) or negative (thumbs down)
13427
+ * @param options - Updated feedback data and folderKey for authorization {@link FeedbackUpdateOptions}
13428
+ * @returns Promise resolving to the updated {@link FeedbackResponse}
13429
+ * @example
13430
+ * ```typescript
13431
+ * import { Feedback } from '@uipath/uipath-typescript/feedback';
13432
+ *
13433
+ * const feedback = new Feedback(sdk);
13434
+ *
13435
+ * const allFeedback = await feedback.getAll({ pageSize: 1 });
13436
+ * const feedbackId = allFeedback.items[0].id;
13437
+ * const folderKey = allFeedback.items[0].folderKey!;
13438
+ *
13439
+ * const updated = await feedback.updateById(feedbackId, false, {
13440
+ * comment: 'On reflection, not great.',
13441
+ * folderKey,
13442
+ * });
13443
+ * console.log(updated.isPositive, updated.comment);
13444
+ * ```
13445
+ */
13446
+ updateById(id: string, isPositive: boolean, options: FeedbackUpdateOptions): Promise<FeedbackResponse>;
13447
+ /**
13448
+ * Deletes a feedback entry by its ID.
13449
+ *
13450
+ * @param id - Feedback ID (GUID) of the entry to delete
13451
+ * @param options - Required options including folderKey for folder-level authorization {@link FeedbackOptions}
13452
+ * @returns Promise resolving to void on success
13453
+ * @example
13454
+ * ```typescript
13455
+ * import { Feedback } from '@uipath/uipath-typescript/feedback';
13456
+ *
13457
+ * const feedback = new Feedback(sdk);
13458
+ *
13459
+ * const allFeedback = await feedback.getAll({ pageSize: 1 });
13460
+ * const feedbackId = allFeedback.items[0].id;
13461
+ * const folderKey = allFeedback.items[0].folderKey!;
13462
+ *
13463
+ * await feedback.deleteById(feedbackId, { folderKey });
13464
+ * ```
13465
+ */
13466
+ deleteById(id: string, options: FeedbackOptions): Promise<void>;
13467
+ /**
13468
+ * Creates a new feedback category.
13469
+ *
13470
+ * Custom categories can be used to label feedback entries beyond the default system categories.
13471
+ * Once created, reference the category by its `id` when submitting or updating feedback.
13472
+ * If `isPositive` and `isNegative` are omitted, the backend defaults both to `true`.
13473
+ *
13474
+ * @param category - Name of the category to create (max 256 characters, unique per tenant)
13475
+ * @param options - Optional flags controlling whether the category applies to positive and/or negative feedback {@link FeedbackCreateCategoryOptions}
13476
+ * @returns Promise resolving to the created {@link FeedbackCategoryResponse}
13477
+ * @example
13478
+ * ```typescript
13479
+ * import { Feedback } from '@uipath/uipath-typescript/feedback';
13480
+ *
13481
+ * const feedback = new Feedback(sdk);
13482
+ *
13483
+ * // Minimum — applies to both positive and negative feedback by default
13484
+ * const category = await feedback.createCategory('Hallucination');
13485
+ * console.log(category.id, category.category);
13486
+ *
13487
+ * // With explicit flags
13488
+ * const negativeOnly = await feedback.createCategory('Off-topic', {
13489
+ * isPositive: false,
13490
+ * isNegative: true,
13491
+ * });
13492
+ * ```
13493
+ */
13494
+ createCategory(category: string, options?: FeedbackCreateCategoryOptions): Promise<FeedbackCategoryResponse>;
13495
+ /**
13496
+ * Gets all feedback categories for the tenant.
13497
+ *
13498
+ * Returns both system default categories (Output, Agent Error, Agent Plan Execution)
13499
+ * and any custom categories created for this tenant.
13500
+ * When no pagination options are provided, the SDK returns up to 100 items. When pagination options are provided without a pageSize, the SDK defaults to 50 items per page.
13501
+ *
13502
+ * @param options - Optional filters and pagination options {@link FeedbackGetCategoriesOptions}
13503
+ * @returns Promise resolving to {@link NonPaginatedResponse} of {@link FeedbackCategoryResponse} without pagination options, or {@link PaginatedResponse} of {@link FeedbackCategoryResponse} when pagination options are used.
13504
+ * @example
13505
+ * ```typescript
13506
+ * import { Feedback } from '@uipath/uipath-typescript/feedback';
13507
+ *
13508
+ * const feedback = new Feedback(sdk);
13509
+ *
13510
+ * // Get all categories
13511
+ * const categories = await feedback.getCategories();
13512
+ * console.log(categories.items.map(c => c.category));
13513
+ *
13514
+ * // Get only categories applicable to negative feedback
13515
+ * const negativeCategories = await feedback.getCategories({ isNegative: true });
13516
+ *
13517
+ * // Paginated
13518
+ * const page1 = await feedback.getCategories({ pageSize: 10 });
13519
+ * ```
13520
+ */
13521
+ getCategories<T extends FeedbackGetCategoriesOptions = FeedbackGetCategoriesOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<FeedbackCategoryResponse> : NonPaginatedResponse<FeedbackCategoryResponse>>;
13522
+ /**
13523
+ * Deletes a feedback category by its ID.
13524
+ *
13525
+ * System default categories (Output, Agent Error, Agent Plan Execution) cannot be deleted —
13526
+ * attempting to do so throws a `409 Conflict` error.
13527
+ * Use `forceDelete` to delete a custom category that already has feedback entries associated with it.
13528
+ *
13529
+ * @param id - Category ID (GUID) of the category to delete
13530
+ * @param options - Optional deletion options {@link FeedbackDeleteCategoryOptions}
13531
+ * @returns Promise resolving to void on success
13532
+ * @example
13533
+ * ```typescript
13534
+ * import { Feedback } from '@uipath/uipath-typescript/feedback';
13535
+ *
13536
+ * const feedback = new Feedback(sdk);
13537
+ *
13538
+ * // Only custom categories (isDefault: false) can be deleted
13539
+ * const categories = await feedback.getCategories();
13540
+ * const customCategory = categories.items.find(c => !c.isDefault);
13541
+ * if (customCategory) {
13542
+ * await feedback.deleteCategory(customCategory.id);
13543
+ * }
13544
+ * ```
13545
+ * @example
13546
+ * ```typescript
13547
+ * // Force-delete a custom category that has associated feedback entries
13548
+ * const categories = await feedback.getCategories();
13549
+ * const customCategory = categories.items.find(c => !c.isDefault);
13550
+ * if (customCategory) {
13551
+ * await feedback.deleteCategory(customCategory.id, { forceDelete: true });
13552
+ * }
13553
+ * ```
13554
+ */
13555
+ deleteCategory(id: string, options?: FeedbackDeleteCategoryOptions): Promise<void>;
12206
13556
  }
12207
13557
 
12208
13558
  declare enum DocumentActionPriority {
@@ -12221,8 +13571,8 @@ declare enum DocumentActionType {
12221
13571
  Classification = "Classification"
12222
13572
  }
12223
13573
  interface UserData {
12224
- id?: number | null;
12225
- emailAddress?: string | null;
13574
+ Id?: number | null;
13575
+ EmailAddress?: string | null;
12226
13576
  }
12227
13577
 
12228
13578
  declare enum ComparisonOperator {
@@ -12271,103 +13621,96 @@ declare enum RuleType {
12271
13621
  IsEmpty = "IsEmpty"
12272
13622
  }
12273
13623
  interface DataSource {
12274
- resourceId?: string | null;
12275
- elementFieldId?: string | null;
13624
+ ResourceId?: string | null;
13625
+ ElementFieldId?: string | null;
12276
13626
  }
12277
13627
  interface DocumentGroup {
12278
- name?: string | null;
12279
- categories?: string[] | null;
13628
+ Name?: string | null;
13629
+ Categories?: string[] | null;
12280
13630
  }
12281
13631
  interface DocumentTaxonomy {
12282
- dataContractVersion?: string | null;
12283
- documentTypes?: DocumentTypeEntity[] | null;
12284
- groups?: DocumentGroup[] | null;
12285
- supportedLanguages?: LanguageInfo[] | null;
12286
- reportAsExceptionSettings?: ReportAsExceptionSettings;
13632
+ DataContractVersion?: string | null;
13633
+ DocumentTypes?: DocumentTypeEntity[] | null;
13634
+ Groups?: DocumentGroup[] | null;
13635
+ SupportedLanguages?: LanguageInfo[] | null;
13636
+ ReportAsExceptionSettings?: ReportAsExceptionSettings;
12287
13637
  }
12288
13638
  interface DocumentTypeEntity {
12289
- documentTypeId?: string | null;
12290
- group?: string | null;
12291
- category?: string | null;
12292
- name?: string | null;
12293
- optionalUniqueIdentifier?: string | null;
12294
- typeField?: TypeField;
12295
- fields?: Field[] | null;
12296
- metadata?: MetadataEntry[] | null;
13639
+ DocumentTypeId?: string | null;
13640
+ Group?: string | null;
13641
+ Category?: string | null;
13642
+ Name?: string | null;
13643
+ OptionalUniqueIdentifier?: string | null;
13644
+ TypeField?: TypeField;
13645
+ Fields?: Field[] | null;
13646
+ Metadata?: MetadataEntry[] | null;
12297
13647
  }
12298
13648
  interface ExceptionReasonOption {
12299
- exceptionReason?: string | null;
13649
+ ExceptionReason?: string | null;
12300
13650
  }
12301
13651
  interface Field {
12302
- fieldId?: string | null;
12303
- fieldName?: string | null;
12304
- isMultiValue?: boolean;
12305
- type?: FieldType;
12306
- deriveFieldsFormat?: string | null;
12307
- components?: Field[] | null;
12308
- setValues?: string[] | null;
12309
- metadata?: MetadataEntry[] | null;
12310
- ruleSet?: RuleSet;
12311
- defaultValue?: string | null;
12312
- dataSource?: DataSource;
13652
+ FieldId?: string | null;
13653
+ FieldName?: string | null;
13654
+ IsMultiValue?: boolean;
13655
+ Type?: FieldType;
13656
+ DeriveFieldsFormat?: string | null;
13657
+ Components?: Field[] | null;
13658
+ SetValues?: string[] | null;
13659
+ Metadata?: MetadataEntry[] | null;
13660
+ RuleSet?: RuleSet;
13661
+ DefaultValue?: string | null;
13662
+ DataSource?: DataSource;
12313
13663
  }
12314
13664
  interface LanguageInfo {
12315
- name?: string | null;
12316
- code?: string | null;
13665
+ Name?: string | null;
13666
+ Code?: string | null;
12317
13667
  }
12318
13668
  interface MetadataEntry {
12319
- key?: string | null;
12320
- value?: string | null;
13669
+ Key?: string | null;
13670
+ Value?: string | null;
12321
13671
  }
12322
13672
  interface ReportAsExceptionSettings {
12323
- exceptionReasonOptions?: ExceptionReasonOption[] | null;
13673
+ ExceptionReasonOptions?: ExceptionReasonOption[] | null;
12324
13674
  }
12325
13675
  interface Rule {
12326
- name?: string | null;
12327
- type?: RuleType;
12328
- logicalOperator?: LogicalOperator;
12329
- comparisonOperator?: ComparisonOperator;
12330
- expression?: string | null;
12331
- setValues?: string[] | null;
13676
+ Name?: string | null;
13677
+ Type?: RuleType;
13678
+ LogicalOperator?: LogicalOperator;
13679
+ ComparisonOperator?: ComparisonOperator;
13680
+ Expression?: string | null;
13681
+ SetValues?: string[] | null;
12332
13682
  }
12333
13683
  interface RuleSet {
12334
- criticality?: Criticality;
12335
- rules?: Rule[] | null;
13684
+ Criticality?: Criticality;
13685
+ Rules?: Rule[] | null;
12336
13686
  }
12337
13687
  interface TypeField {
12338
- fieldId?: string | null;
12339
- fieldName?: string | null;
13688
+ FieldId?: string | null;
13689
+ FieldName?: string | null;
12340
13690
  }
12341
13691
 
12342
13692
  interface FieldValue {
12343
- value?: string | null;
12344
- derivedValue?: string | null;
13693
+ Value?: string | null;
13694
+ DerivedValue?: string | null;
12345
13695
  }
12346
13696
  interface FieldValueResult {
12347
- value?: FieldValue;
12348
- isValid?: boolean;
12349
- rules?: RuleResult[] | null;
13697
+ Value?: FieldValue;
13698
+ IsValid?: boolean;
13699
+ Rules?: RuleResult[] | null;
12350
13700
  }
12351
13701
  interface RuleResult {
12352
- rule?: Rule;
12353
- isValid?: boolean;
13702
+ Rule?: Rule;
13703
+ IsValid?: boolean;
12354
13704
  }
12355
13705
  interface RuleSetResult {
12356
- fieldId?: string | null;
12357
- fieldType?: FieldType;
12358
- criticality?: Criticality;
12359
- isValid?: boolean;
12360
- results?: FieldValueResult[] | null;
12361
- brokenRules?: Rule[] | null;
12362
- rowIndex?: number | null;
12363
- tableFieldId?: string | null;
12364
- }
12365
-
12366
- interface ErrorResponse {
12367
- message?: string | null;
12368
- severity?: 'Info' | 'Warning' | 'Error';
12369
- code?: string | null;
12370
- parameters?: string[] | null;
13706
+ FieldId?: string | null;
13707
+ FieldType?: FieldType;
13708
+ Criticality?: Criticality;
13709
+ IsValid?: boolean;
13710
+ Results?: FieldValueResult[] | null;
13711
+ BrokenRules?: Rule[] | null;
13712
+ RowIndex?: number | null;
13713
+ TableFieldId?: string | null;
12371
13714
  }
12372
13715
 
12373
13716
  declare enum ClassifierDocumentTypeType {
@@ -12390,101 +13733,107 @@ declare enum GptFieldType {
12390
13733
  Number = "Number",
12391
13734
  Text = "Text"
12392
13735
  }
13736
+ declare enum JobStatus {
13737
+ Succeeded = "Succeeded",
13738
+ Failed = "Failed",
13739
+ Running = "Running",
13740
+ NotStarted = "NotStarted"
13741
+ }
12393
13742
  declare enum ValidationDisplayMode {
12394
13743
  Classic = "Classic",
12395
13744
  Compact = "Compact"
12396
13745
  }
12397
13746
  interface ClassificationPrompt {
12398
- name?: string | null;
12399
- description?: string | null;
13747
+ Name?: string | null;
13748
+ Description?: string | null;
12400
13749
  }
12401
13750
  interface ClassificationValidationConfiguration {
12402
- enablePageReordering?: boolean;
13751
+ EnablePageReordering?: boolean;
12403
13752
  }
12404
13753
  interface ContentValidationData {
12405
- bucketName?: string | null;
12406
- bucketId?: number;
12407
- folderId?: number;
12408
- folderKey?: string;
12409
- documentId?: string;
12410
- encodedDocumentPath?: string | null;
12411
- textPath?: string | null;
12412
- documentObjectModelPath?: string | null;
12413
- taxonomyPath?: string | null;
12414
- automaticExtractionResultsPath?: string | null;
12415
- validatedExtractionResultsPath?: string | null;
12416
- customizationInfoPath?: string | null;
13754
+ BucketName?: string | null;
13755
+ BucketId?: number;
13756
+ FolderId?: number;
13757
+ FolderKey?: string;
13758
+ DocumentId?: string;
13759
+ EncodedDocumentPath?: string | null;
13760
+ TextPath?: string | null;
13761
+ DocumentObjectModelPath?: string | null;
13762
+ TaxonomyPath?: string | null;
13763
+ AutomaticExtractionResultsPath?: string | null;
13764
+ ValidatedExtractionResultsPath?: string | null;
13765
+ CustomizationInfoPath?: string | null;
12417
13766
  }
12418
13767
  interface DocumentClassificationActionDataModel {
12419
- id?: number | null;
12420
- status?: DocumentActionStatus;
12421
- title?: string | null;
12422
- priority?: DocumentActionPriority;
12423
- taskCatalogName?: string | null;
12424
- taskUrl?: string | null;
12425
- folderPath?: string | null;
12426
- folderId?: number | null;
12427
- data?: unknown | null;
12428
- action?: string | null;
12429
- isDeleted?: boolean | null;
12430
- assignedToUser?: UserData;
12431
- creatorUser?: UserData;
12432
- deleterUser?: UserData;
12433
- lastModifierUser?: UserData;
12434
- completedByUser?: UserData;
12435
- creationTime?: string | null;
12436
- lastAssignedTime?: string | null;
12437
- completionTime?: string | null;
12438
- processingTime?: number | null;
12439
- type?: DocumentActionType;
13768
+ Id?: number | null;
13769
+ Status?: DocumentActionStatus;
13770
+ Title?: string | null;
13771
+ Priority?: DocumentActionPriority;
13772
+ TaskCatalogName?: string | null;
13773
+ TaskUrl?: string | null;
13774
+ FolderPath?: string | null;
13775
+ FolderId?: number | null;
13776
+ Data?: unknown | null;
13777
+ Action?: string | null;
13778
+ IsDeleted?: boolean | null;
13779
+ AssignedToUser?: UserData;
13780
+ CreatorUser?: UserData;
13781
+ DeleterUser?: UserData;
13782
+ LastModifierUser?: UserData;
13783
+ CompletedByUser?: UserData;
13784
+ CreationTime?: string | null;
13785
+ LastAssignedTime?: string | null;
13786
+ CompletionTime?: string | null;
13787
+ ProcessingTime?: number | null;
13788
+ Type?: DocumentActionType;
12440
13789
  }
12441
13790
  interface DocumentExtractionActionDataModel {
12442
- id?: number | null;
12443
- status?: DocumentActionStatus;
12444
- title?: string | null;
12445
- priority?: DocumentActionPriority;
12446
- taskCatalogName?: string | null;
12447
- taskUrl?: string | null;
12448
- folderPath?: string | null;
12449
- folderId?: number | null;
12450
- data?: unknown | null;
12451
- action?: string | null;
12452
- isDeleted?: boolean | null;
12453
- assignedToUser?: UserData;
12454
- creatorUser?: UserData;
12455
- deleterUser?: UserData;
12456
- lastModifierUser?: UserData;
12457
- completedByUser?: UserData;
12458
- creationTime?: string | null;
12459
- lastAssignedTime?: string | null;
12460
- completionTime?: string | null;
12461
- processingTime?: number | null;
12462
- type?: DocumentActionType;
13791
+ Id?: number | null;
13792
+ Status?: DocumentActionStatus;
13793
+ Title?: string | null;
13794
+ Priority?: DocumentActionPriority;
13795
+ TaskCatalogName?: string | null;
13796
+ TaskUrl?: string | null;
13797
+ FolderPath?: string | null;
13798
+ FolderId?: number | null;
13799
+ Data?: unknown | null;
13800
+ Action?: string | null;
13801
+ IsDeleted?: boolean | null;
13802
+ AssignedToUser?: UserData;
13803
+ CreatorUser?: UserData;
13804
+ DeleterUser?: UserData;
13805
+ LastModifierUser?: UserData;
13806
+ CompletedByUser?: UserData;
13807
+ CreationTime?: string | null;
13808
+ LastAssignedTime?: string | null;
13809
+ CompletionTime?: string | null;
13810
+ ProcessingTime?: number | null;
13811
+ Type?: DocumentActionType;
12463
13812
  }
12464
13813
  interface ExtractionPrompt {
12465
- id?: string | null;
12466
- question?: string | null;
12467
- fieldType?: GptFieldType;
12468
- multiValued?: boolean | null;
13814
+ Id?: string | null;
13815
+ Question?: string | null;
13816
+ FieldType?: GptFieldType;
13817
+ MultiValued?: boolean | null;
12469
13818
  }
12470
13819
  interface ExtractionValidationConfigurationV2 {
12471
- enableRtlControls?: boolean;
12472
- displayMode?: ValidationDisplayMode;
12473
- fieldsValidationConfidence?: number | null;
12474
- allowChangeOfDocumentType?: boolean | null;
13820
+ EnableRtlControls?: boolean;
13821
+ DisplayMode?: ValidationDisplayMode;
13822
+ FieldsValidationConfidence?: number | null;
13823
+ AllowChangeOfDocumentType?: boolean | null;
12475
13824
  }
12476
13825
  interface FieldGroupValueProjection {
12477
- fieldGroupName?: string | null;
12478
- fieldValues?: FieldValueProjection[] | null;
13826
+ FieldGroupName?: string | null;
13827
+ FieldValues?: FieldValueProjection[] | null;
12479
13828
  }
12480
13829
  interface FieldValueProjection {
12481
- id?: string | null;
12482
- name?: string | null;
12483
- value?: string | null;
12484
- unformattedValue?: string | null;
12485
- confidence?: number | null;
12486
- ocrConfidence?: number | null;
12487
- type?: FieldType;
13830
+ Id?: string | null;
13831
+ Name?: string | null;
13832
+ Value?: string | null;
13833
+ UnformattedValue?: string | null;
13834
+ Confidence?: number | null;
13835
+ OcrConfidence?: number | null;
13836
+ Type?: FieldType;
12488
13837
  }
12489
13838
 
12490
13839
  declare enum MarkupType {
@@ -12535,59 +13884,59 @@ declare enum WordGroupType {
12535
13884
  Other = "Other"
12536
13885
  }
12537
13886
  interface DocumentEntity {
12538
- documentId?: string | null;
12539
- contentType?: string | null;
12540
- length?: number;
12541
- pages?: Page[] | null;
12542
- documentMetadata?: Metadata[] | null;
13887
+ DocumentId?: string | null;
13888
+ ContentType?: string | null;
13889
+ Length?: number;
13890
+ Pages?: Page[] | null;
13891
+ DocumentMetadata?: Metadata[] | null;
12543
13892
  }
12544
13893
  interface Metadata {
12545
- key?: string | null;
12546
- value?: string | null;
13894
+ Key?: string | null;
13895
+ Value?: string | null;
12547
13896
  }
12548
13897
  interface Page {
12549
- pageIndex?: number;
12550
- size?: number[];
12551
- sections?: PageSection[] | null;
12552
- pageMarkups?: PageMarkup[] | null;
12553
- processingSource?: ProcessingSource;
12554
- indexInText?: number;
12555
- textLength?: number;
12556
- skewAngle?: number;
12557
- rotation?: Rotation;
12558
- pageMetadata?: Metadata[] | null;
13898
+ PageIndex?: number;
13899
+ Size?: number[];
13900
+ Sections?: PageSection[] | null;
13901
+ PageMarkups?: PageMarkup[] | null;
13902
+ ProcessingSource?: ProcessingSource;
13903
+ IndexInText?: number;
13904
+ TextLength?: number;
13905
+ SkewAngle?: number;
13906
+ Rotation?: Rotation;
13907
+ PageMetadata?: Metadata[] | null;
12559
13908
  }
12560
13909
  interface PageMarkup {
12561
- box?: number[];
12562
- polygon?: number[] | null;
12563
- ocrConfidence?: number;
12564
- text?: string | null;
12565
- markupType?: MarkupType;
13910
+ Box?: number[];
13911
+ Polygon?: number[] | null;
13912
+ OcrConfidence?: number;
13913
+ Text?: string | null;
13914
+ MarkupType?: MarkupType;
12566
13915
  }
12567
13916
  interface PageSection {
12568
- indexInText?: number;
12569
- language?: string | null;
12570
- length?: number;
12571
- rotation?: Rotation;
12572
- skewAngle?: number;
12573
- type?: SectionType;
12574
- wordGroups?: WordGroup[] | null;
13917
+ IndexInText?: number;
13918
+ Language?: string | null;
13919
+ Length?: number;
13920
+ Rotation?: Rotation;
13921
+ SkewAngle?: number;
13922
+ Type?: SectionType;
13923
+ WordGroups?: WordGroup[] | null;
12575
13924
  }
12576
13925
  interface Word {
12577
- box?: number[];
12578
- polygon?: number[] | null;
12579
- indexInText?: number;
12580
- ocrConfidence?: number;
12581
- text?: string | null;
12582
- visualLineNumber?: number;
12583
- textType?: TextType;
12584
- markupType?: MarkupType[] | null;
13926
+ Box?: number[];
13927
+ Polygon?: number[] | null;
13928
+ IndexInText?: number;
13929
+ OcrConfidence?: number;
13930
+ Text?: string | null;
13931
+ VisualLineNumber?: number;
13932
+ TextType?: TextType;
13933
+ MarkupType?: MarkupType[] | null;
12585
13934
  }
12586
13935
  interface WordGroup {
12587
- indexInText?: number;
12588
- length?: number;
12589
- type?: WordGroupType;
12590
- words?: Word[] | null;
13936
+ IndexInText?: number;
13937
+ Length?: number;
13938
+ Type?: WordGroupType;
13939
+ Words?: Word[] | null;
12591
13940
  }
12592
13941
 
12593
13942
  declare enum ResultsDataSource {
@@ -12598,170 +13947,172 @@ declare enum ResultsDataSource {
12598
13947
  External = "External"
12599
13948
  }
12600
13949
  interface ClassificationResult {
12601
- documentTypeId?: string | null;
12602
- documentId?: string | null;
12603
- confidence?: number;
12604
- ocrConfidence?: number;
12605
- reference?: ResultsContentReference;
12606
- documentBounds?: ResultsDocumentBounds;
12607
- classifierName?: string | null;
13950
+ DocumentTypeId?: string | null;
13951
+ DocumentId?: string | null;
13952
+ Confidence?: number;
13953
+ OcrConfidence?: number;
13954
+ Reference?: ResultsContentReference;
13955
+ DocumentBounds?: ResultsDocumentBounds;
13956
+ ClassifierName?: string | null;
12608
13957
  }
12609
13958
  interface ExtractionResult {
12610
- documentId?: string | null;
12611
- resultsVersion?: number;
12612
- resultsDocument?: ResultsDocument;
12613
- extractorPayloads?: ExtractorPayload[] | null;
12614
- businessRulesResults?: RuleSetResult[] | null;
13959
+ DocumentId?: string | null;
13960
+ ResultsVersion?: number;
13961
+ ResultsDocument?: ResultsDocument;
13962
+ ExtractorPayloads?: ExtractorPayload[] | null;
13963
+ BusinessRulesResults?: RuleSetResult[] | null;
12615
13964
  }
12616
13965
  interface ExtractorPayload {
12617
- id?: string | null;
12618
- payload?: string | null;
12619
- savedPayloadId?: string | null;
12620
- taxonomySchemaMapping?: string | null;
13966
+ Id?: string | null;
13967
+ Payload?: string | null;
13968
+ SavedPayloadId?: string | null;
13969
+ TaxonomySchemaMapping?: string | null;
12621
13970
  }
12622
13971
  interface ResultsContentReference {
12623
- textStartIndex?: number;
12624
- textLength?: number;
12625
- tokens?: ResultsValueTokens[] | null;
13972
+ TextStartIndex?: number;
13973
+ TextLength?: number;
13974
+ Tokens?: ResultsValueTokens[] | null;
12626
13975
  }
12627
13976
  interface ResultsDataPoint {
12628
- fieldId?: string | null;
12629
- fieldName?: string | null;
12630
- fieldType?: FieldType;
12631
- isMissing?: boolean;
12632
- dataSource?: ResultsDataSource;
12633
- values?: ResultsValue[] | null;
12634
- dataVersion?: number;
12635
- operatorConfirmed?: boolean;
12636
- validatorNotes?: string | null;
12637
- validatorNotesInfo?: string | null;
13977
+ FieldId?: string | null;
13978
+ FieldName?: string | null;
13979
+ FieldType?: FieldType;
13980
+ IsMissing?: boolean;
13981
+ DataSource?: ResultsDataSource;
13982
+ Values?: ResultsValue[] | null;
13983
+ DataVersion?: number;
13984
+ OperatorConfirmed?: boolean;
13985
+ ValidatorNotes?: string | null;
13986
+ ValidatorNotesInfo?: string | null;
12638
13987
  }
12639
13988
  interface ResultsDerivedField {
12640
- fieldId?: string | null;
12641
- value?: string | null;
13989
+ FieldId?: string | null;
13990
+ Value?: string | null;
12642
13991
  }
12643
13992
  interface ResultsDocument {
12644
- bounds?: ResultsDocumentBounds;
12645
- language?: string | null;
12646
- documentGroup?: string | null;
12647
- documentCategory?: string | null;
12648
- documentTypeId?: string | null;
12649
- documentTypeName?: string | null;
12650
- documentTypeDataVersion?: number;
12651
- dataVersion?: number;
12652
- documentTypeSource?: ResultsDataSource;
12653
- documentTypeField?: ResultsValue;
12654
- fields?: ResultsDataPoint[] | null;
12655
- tables?: ResultsTable[] | null;
13993
+ Bounds?: ResultsDocumentBounds;
13994
+ Language?: string | null;
13995
+ DocumentGroup?: string | null;
13996
+ DocumentCategory?: string | null;
13997
+ DocumentTypeId?: string | null;
13998
+ DocumentTypeName?: string | null;
13999
+ DocumentTypeDataVersion?: number;
14000
+ DataVersion?: number;
14001
+ DocumentTypeSource?: ResultsDataSource;
14002
+ DocumentTypeField?: ResultsValue;
14003
+ Fields?: ResultsDataPoint[] | null;
14004
+ Tables?: ResultsTable[] | null;
12656
14005
  }
12657
14006
  interface ResultsDocumentBounds {
12658
- startPage?: number;
12659
- pageCount?: number;
12660
- textStartIndex?: number;
12661
- textLength?: number;
12662
- pageRange?: string | null;
14007
+ PageCount?: number;
14008
+ PageRange?: string | null;
12663
14009
  }
12664
14010
  interface ResultsTable {
12665
- fieldId?: string | null;
12666
- fieldName?: string | null;
12667
- isMissing?: boolean;
12668
- dataSource?: ResultsDataSource;
12669
- dataVersion?: number;
12670
- operatorConfirmed?: boolean;
12671
- values?: ResultsTableValue[] | null;
12672
- validatorNotes?: string | null;
12673
- validatorNotesInfo?: string | null;
14011
+ FieldId?: string | null;
14012
+ FieldName?: string | null;
14013
+ IsMissing?: boolean;
14014
+ DataSource?: ResultsDataSource;
14015
+ DataVersion?: number;
14016
+ OperatorConfirmed?: boolean;
14017
+ Values?: ResultsTableValue[] | null;
14018
+ ValidatorNotes?: string | null;
14019
+ ValidatorNotesInfo?: string | null;
12674
14020
  }
12675
14021
  interface ResultsTableCell {
12676
- rowIndex?: number;
12677
- columnIndex?: number;
12678
- isHeader?: boolean;
12679
- isMissing?: boolean;
12680
- operatorConfirmed?: boolean;
12681
- dataSource?: ResultsDataSource;
12682
- dataVersion?: number;
12683
- values?: ResultsValue[] | null;
14022
+ RowIndex?: number;
14023
+ ColumnIndex?: number;
14024
+ IsHeader?: boolean;
14025
+ IsMissing?: boolean;
14026
+ OperatorConfirmed?: boolean;
14027
+ DataSource?: ResultsDataSource;
14028
+ DataVersion?: number;
14029
+ Values?: ResultsValue[] | null;
12684
14030
  }
12685
14031
  interface ResultsTableColumnInfo {
12686
- fieldId?: string | null;
12687
- fieldName?: string | null;
12688
- fieldType?: FieldType;
14032
+ FieldId?: string | null;
14033
+ FieldName?: string | null;
14034
+ FieldType?: FieldType;
12689
14035
  }
12690
14036
  interface ResultsTableValue {
12691
- operatorConfirmed?: boolean;
12692
- confidence?: number;
12693
- ocrConfidence?: number;
12694
- cells?: ResultsTableCell[] | null;
12695
- columnInfo?: ResultsTableColumnInfo[] | null;
12696
- numberOfRows?: number;
12697
- validatorNotes?: string | null;
12698
- validatorNotesInfo?: string | null;
14037
+ OperatorConfirmed?: boolean;
14038
+ Confidence?: number;
14039
+ OcrConfidence?: number;
14040
+ Cells?: ResultsTableCell[] | null;
14041
+ ColumnInfo?: ResultsTableColumnInfo[] | null;
14042
+ NumberOfRows?: number;
14043
+ ValidatorNotes?: string | null;
14044
+ ValidatorNotesInfo?: string | null;
12699
14045
  }
12700
14046
  interface ResultsValue {
12701
- components?: ResultsDataPoint[] | null;
12702
- value?: string | null;
12703
- unformattedValue?: string | null;
12704
- reference?: ResultsContentReference;
12705
- derivedFields?: ResultsDerivedField[] | null;
12706
- confidence?: number;
12707
- operatorConfirmed?: boolean;
12708
- ocrConfidence?: number;
12709
- textType?: TextType;
12710
- validatorNotes?: string | null;
12711
- validatorNotesInfo?: string | null;
14047
+ Components?: ResultsDataPoint[] | null;
14048
+ Value?: string | null;
14049
+ UnformattedValue?: string | null;
14050
+ Reference?: ResultsContentReference;
14051
+ DerivedFields?: ResultsDerivedField[] | null;
14052
+ Confidence?: number;
14053
+ OperatorConfirmed?: boolean;
14054
+ OcrConfidence?: number;
14055
+ TextType?: TextType;
14056
+ ValidatorNotes?: string | null;
14057
+ ValidatorNotesInfo?: string | null;
12712
14058
  }
12713
14059
  interface ResultsValueTokens {
12714
- textStartIndex?: number;
12715
- textLength?: number;
12716
- page?: number;
12717
- pageWidth?: number;
12718
- pageHeight?: number;
12719
- boxes?: number[][] | null;
14060
+ TextStartIndex?: number;
14061
+ TextLength?: number;
14062
+ Page?: number;
14063
+ PageWidth?: number;
14064
+ PageHeight?: number;
14065
+ Boxes?: number[][] | null;
12720
14066
  }
12721
14067
 
12722
14068
  interface ClassificationRequestBody {
12723
- documentId?: string;
12724
- prompts?: ClassificationPrompt[] | null;
14069
+ DocumentId?: string;
14070
+ Prompts?: ClassificationPrompt[] | null;
12725
14071
  }
12726
14072
  interface ClassificationResponse {
12727
- classificationResults?: ClassificationResult[] | null;
14073
+ ClassificationResults?: ClassificationResult[] | null;
12728
14074
  }
12729
14075
  interface StartClassificationResponse {
12730
- operationId?: string;
12731
- resultUrl?: string | null;
12732
- }
12733
- interface SwaggerGetClassificationResultResponse {
12734
- status?: 'Succeeded' | 'Failed' | 'Running' | 'NotStarted';
12735
- createdAt?: string;
12736
- lastUpdatedAt?: string;
12737
- error?: ErrorResponse;
12738
- result?: ClassificationResponse;
14076
+ OperationId?: string;
14077
+ ResultUrl?: string | null;
12739
14078
  }
12740
14079
 
12741
14080
  interface DataDeletionRequest {
12742
- removeValidationDataFromStorage?: boolean;
14081
+ RemoveValidationDataFromStorage?: boolean;
14082
+ }
14083
+
14084
+ declare enum ErrorSeverity {
14085
+ Info = "Info",
14086
+ Warning = "Warning",
14087
+ Error = "Error"
14088
+ }
14089
+ interface ErrorResponse {
14090
+ Message?: string | null;
14091
+ Severity?: ErrorSeverity;
14092
+ Code?: string | null;
14093
+ Parameters?: string[] | null;
12743
14094
  }
12744
14095
 
12745
14096
  interface StartDigitizationFromAttachmentModel {
12746
- attachmentId?: string;
12747
- folderId?: string | null;
12748
- fileName?: string | null;
12749
- mimeType?: string | null;
14097
+ AttachmentId?: string;
14098
+ FolderId?: string | null;
14099
+ FileName?: string | null;
14100
+ MimeType?: string | null;
12750
14101
  }
12751
14102
  interface StartDigitizationResponse {
12752
- documentId?: string;
12753
- resultUrl?: string | null;
14103
+ DocumentId?: string;
14104
+ ResultUrl?: string | null;
12754
14105
  }
12755
14106
  interface SwaggerGetDigitizeJobResponse {
12756
- status?: 'Succeeded' | 'Failed' | 'Running' | 'NotStarted';
12757
- error?: ErrorResponse;
12758
- result?: SwaggerGetDigitizeJobResult;
12759
- createdAt?: string;
12760
- lastUpdatedAt?: string;
14107
+ Status?: JobStatus;
14108
+ Error?: ErrorResponse;
14109
+ Result?: SwaggerGetDigitizeJobResult;
14110
+ CreatedAt?: string;
14111
+ LastUpdatedAt?: string;
12761
14112
  }
12762
14113
  interface SwaggerGetDigitizeJobResult {
12763
- documentObjectModel?: DocumentEntity;
12764
- documentText?: string | null;
14114
+ DocumentObjectModel?: DocumentEntity;
14115
+ DocumentText?: string | null;
12765
14116
  }
12766
14117
 
12767
14118
  declare enum ProjectProperties {
@@ -12795,213 +14146,206 @@ declare enum ResourceType {
12795
14146
  Unknown = "Unknown"
12796
14147
  }
12797
14148
  interface Classifier {
12798
- id?: string | null;
12799
- name?: string | null;
12800
- resourceType?: ResourceType;
12801
- status?: ResourceStatus;
12802
- documentTypeIds?: string[] | null;
12803
- detailsUrl?: string | null;
12804
- syncUrl?: string | null;
12805
- asyncUrl?: string | null;
12806
- projectVersion?: number | null;
12807
- projectVersionName?: string | null;
12808
- properties?: ProjectProperties[] | null;
14149
+ Id?: string | null;
14150
+ Name?: string | null;
14151
+ ResourceType?: ResourceType;
14152
+ Status?: ResourceStatus;
14153
+ DocumentTypeIds?: string[] | null;
14154
+ DetailsUrl?: string | null;
14155
+ SyncUrl?: string | null;
14156
+ AsyncUrl?: string | null;
14157
+ ProjectVersion?: number | null;
14158
+ ProjectVersionName?: string | null;
14159
+ Properties?: ProjectProperties[] | null;
12809
14160
  }
12810
14161
  interface DiscoveredDocumentType {
12811
- id?: string | null;
12812
- name?: string | null;
12813
- resourceType?: ResourceType;
12814
- detailsUrl?: string | null;
14162
+ Id?: string | null;
14163
+ Name?: string | null;
14164
+ ResourceType?: ResourceType;
14165
+ DetailsUrl?: string | null;
12815
14166
  }
12816
14167
  interface DiscoveredExtractorResourceSummaryResponse {
12817
- id?: string | null;
12818
- name?: string | null;
12819
- resourceType?: ResourceType;
12820
- detailsUrl?: string | null;
12821
- documentTypeId?: string | null;
12822
- documentTypeName?: string | null;
12823
- projectVersion?: number | null;
12824
- projectVersionName?: string | null;
12825
- createdOn?: string | null;
12826
- description?: string | null;
14168
+ Id?: string | null;
14169
+ Name?: string | null;
14170
+ ResourceType?: ResourceType;
14171
+ DetailsUrl?: string | null;
14172
+ DocumentTypeId?: string | null;
14173
+ DocumentTypeName?: string | null;
14174
+ ProjectVersion?: number | null;
14175
+ ProjectVersionName?: string | null;
14176
+ CreatedOn?: string | null;
14177
+ Description?: string | null;
12827
14178
  }
12828
14179
  interface DiscoveredProjectVersionResponseV2_0 {
12829
- version?: number;
12830
- versionName?: string | null;
12831
- tags?: string[] | null;
12832
- date?: string;
12833
- deployed?: boolean;
14180
+ Version?: number;
14181
+ VersionName?: string | null;
14182
+ Tags?: string[] | null;
14183
+ Date?: string;
14184
+ Deployed?: boolean;
12834
14185
  }
12835
14186
  interface DiscoveredResourceSummaryResponse {
12836
- id?: string | null;
12837
- name?: string | null;
12838
- resourceType?: ResourceType;
12839
- detailsUrl?: string | null;
12840
- projectVersion?: number | null;
12841
- projectVersionName?: string | null;
12842
- createdOn?: string | null;
12843
- description?: string | null;
14187
+ Id?: string | null;
14188
+ Name?: string | null;
14189
+ ResourceType?: ResourceType;
14190
+ DetailsUrl?: string | null;
14191
+ ProjectVersion?: number | null;
14192
+ ProjectVersionName?: string | null;
14193
+ CreatedOn?: string | null;
14194
+ Description?: string | null;
12844
14195
  }
12845
14196
  interface Extractor {
12846
- id?: string | null;
12847
- name?: string | null;
12848
- documentTypeId?: string | null;
12849
- resourceType?: ResourceType;
12850
- status?: ResourceStatus;
12851
- detailsUrl?: string | null;
12852
- syncUrl?: string | null;
12853
- asyncUrl?: string | null;
12854
- projectVersion?: number | null;
12855
- projectVersionName?: string | null;
12856
- description?: string | null;
14197
+ Id?: string | null;
14198
+ Name?: string | null;
14199
+ DocumentTypeId?: string | null;
14200
+ ResourceType?: ResourceType;
14201
+ Status?: ResourceStatus;
14202
+ DetailsUrl?: string | null;
14203
+ SyncUrl?: string | null;
14204
+ AsyncUrl?: string | null;
14205
+ ProjectVersion?: number | null;
14206
+ ProjectVersionName?: string | null;
14207
+ Description?: string | null;
12857
14208
  }
12858
14209
  interface GetClassifierDetailsDocumentTypeResponse {
12859
- id?: string | null;
12860
- name?: string | null;
12861
- resourceType?: ResourceType;
12862
- type?: ClassifierDocumentTypeType;
12863
- createdOn?: string | null;
14210
+ Id?: string | null;
14211
+ Name?: string | null;
14212
+ ResourceType?: ResourceType;
14213
+ Type?: ClassifierDocumentTypeType;
14214
+ CreatedOn?: string | null;
12864
14215
  }
12865
14216
  interface GetClassifierDetailsResponse {
12866
- id?: string | null;
12867
- name?: string | null;
12868
- resourceType?: ResourceType;
12869
- status?: ResourceStatus;
12870
- documentTypes?: GetClassifierDetailsDocumentTypeResponse[] | null;
12871
- createdOn?: string | null;
12872
- syncUrl?: string | null;
12873
- asyncUrl?: string | null;
12874
- projectVersion?: number | null;
12875
- projectVersionName?: string | null;
12876
- properties?: ProjectProperties[] | null;
14217
+ Id?: string | null;
14218
+ Name?: string | null;
14219
+ ResourceType?: ResourceType;
14220
+ Status?: ResourceStatus;
14221
+ DocumentTypes?: GetClassifierDetailsDocumentTypeResponse[] | null;
14222
+ CreatedOn?: string | null;
14223
+ SyncUrl?: string | null;
14224
+ AsyncUrl?: string | null;
14225
+ ProjectVersion?: number | null;
14226
+ ProjectVersionName?: string | null;
14227
+ Properties?: ProjectProperties[] | null;
12877
14228
  }
12878
14229
  interface GetClassifiersResponse {
12879
- classifiers?: Classifier[] | null;
14230
+ Classifiers?: Classifier[] | null;
12880
14231
  }
12881
14232
  interface GetDocumentTypeDetailsByTagResponseV2_0 {
12882
- id?: string | null;
12883
- name?: string | null;
12884
- resourceType?: ResourceType;
12885
- createdOn?: string | null;
12886
- documentTaxonomy?: DocumentTaxonomy;
14233
+ Id?: string | null;
14234
+ Name?: string | null;
14235
+ ResourceType?: ResourceType;
14236
+ CreatedOn?: string | null;
14237
+ DocumentTaxonomy?: DocumentTaxonomy;
12887
14238
  }
12888
14239
  interface GetDocumentTypeDetailsResponseV2_0 {
12889
- id?: string | null;
12890
- name?: string | null;
12891
- resourceType?: ResourceType;
12892
- createdOn?: string | null;
12893
- classifiers?: DiscoveredResourceSummaryResponse[] | null;
12894
- extractors?: DiscoveredResourceSummaryResponse[] | null;
14240
+ Id?: string | null;
14241
+ Name?: string | null;
14242
+ ResourceType?: ResourceType;
14243
+ CreatedOn?: string | null;
14244
+ Classifiers?: DiscoveredResourceSummaryResponse[] | null;
14245
+ Extractors?: DiscoveredResourceSummaryResponse[] | null;
12895
14246
  }
12896
14247
  interface GetDocumentTypesResponse {
12897
- documentTypes?: DiscoveredDocumentType[] | null;
14248
+ DocumentTypes?: DiscoveredDocumentType[] | null;
12898
14249
  }
12899
14250
  interface GetExtractorDetailsResponseV2_0 {
12900
- id?: string | null;
12901
- name?: string | null;
12902
- resourceType?: ResourceType;
12903
- status?: ResourceStatus;
12904
- projectId?: string;
12905
- projectVersion?: number | null;
12906
- projectVersionName?: string | null;
12907
- documentTypeName?: string | null;
12908
- documentTypeId?: string | null;
12909
- createdOn?: string | null;
12910
- syncUrl?: string | null;
12911
- asyncUrl?: string | null;
12912
- description?: string | null;
12913
- documentTaxonomy?: DocumentTaxonomy;
14251
+ Id?: string | null;
14252
+ Name?: string | null;
14253
+ ResourceType?: ResourceType;
14254
+ Status?: ResourceStatus;
14255
+ ProjectId?: string;
14256
+ ProjectVersion?: number | null;
14257
+ ProjectVersionName?: string | null;
14258
+ DocumentTypeName?: string | null;
14259
+ DocumentTypeId?: string | null;
14260
+ CreatedOn?: string | null;
14261
+ SyncUrl?: string | null;
14262
+ AsyncUrl?: string | null;
14263
+ Description?: string | null;
14264
+ DocumentTaxonomy?: DocumentTaxonomy;
12914
14265
  }
12915
14266
  interface GetExtractorsResponse {
12916
- extractors?: Extractor[] | null;
14267
+ Extractors?: Extractor[] | null;
12917
14268
  }
12918
14269
  interface GetProjectDetailsResponseV2_0 {
12919
- id?: string;
12920
- name?: string | null;
12921
- description?: string | null;
12922
- type?: ProjectType;
12923
- properties?: ProjectProperties[] | null;
12924
- documentTypes?: DiscoveredResourceSummaryResponse[] | null;
12925
- classifiers?: DiscoveredResourceSummaryResponse[] | null;
12926
- extractors?: DiscoveredExtractorResourceSummaryResponse[] | null;
12927
- projectVersions?: DiscoveredProjectVersionResponseV2_0[] | null;
12928
- createdOn?: string | null;
14270
+ Id?: string;
14271
+ Name?: string | null;
14272
+ Description?: string | null;
14273
+ Type?: ProjectType;
14274
+ Properties?: ProjectProperties[] | null;
14275
+ DocumentTypes?: DiscoveredResourceSummaryResponse[] | null;
14276
+ Classifiers?: DiscoveredResourceSummaryResponse[] | null;
14277
+ Extractors?: DiscoveredExtractorResourceSummaryResponse[] | null;
14278
+ ProjectVersions?: DiscoveredProjectVersionResponseV2_0[] | null;
14279
+ CreatedOn?: string | null;
12929
14280
  }
12930
14281
  interface GetProjectsResponse {
12931
- projects?: Project[] | null;
14282
+ Projects?: Project[] | null;
12932
14283
  }
12933
14284
  interface GetProjectTaxonomyResponse {
12934
- documentTaxonomy?: DocumentTaxonomy;
14285
+ DocumentTaxonomy?: DocumentTaxonomy;
12935
14286
  }
12936
14287
  interface GetTagsResponse {
12937
- tags?: TagEntity[] | null;
14288
+ Tags?: TagEntity[] | null;
12938
14289
  }
12939
14290
  interface Project {
12940
- id?: string;
12941
- name?: string | null;
12942
- type?: ProjectType;
12943
- description?: string | null;
12944
- createdOn?: string | null;
12945
- detailsUrl?: string | null;
12946
- digitizationStartUrl?: string | null;
12947
- classifiersDiscoveryUrl?: string | null;
12948
- extractorsDiscoveryUrl?: string | null;
12949
- properties?: ProjectProperties[] | null;
14291
+ Id?: string;
14292
+ Name?: string | null;
14293
+ Type?: ProjectType;
14294
+ Description?: string | null;
14295
+ CreatedOn?: string | null;
14296
+ DetailsUrl?: string | null;
14297
+ DigitizationStartUrl?: string | null;
14298
+ ClassifiersDiscoveryUrl?: string | null;
14299
+ ExtractorsDiscoveryUrl?: string | null;
14300
+ Properties?: ProjectProperties[] | null;
12950
14301
  }
12951
14302
  interface TagEntity {
12952
- name?: string | null;
12953
- projectVersion?: number | null;
12954
- projectVersionName?: string | null;
12955
- extractors?: TaggedExtractor[] | null;
12956
- classifiers?: TaggedClassifier[] | null;
14303
+ Name?: string | null;
14304
+ ProjectVersion?: number | null;
14305
+ ProjectVersionName?: string | null;
14306
+ Extractors?: TaggedExtractor[] | null;
14307
+ Classifiers?: TaggedClassifier[] | null;
12957
14308
  }
12958
14309
  interface TaggedClassifier {
12959
- name?: string | null;
12960
- documentTypes?: DiscoveredDocumentType[] | null;
12961
- syncUrl?: string | null;
12962
- asyncUrl?: string | null;
14310
+ Name?: string | null;
14311
+ DocumentTypes?: DiscoveredDocumentType[] | null;
14312
+ SyncUrl?: string | null;
14313
+ AsyncUrl?: string | null;
12963
14314
  }
12964
14315
  interface TaggedExtractor {
12965
- name?: string | null;
12966
- documentType?: DiscoveredDocumentType;
12967
- syncUrl?: string | null;
12968
- asyncUrl?: string | null;
14316
+ Name?: string | null;
14317
+ DocumentType?: DiscoveredDocumentType;
14318
+ SyncUrl?: string | null;
14319
+ AsyncUrl?: string | null;
12969
14320
  }
12970
14321
 
12971
14322
  interface ExtractionPromptRequestBody {
12972
- id?: string | null;
12973
- question?: string | null;
12974
- fieldType?: GptFieldType;
12975
- multiValued?: boolean | null;
14323
+ Id?: string | null;
14324
+ Question?: string | null;
14325
+ FieldType?: GptFieldType;
14326
+ MultiValued?: boolean | null;
12976
14327
  }
12977
14328
  interface ExtractRequestBodyConfiguration {
12978
- autoValidationConfidenceThreshold?: number | null;
14329
+ AutoValidationConfidenceThreshold?: number | null;
12979
14330
  }
12980
14331
  interface ExtractRequestBodyV2_0 {
12981
- documentId?: string;
12982
- pageRange?: string | null;
12983
- prompts?: ExtractionPromptRequestBody[] | null;
12984
- configuration?: ExtractRequestBodyConfiguration;
12985
- documentTaxonomy?: DocumentTaxonomy;
14332
+ DocumentId?: string;
14333
+ PageRange?: string | null;
14334
+ Prompts?: ExtractionPromptRequestBody[] | null;
14335
+ Configuration?: ExtractRequestBodyConfiguration;
14336
+ DocumentTaxonomy?: DocumentTaxonomy;
12986
14337
  }
12987
14338
  interface ExtractSyncResult {
12988
- extractionResult?: ExtractionResult;
14339
+ ExtractionResult?: ExtractionResult;
12989
14340
  }
12990
14341
  interface StartExtractionResponse {
12991
- operationId?: string;
12992
- resultUrl?: string | null;
12993
- }
12994
- interface SwaggerGetExtractionResultResponse {
12995
- status?: 'Succeeded' | 'Failed' | 'Running' | 'NotStarted';
12996
- createdAt?: string;
12997
- lastUpdatedAt?: string;
12998
- error?: ErrorResponse;
12999
- result?: ExtractSyncResult;
14342
+ OperationId?: string;
14343
+ ResultUrl?: string | null;
13000
14344
  }
13001
14345
 
13002
14346
  declare enum ModelKind {
13003
- Classifier = "Classifier",
13004
- Extractor = "Extractor"
14347
+ Extractor = "Extractor",
14348
+ Classifier = "Classifier"
13005
14349
  }
13006
14350
  declare enum ModelType {
13007
14351
  IXP = "IXP",
@@ -13009,40 +14353,42 @@ declare enum ModelType {
13009
14353
  Predefined = "Predefined"
13010
14354
  }
13011
14355
  interface FolderBasedStartExtractionRequest {
13012
- documentId?: string;
13013
- documentTaxonomy?: DocumentTaxonomy;
13014
- pageRange?: string | null;
14356
+ DocumentId?: string;
14357
+ DocumentTaxonomy?: DocumentTaxonomy;
14358
+ PageRange?: string | null;
13015
14359
  }
13016
14360
  interface FolderBasedStartExtractionResponse {
13017
- operationId?: string;
13018
- resultUrl?: string | null;
14361
+ OperationId?: string;
14362
+ ResultUrl?: string | null;
13019
14363
  }
13020
14364
  interface FolderModelsResponse {
13021
- folderKey?: string | null;
13022
- fullyQualifiedName?: string | null;
13023
- models?: ModelSummaryResponse[] | null;
14365
+ FolderKey?: string | null;
14366
+ FullyQualifiedName?: string | null;
14367
+ Models?: ModelSummaryResponse[] | null;
13024
14368
  }
13025
14369
  interface GetModelDetailsResponse {
13026
- fullyQualifiedName?: string | null;
13027
- kind?: ModelKind;
13028
- type?: ModelType;
13029
- description?: string | null;
13030
- asyncDigitizationUrl?: string | null;
13031
- asyncExtractionUrl?: string | null;
13032
- documentTaxonomy?: DocumentTaxonomy;
14370
+ FullyQualifiedName?: string | null;
14371
+ ModelDisplayName?: string | null;
14372
+ Kind?: ModelKind;
14373
+ Type?: ModelType;
14374
+ Description?: string | null;
14375
+ AsyncDigitizationUrl?: string | null;
14376
+ AsyncExtractionUrl?: string | null;
14377
+ DocumentTaxonomy?: DocumentTaxonomy;
13033
14378
  }
13034
14379
  interface GetModelsResponse {
13035
- folders?: FolderModelsResponse[] | null;
14380
+ Folders?: FolderModelsResponse[] | null;
13036
14381
  }
13037
14382
  interface ModelSummaryResponse {
13038
- modelName?: string | null;
13039
- description?: string | null;
13040
- kind?: ModelKind;
13041
- type?: ModelType;
13042
- fullyQualifiedName?: string | null;
13043
- detailsUrl?: string | null;
13044
- asyncDigitizationUrl?: string | null;
13045
- asyncExtractionUrl?: string | null;
14383
+ ModelName?: string | null;
14384
+ ModelDisplayName?: string | null;
14385
+ Description?: string | null;
14386
+ Kind?: ModelKind;
14387
+ Type?: ModelType;
14388
+ FullyQualifiedName?: string | null;
14389
+ DetailsUrl?: string | null;
14390
+ AsyncDigitizationUrl?: string | null;
14391
+ AsyncExtractionUrl?: string | null;
13046
14392
  }
13047
14393
 
13048
14394
  declare enum ActionStatus {
@@ -13051,174 +14397,198 @@ declare enum ActionStatus {
13051
14397
  Completed = "Completed"
13052
14398
  }
13053
14399
  interface ClassificationValidationResult {
13054
- actionStatus?: ActionStatus;
13055
- actionData?: DocumentClassificationActionDataModel;
13056
- validatedClassificationResults?: ClassificationResult[] | null;
14400
+ ActionStatus?: ActionStatus;
14401
+ ActionData?: DocumentClassificationActionDataModel;
14402
+ ValidatedClassificationResults?: ClassificationResult[] | null;
13057
14403
  }
13058
14404
  interface ExtractionValidationArtifactsResult {
13059
- validatedExtractionResults?: ExtractionResult;
14405
+ ValidatedExtractionResults?: ExtractionResult;
13060
14406
  }
13061
14407
  interface ExtractionValidationResult {
13062
- actionStatus?: ActionStatus;
13063
- actionData?: DocumentExtractionActionDataModel;
13064
- validatedExtractionResults?: ExtractionResult;
13065
- dataProjection?: FieldGroupValueProjection[] | null;
14408
+ ActionStatus?: ActionStatus;
14409
+ ActionData?: DocumentExtractionActionDataModel;
14410
+ ValidatedExtractionResults?: ExtractionResult;
14411
+ DataProjection?: FieldGroupValueProjection[] | null;
13066
14412
  }
13067
14413
  interface GetClassificationValidationTaskResponse {
13068
- status?: 'Succeeded' | 'Failed' | 'Running' | 'NotStarted';
13069
- error?: ErrorResponse;
13070
- createdAt?: string;
13071
- lastUpdatedAt?: string;
13072
- result?: ClassificationValidationResult;
14414
+ Status?: JobStatus;
14415
+ Error?: ErrorResponse;
14416
+ CreatedAt?: string;
14417
+ LastUpdatedAt?: string;
14418
+ Result?: ClassificationValidationResult;
13073
14419
  }
13074
14420
  interface GetExtractionValidationArtifactsResultTaskResponse {
13075
- result?: ExtractionValidationArtifactsResult;
14421
+ Result?: ExtractionValidationArtifactsResult;
13076
14422
  }
13077
14423
  interface GetExtractionValidationArtifactsTaskResponse {
13078
- status?: 'Succeeded' | 'Failed' | 'Running' | 'NotStarted';
13079
- error?: ErrorResponse;
13080
- createdAt?: string;
13081
- lastUpdatedAt?: string;
13082
- contentValidationData?: ContentValidationData;
14424
+ Status?: JobStatus;
14425
+ Error?: ErrorResponse;
14426
+ CreatedAt?: string;
14427
+ LastUpdatedAt?: string;
14428
+ ContentValidationData?: ContentValidationData;
13083
14429
  }
13084
14430
  interface GetExtractionValidationTaskResponse {
13085
- status?: 'Succeeded' | 'Failed' | 'Running' | 'NotStarted';
13086
- error?: ErrorResponse;
13087
- createdAt?: string;
13088
- lastUpdatedAt?: string;
13089
- result?: ExtractionValidationResult;
14431
+ Status?: JobStatus;
14432
+ Error?: ErrorResponse;
14433
+ CreatedAt?: string;
14434
+ LastUpdatedAt?: string;
14435
+ Result?: ExtractionValidationResult;
13090
14436
  }
13091
14437
  interface StartClassificationValidationTaskRequest {
13092
- documentId?: string | null;
13093
- actionTitle?: string | null;
13094
- actionPriority?: CreateTaskPriority;
13095
- actionCatalog?: string | null;
13096
- actionFolder?: string | null;
13097
- storageBucketName?: string | null;
13098
- storageBucketDirectoryPath?: string | null;
13099
- prompts?: ClassificationPrompt[] | null;
13100
- configuration?: ClassificationValidationConfiguration;
13101
- classificationResults?: ClassificationResult[] | null;
14438
+ DocumentId?: string | null;
14439
+ ActionTitle?: string | null;
14440
+ ActionPriority?: CreateTaskPriority;
14441
+ ActionCatalog?: string | null;
14442
+ ActionFolder?: string | null;
14443
+ StorageBucketName?: string | null;
14444
+ StorageBucketDirectoryPath?: string | null;
14445
+ Prompts?: ClassificationPrompt[] | null;
14446
+ Configuration?: ClassificationValidationConfiguration;
14447
+ ClassificationResults?: ClassificationResult[] | null;
13102
14448
  }
13103
14449
  interface StartExtractionValidationArtifactsRequest {
13104
- documentId?: string;
13105
- extractionResult?: ExtractionResult;
13106
- documentTaxonomy?: DocumentTaxonomy;
13107
- folderName?: string | null;
13108
- storageBucketName?: string | null;
13109
- storageBucketDirectoryPath?: string | null;
14450
+ DocumentId?: string;
14451
+ ExtractionResult?: ExtractionResult;
14452
+ DocumentTaxonomy?: DocumentTaxonomy;
14453
+ FolderName?: string | null;
14454
+ StorageBucketName?: string | null;
14455
+ StorageBucketDirectoryPath?: string | null;
13110
14456
  }
13111
14457
  interface StartExtractionValidationTaskRequestV2_0 {
13112
- documentId?: string | null;
13113
- actionTitle?: string | null;
13114
- actionPriority?: CreateTaskPriority;
13115
- actionCatalog?: string | null;
13116
- actionFolder?: string | null;
13117
- storageBucketName?: string | null;
13118
- storageBucketDirectoryPath?: string | null;
13119
- fieldsValidationConfidence?: number | null;
13120
- allowChangeOfDocumentType?: boolean | null;
13121
- prompts?: ExtractionPrompt[] | null;
13122
- extractionResult?: ExtractionResult;
13123
- configuration?: ExtractionValidationConfigurationV2;
13124
- documentTaxonomy?: DocumentTaxonomy;
14458
+ DocumentId?: string | null;
14459
+ ActionTitle?: string | null;
14460
+ ActionPriority?: CreateTaskPriority;
14461
+ ActionCatalog?: string | null;
14462
+ ActionFolder?: string | null;
14463
+ StorageBucketName?: string | null;
14464
+ StorageBucketDirectoryPath?: string | null;
14465
+ Prompts?: ExtractionPrompt[] | null;
14466
+ ExtractionResult?: ExtractionResult;
14467
+ Configuration?: ExtractionValidationConfigurationV2;
14468
+ DocumentTaxonomy?: DocumentTaxonomy;
13125
14469
  }
13126
14470
  interface StartValidationArtifactsTaskResponse {
13127
- operationId?: string;
13128
- artifactsUrl?: string | null;
13129
- resultUrl?: string | null;
14471
+ OperationId?: string;
14472
+ ArtifactsUrl?: string | null;
14473
+ ResultUrl?: string | null;
13130
14474
  }
13131
14475
  interface StartValidationTaskResponse {
13132
- operationId?: string;
13133
- resultUrl?: string | null;
14476
+ OperationId?: string;
14477
+ ResultUrl?: string | null;
13134
14478
  }
13135
14479
 
13136
14480
  interface ClassificationValidationFinishedTaskInfo {
13137
- id?: number;
13138
- title?: string | null;
13139
- priority?: DocumentActionPriority;
13140
- status?: ActionStatus;
13141
- creationTime?: string;
13142
- completionTime?: string | null;
13143
- lastAssignedTime?: string;
13144
- url?: string | null;
13145
- assignedToUser?: string | null;
13146
- completedByUser?: string | null;
13147
- lastModifierUser?: string | null;
13148
- documentRejectionReason?: string | null;
13149
- catalogName?: string | null;
13150
- folderName?: string | null;
13151
- processingTime?: number | null;
14481
+ Id?: number;
14482
+ Title?: string | null;
14483
+ Priority?: DocumentActionPriority;
14484
+ Status?: ActionStatus;
14485
+ CreationTime?: string;
14486
+ CompletionTime?: string | null;
14487
+ LastAssignedTime?: string;
14488
+ Url?: string | null;
14489
+ AssignedToUser?: string | null;
14490
+ CompletedByUser?: string | null;
14491
+ LastModifierUser?: string | null;
14492
+ DocumentRejectionReason?: string | null;
14493
+ CatalogName?: string | null;
14494
+ FolderName?: string | null;
14495
+ ProcessingTime?: number | null;
13152
14496
  }
13153
14497
  interface FinishExtractionValidationTaskInfo {
13154
- id?: number;
13155
- title?: string | null;
13156
- priority?: DocumentActionPriority;
13157
- status?: ActionStatus;
13158
- creationTime?: string;
13159
- completionTime?: string | null;
13160
- lastAssignedTime?: string;
13161
- url?: string | null;
13162
- assignedToUser?: string | null;
13163
- completedByUser?: string | null;
13164
- lastModifierUser?: string | null;
13165
- documentRejectionReason?: string | null;
13166
- catalogName?: string | null;
13167
- folderName?: string | null;
13168
- processingTime?: number | null;
14498
+ Id?: number;
14499
+ Title?: string | null;
14500
+ Priority?: DocumentActionPriority;
14501
+ Status?: ActionStatus;
14502
+ CreationTime?: string;
14503
+ CompletionTime?: string | null;
14504
+ LastAssignedTime?: string;
14505
+ Url?: string | null;
14506
+ AssignedToUser?: string | null;
14507
+ CompletedByUser?: string | null;
14508
+ LastModifierUser?: string | null;
14509
+ DocumentRejectionReason?: string | null;
14510
+ CatalogName?: string | null;
14511
+ FolderName?: string | null;
14512
+ ProcessingTime?: number | null;
13169
14513
  }
13170
14514
  interface StartClassificationValidationTaskInfo {
13171
- id?: number;
13172
- title?: string | null;
13173
- folderName?: string | null;
13174
- storageBucketName?: string | null;
13175
- storageBucketDirectoryPath?: string | null;
13176
- catalogName?: string | null;
13177
- priority?: DocumentActionPriority;
13178
- status?: ActionStatus;
14515
+ Id?: number;
14516
+ Title?: string | null;
14517
+ FolderName?: string | null;
14518
+ StorageBucketName?: string | null;
14519
+ StorageBucketDirectoryPath?: string | null;
14520
+ CatalogName?: string | null;
14521
+ Priority?: DocumentActionPriority;
14522
+ Status?: ActionStatus;
13179
14523
  }
13180
14524
  interface StartExtractionValidationTaskInfo {
13181
- id?: number;
13182
- title?: string | null;
13183
- folderName?: string | null;
13184
- storageBucketName?: string | null;
13185
- storageBucketDirectoryPath?: string | null;
13186
- catalogName?: string | null;
13187
- priority?: DocumentActionPriority;
13188
- status?: ActionStatus;
14525
+ Id?: number;
14526
+ Title?: string | null;
14527
+ FolderName?: string | null;
14528
+ StorageBucketName?: string | null;
14529
+ StorageBucketDirectoryPath?: string | null;
14530
+ CatalogName?: string | null;
14531
+ Priority?: DocumentActionPriority;
14532
+ Status?: ActionStatus;
13189
14533
  }
13190
14534
  interface TrackFinishClassificationValidationRequest {
13191
- classifierId?: string | null;
13192
- tag?: string | null;
13193
- documentId?: string;
13194
- task?: ClassificationValidationFinishedTaskInfo;
13195
- classificationResult?: ClassificationResult[] | null;
14535
+ ClassifierId?: string | null;
14536
+ Tag?: string | null;
14537
+ DocumentId?: string;
14538
+ Task?: ClassificationValidationFinishedTaskInfo;
14539
+ ClassificationResult?: ClassificationResult[] | null;
13196
14540
  }
13197
14541
  interface TrackFinishExtractionValidationRequest {
13198
- extractorId?: string | null;
13199
- tag?: string | null;
13200
- documentTypeId?: string | null;
13201
- documentId?: string;
13202
- task?: FinishExtractionValidationTaskInfo;
13203
- extractionResult?: ExtractionResult;
13204
- validatedExtractionResult?: ExtractionResult;
14542
+ ExtractorId?: string | null;
14543
+ Tag?: string | null;
14544
+ DocumentTypeId?: string | null;
14545
+ DocumentId?: string;
14546
+ Task?: FinishExtractionValidationTaskInfo;
14547
+ ExtractionResult?: ExtractionResult;
14548
+ ValidatedExtractionResult?: ExtractionResult;
13205
14549
  }
13206
14550
  interface TrackStartClassificationValidationRequest {
13207
- classifierId?: string | null;
13208
- tag?: string | null;
13209
- documentId?: string;
13210
- duration?: number;
13211
- task?: StartClassificationValidationTaskInfo;
13212
- classificationResult?: ClassificationResult[] | null;
14551
+ ClassifierId?: string | null;
14552
+ Tag?: string | null;
14553
+ DocumentId?: string;
14554
+ Duration?: number;
14555
+ Task?: StartClassificationValidationTaskInfo;
14556
+ ClassificationResult?: ClassificationResult[] | null;
13213
14557
  }
13214
14558
  interface TrackStartExtractionValidationRequest {
13215
- extractorId?: string | null;
13216
- tag?: string | null;
13217
- documentTypeId?: string | null;
13218
- documentId?: string;
13219
- duration?: number;
13220
- task?: StartExtractionValidationTaskInfo;
13221
- extractionResult?: ExtractionResult;
14559
+ ExtractorId?: string | null;
14560
+ Tag?: string | null;
14561
+ DocumentTypeId?: string | null;
14562
+ DocumentId?: string;
14563
+ Duration?: number;
14564
+ Task?: StartExtractionValidationTaskInfo;
14565
+ ExtractionResult?: ExtractionResult;
14566
+ }
14567
+
14568
+ interface GetClassificationResultResponse {
14569
+ Status?: JobStatus;
14570
+ CreatedAt?: string;
14571
+ LastUpdatedAt?: string;
14572
+ Error?: ErrorResponse;
14573
+ Result?: ClassificationResponse;
14574
+ }
14575
+ interface GetDigitizeJobResponse {
14576
+ Status?: JobStatus;
14577
+ Error?: ErrorResponse;
14578
+ Result?: GetDigitizeJobResult;
14579
+ CreatedAt?: string;
14580
+ LastUpdatedAt?: string;
14581
+ }
14582
+ interface GetDigitizeJobResult {
14583
+ DocumentObjectModel?: DocumentEntity;
14584
+ DocumentText?: string | null;
14585
+ }
14586
+ interface GetExtractionResultResponse {
14587
+ Status?: JobStatus;
14588
+ CreatedAt?: string;
14589
+ LastUpdatedAt?: string;
14590
+ Error?: ErrorResponse;
14591
+ Result?: ExtractSyncResult;
13222
14592
  }
13223
14593
 
13224
14594
  type index_ActionStatus = ActionStatus;
@@ -13259,6 +14629,8 @@ type index_DocumentGroup = DocumentGroup;
13259
14629
  type index_DocumentTaxonomy = DocumentTaxonomy;
13260
14630
  type index_DocumentTypeEntity = DocumentTypeEntity;
13261
14631
  type index_ErrorResponse = ErrorResponse;
14632
+ type index_ErrorSeverity = ErrorSeverity;
14633
+ declare const index_ErrorSeverity: typeof ErrorSeverity;
13262
14634
  type index_ExceptionReasonOption = ExceptionReasonOption;
13263
14635
  type index_ExtractRequestBodyConfiguration = ExtractRequestBodyConfiguration;
13264
14636
  type index_ExtractRequestBodyV2_0 = ExtractRequestBodyV2_0;
@@ -13282,13 +14654,17 @@ type index_FinishExtractionValidationTaskInfo = FinishExtractionValidationTaskIn
13282
14654
  type index_FolderBasedStartExtractionRequest = FolderBasedStartExtractionRequest;
13283
14655
  type index_FolderBasedStartExtractionResponse = FolderBasedStartExtractionResponse;
13284
14656
  type index_FolderModelsResponse = FolderModelsResponse;
14657
+ type index_GetClassificationResultResponse = GetClassificationResultResponse;
13285
14658
  type index_GetClassificationValidationTaskResponse = GetClassificationValidationTaskResponse;
13286
14659
  type index_GetClassifierDetailsDocumentTypeResponse = GetClassifierDetailsDocumentTypeResponse;
13287
14660
  type index_GetClassifierDetailsResponse = GetClassifierDetailsResponse;
13288
14661
  type index_GetClassifiersResponse = GetClassifiersResponse;
14662
+ type index_GetDigitizeJobResponse = GetDigitizeJobResponse;
14663
+ type index_GetDigitizeJobResult = GetDigitizeJobResult;
13289
14664
  type index_GetDocumentTypeDetailsByTagResponseV2_0 = GetDocumentTypeDetailsByTagResponseV2_0;
13290
14665
  type index_GetDocumentTypeDetailsResponseV2_0 = GetDocumentTypeDetailsResponseV2_0;
13291
14666
  type index_GetDocumentTypesResponse = GetDocumentTypesResponse;
14667
+ type index_GetExtractionResultResponse = GetExtractionResultResponse;
13292
14668
  type index_GetExtractionValidationArtifactsResultTaskResponse = GetExtractionValidationArtifactsResultTaskResponse;
13293
14669
  type index_GetExtractionValidationArtifactsTaskResponse = GetExtractionValidationArtifactsTaskResponse;
13294
14670
  type index_GetExtractionValidationTaskResponse = GetExtractionValidationTaskResponse;
@@ -13302,6 +14678,8 @@ type index_GetProjectsResponse = GetProjectsResponse;
13302
14678
  type index_GetTagsResponse = GetTagsResponse;
13303
14679
  type index_GptFieldType = GptFieldType;
13304
14680
  declare const index_GptFieldType: typeof GptFieldType;
14681
+ type index_JobStatus = JobStatus;
14682
+ declare const index_JobStatus: typeof JobStatus;
13305
14683
  type index_LanguageInfo = LanguageInfo;
13306
14684
  type index_LogicalOperator = LogicalOperator;
13307
14685
  declare const index_LogicalOperator: typeof LogicalOperator;
@@ -13363,10 +14741,8 @@ type index_StartExtractionValidationTaskInfo = StartExtractionValidationTaskInfo
13363
14741
  type index_StartExtractionValidationTaskRequestV2_0 = StartExtractionValidationTaskRequestV2_0;
13364
14742
  type index_StartValidationArtifactsTaskResponse = StartValidationArtifactsTaskResponse;
13365
14743
  type index_StartValidationTaskResponse = StartValidationTaskResponse;
13366
- type index_SwaggerGetClassificationResultResponse = SwaggerGetClassificationResultResponse;
13367
14744
  type index_SwaggerGetDigitizeJobResponse = SwaggerGetDigitizeJobResponse;
13368
14745
  type index_SwaggerGetDigitizeJobResult = SwaggerGetDigitizeJobResult;
13369
- type index_SwaggerGetExtractionResultResponse = SwaggerGetExtractionResultResponse;
13370
14746
  type index_TagEntity = TagEntity;
13371
14747
  type index_TaggedClassifier = TaggedClassifier;
13372
14748
  type index_TaggedExtractor = TaggedExtractor;
@@ -13385,8 +14761,8 @@ type index_WordGroup = WordGroup;
13385
14761
  type index_WordGroupType = WordGroupType;
13386
14762
  declare const index_WordGroupType: typeof WordGroupType;
13387
14763
  declare namespace index {
13388
- export { index_ActionStatus as ActionStatus, index_ClassifierDocumentTypeType as ClassifierDocumentTypeType, index_ComparisonOperator as ComparisonOperator, index_CreateTaskPriority as CreateTaskPriority, index_Criticality as Criticality, index_DocumentActionPriority as DocumentActionPriority, index_DocumentActionStatus as DocumentActionStatus, index_DocumentActionType as DocumentActionType, index_FieldType as FieldType, index_GptFieldType as GptFieldType, index_LogicalOperator as LogicalOperator, index_MarkupType as MarkupType, index_ModelKind as ModelKind, index_ModelType as ModelType, index_ProcessingSource as ProcessingSource, index_ProjectProperties as ProjectProperties, index_ProjectType as ProjectType, index_ResourceStatus as ResourceStatus, index_ResourceType as ResourceType, index_ResultsDataSource as ResultsDataSource, index_Rotation as Rotation, index_RuleType as RuleType, index_SectionType as SectionType, index_TextType as TextType, index_ValidationDisplayMode as ValidationDisplayMode, index_WordGroupType as WordGroupType };
13389
- export type { index_ClassificationPrompt as ClassificationPrompt, index_ClassificationRequestBody as ClassificationRequestBody, index_ClassificationResponse as ClassificationResponse, index_ClassificationResult as ClassificationResult, index_ClassificationValidationConfiguration as ClassificationValidationConfiguration, index_ClassificationValidationFinishedTaskInfo as ClassificationValidationFinishedTaskInfo, index_ClassificationValidationResult as ClassificationValidationResult, index_Classifier as Classifier, index_ContentValidationData as ContentValidationData, index_DataDeletionRequest as DataDeletionRequest, index_DataSource as DataSource, index_DiscoveredDocumentType as DiscoveredDocumentType, index_DiscoveredExtractorResourceSummaryResponse as DiscoveredExtractorResourceSummaryResponse, index_DiscoveredProjectVersionResponseV2_0 as DiscoveredProjectVersionResponseV2_0, index_DiscoveredResourceSummaryResponse as DiscoveredResourceSummaryResponse, index_DocumentClassificationActionDataModel as DocumentClassificationActionDataModel, index_DocumentEntity as DocumentEntity, index_DocumentExtractionActionDataModel as DocumentExtractionActionDataModel, index_DocumentGroup as DocumentGroup, index_DocumentTaxonomy as DocumentTaxonomy, index_DocumentTypeEntity as DocumentTypeEntity, index_ErrorResponse as ErrorResponse, index_ExceptionReasonOption as ExceptionReasonOption, index_ExtractRequestBodyConfiguration as ExtractRequestBodyConfiguration, index_ExtractRequestBodyV2_0 as ExtractRequestBodyV2_0, index_ExtractSyncResult as ExtractSyncResult, index_ExtractionPrompt as ExtractionPrompt, index_ExtractionPromptRequestBody as ExtractionPromptRequestBody, index_ExtractionResult as ExtractionResult, index_ExtractionValidationArtifactsResult as ExtractionValidationArtifactsResult, index_ExtractionValidationConfigurationV2 as ExtractionValidationConfigurationV2, index_ExtractionValidationResult as ExtractionValidationResult, index_Extractor as Extractor, index_ExtractorPayload as ExtractorPayload, index_Field as Field, index_FieldGroupValueProjection as FieldGroupValueProjection, index_FieldValue as FieldValue, index_FieldValueProjection as FieldValueProjection, index_FieldValueResult as FieldValueResult, index_FinishExtractionValidationTaskInfo as FinishExtractionValidationTaskInfo, index_FolderBasedStartExtractionRequest as FolderBasedStartExtractionRequest, index_FolderBasedStartExtractionResponse as FolderBasedStartExtractionResponse, index_FolderModelsResponse as FolderModelsResponse, index_GetClassificationValidationTaskResponse as GetClassificationValidationTaskResponse, index_GetClassifierDetailsDocumentTypeResponse as GetClassifierDetailsDocumentTypeResponse, index_GetClassifierDetailsResponse as GetClassifierDetailsResponse, index_GetClassifiersResponse as GetClassifiersResponse, index_GetDocumentTypeDetailsByTagResponseV2_0 as GetDocumentTypeDetailsByTagResponseV2_0, index_GetDocumentTypeDetailsResponseV2_0 as GetDocumentTypeDetailsResponseV2_0, index_GetDocumentTypesResponse as GetDocumentTypesResponse, index_GetExtractionValidationArtifactsResultTaskResponse as GetExtractionValidationArtifactsResultTaskResponse, index_GetExtractionValidationArtifactsTaskResponse as GetExtractionValidationArtifactsTaskResponse, index_GetExtractionValidationTaskResponse as GetExtractionValidationTaskResponse, index_GetExtractorDetailsResponseV2_0 as GetExtractorDetailsResponseV2_0, index_GetExtractorsResponse as GetExtractorsResponse, index_GetModelDetailsResponse as GetModelDetailsResponse, index_GetModelsResponse as GetModelsResponse, index_GetProjectDetailsResponseV2_0 as GetProjectDetailsResponseV2_0, index_GetProjectTaxonomyResponse as GetProjectTaxonomyResponse, index_GetProjectsResponse as GetProjectsResponse, index_GetTagsResponse as GetTagsResponse, index_LanguageInfo as LanguageInfo, index_Metadata as Metadata, index_MetadataEntry as MetadataEntry, index_ModelSummaryResponse as ModelSummaryResponse, index_Page as Page, index_PageMarkup as PageMarkup, index_PageSection as PageSection, index_Project as Project, index_ReportAsExceptionSettings as ReportAsExceptionSettings, index_ResultsContentReference as ResultsContentReference, index_ResultsDataPoint as ResultsDataPoint, index_ResultsDerivedField as ResultsDerivedField, index_ResultsDocument as ResultsDocument, index_ResultsDocumentBounds as ResultsDocumentBounds, index_ResultsTable as ResultsTable, index_ResultsTableCell as ResultsTableCell, index_ResultsTableColumnInfo as ResultsTableColumnInfo, index_ResultsTableValue as ResultsTableValue, index_ResultsValue as ResultsValue, index_ResultsValueTokens as ResultsValueTokens, index_Rule as Rule, index_RuleResult as RuleResult, index_RuleSet as RuleSet, index_RuleSetResult as RuleSetResult, index_StartClassificationResponse as StartClassificationResponse, index_StartClassificationValidationTaskInfo as StartClassificationValidationTaskInfo, index_StartClassificationValidationTaskRequest as StartClassificationValidationTaskRequest, index_StartDigitizationFromAttachmentModel as StartDigitizationFromAttachmentModel, index_StartDigitizationResponse as StartDigitizationResponse, index_StartExtractionResponse as StartExtractionResponse, index_StartExtractionValidationArtifactsRequest as StartExtractionValidationArtifactsRequest, index_StartExtractionValidationTaskInfo as StartExtractionValidationTaskInfo, index_StartExtractionValidationTaskRequestV2_0 as StartExtractionValidationTaskRequestV2_0, index_StartValidationArtifactsTaskResponse as StartValidationArtifactsTaskResponse, index_StartValidationTaskResponse as StartValidationTaskResponse, index_SwaggerGetClassificationResultResponse as SwaggerGetClassificationResultResponse, index_SwaggerGetDigitizeJobResponse as SwaggerGetDigitizeJobResponse, index_SwaggerGetDigitizeJobResult as SwaggerGetDigitizeJobResult, index_SwaggerGetExtractionResultResponse as SwaggerGetExtractionResultResponse, index_TagEntity as TagEntity, index_TaggedClassifier as TaggedClassifier, index_TaggedExtractor as TaggedExtractor, index_TrackFinishClassificationValidationRequest as TrackFinishClassificationValidationRequest, index_TrackFinishExtractionValidationRequest as TrackFinishExtractionValidationRequest, index_TrackStartClassificationValidationRequest as TrackStartClassificationValidationRequest, index_TrackStartExtractionValidationRequest as TrackStartExtractionValidationRequest, index_TypeField as TypeField, index_UserData as UserData, index_Word as Word, index_WordGroup as WordGroup };
14764
+ export { index_ActionStatus as ActionStatus, index_ClassifierDocumentTypeType as ClassifierDocumentTypeType, index_ComparisonOperator as ComparisonOperator, index_CreateTaskPriority as CreateTaskPriority, index_Criticality as Criticality, index_DocumentActionPriority as DocumentActionPriority, index_DocumentActionStatus as DocumentActionStatus, index_DocumentActionType as DocumentActionType, index_ErrorSeverity as ErrorSeverity, index_FieldType as FieldType, index_GptFieldType as GptFieldType, index_JobStatus as JobStatus, index_LogicalOperator as LogicalOperator, index_MarkupType as MarkupType, index_ModelKind as ModelKind, index_ModelType as ModelType, index_ProcessingSource as ProcessingSource, index_ProjectProperties as ProjectProperties, index_ProjectType as ProjectType, index_ResourceStatus as ResourceStatus, index_ResourceType as ResourceType, index_ResultsDataSource as ResultsDataSource, index_Rotation as Rotation, index_RuleType as RuleType, index_SectionType as SectionType, index_TextType as TextType, index_ValidationDisplayMode as ValidationDisplayMode, index_WordGroupType as WordGroupType };
14765
+ export type { index_ClassificationPrompt as ClassificationPrompt, index_ClassificationRequestBody as ClassificationRequestBody, index_ClassificationResponse as ClassificationResponse, index_ClassificationResult as ClassificationResult, index_ClassificationValidationConfiguration as ClassificationValidationConfiguration, index_ClassificationValidationFinishedTaskInfo as ClassificationValidationFinishedTaskInfo, index_ClassificationValidationResult as ClassificationValidationResult, index_Classifier as Classifier, index_ContentValidationData as ContentValidationData, index_DataDeletionRequest as DataDeletionRequest, index_DataSource as DataSource, index_DiscoveredDocumentType as DiscoveredDocumentType, index_DiscoveredExtractorResourceSummaryResponse as DiscoveredExtractorResourceSummaryResponse, index_DiscoveredProjectVersionResponseV2_0 as DiscoveredProjectVersionResponseV2_0, index_DiscoveredResourceSummaryResponse as DiscoveredResourceSummaryResponse, index_DocumentClassificationActionDataModel as DocumentClassificationActionDataModel, index_DocumentEntity as DocumentEntity, index_DocumentExtractionActionDataModel as DocumentExtractionActionDataModel, index_DocumentGroup as DocumentGroup, index_DocumentTaxonomy as DocumentTaxonomy, index_DocumentTypeEntity as DocumentTypeEntity, index_ErrorResponse as ErrorResponse, index_ExceptionReasonOption as ExceptionReasonOption, index_ExtractRequestBodyConfiguration as ExtractRequestBodyConfiguration, index_ExtractRequestBodyV2_0 as ExtractRequestBodyV2_0, index_ExtractSyncResult as ExtractSyncResult, index_ExtractionPrompt as ExtractionPrompt, index_ExtractionPromptRequestBody as ExtractionPromptRequestBody, index_ExtractionResult as ExtractionResult, index_ExtractionValidationArtifactsResult as ExtractionValidationArtifactsResult, index_ExtractionValidationConfigurationV2 as ExtractionValidationConfigurationV2, index_ExtractionValidationResult as ExtractionValidationResult, index_Extractor as Extractor, index_ExtractorPayload as ExtractorPayload, index_Field as Field, index_FieldGroupValueProjection as FieldGroupValueProjection, index_FieldValue as FieldValue, index_FieldValueProjection as FieldValueProjection, index_FieldValueResult as FieldValueResult, index_FinishExtractionValidationTaskInfo as FinishExtractionValidationTaskInfo, index_FolderBasedStartExtractionRequest as FolderBasedStartExtractionRequest, index_FolderBasedStartExtractionResponse as FolderBasedStartExtractionResponse, index_FolderModelsResponse as FolderModelsResponse, index_GetClassificationResultResponse as GetClassificationResultResponse, index_GetClassificationValidationTaskResponse as GetClassificationValidationTaskResponse, index_GetClassifierDetailsDocumentTypeResponse as GetClassifierDetailsDocumentTypeResponse, index_GetClassifierDetailsResponse as GetClassifierDetailsResponse, index_GetClassifiersResponse as GetClassifiersResponse, index_GetDigitizeJobResponse as GetDigitizeJobResponse, index_GetDigitizeJobResult as GetDigitizeJobResult, index_GetDocumentTypeDetailsByTagResponseV2_0 as GetDocumentTypeDetailsByTagResponseV2_0, index_GetDocumentTypeDetailsResponseV2_0 as GetDocumentTypeDetailsResponseV2_0, index_GetDocumentTypesResponse as GetDocumentTypesResponse, index_GetExtractionResultResponse as GetExtractionResultResponse, index_GetExtractionValidationArtifactsResultTaskResponse as GetExtractionValidationArtifactsResultTaskResponse, index_GetExtractionValidationArtifactsTaskResponse as GetExtractionValidationArtifactsTaskResponse, index_GetExtractionValidationTaskResponse as GetExtractionValidationTaskResponse, index_GetExtractorDetailsResponseV2_0 as GetExtractorDetailsResponseV2_0, index_GetExtractorsResponse as GetExtractorsResponse, index_GetModelDetailsResponse as GetModelDetailsResponse, index_GetModelsResponse as GetModelsResponse, index_GetProjectDetailsResponseV2_0 as GetProjectDetailsResponseV2_0, index_GetProjectTaxonomyResponse as GetProjectTaxonomyResponse, index_GetProjectsResponse as GetProjectsResponse, index_GetTagsResponse as GetTagsResponse, index_LanguageInfo as LanguageInfo, index_Metadata as Metadata, index_MetadataEntry as MetadataEntry, index_ModelSummaryResponse as ModelSummaryResponse, index_Page as Page, index_PageMarkup as PageMarkup, index_PageSection as PageSection, index_Project as Project, index_ReportAsExceptionSettings as ReportAsExceptionSettings, index_ResultsContentReference as ResultsContentReference, index_ResultsDataPoint as ResultsDataPoint, index_ResultsDerivedField as ResultsDerivedField, index_ResultsDocument as ResultsDocument, index_ResultsDocumentBounds as ResultsDocumentBounds, index_ResultsTable as ResultsTable, index_ResultsTableCell as ResultsTableCell, index_ResultsTableColumnInfo as ResultsTableColumnInfo, index_ResultsTableValue as ResultsTableValue, index_ResultsValue as ResultsValue, index_ResultsValueTokens as ResultsValueTokens, index_Rule as Rule, index_RuleResult as RuleResult, index_RuleSet as RuleSet, index_RuleSetResult as RuleSetResult, index_StartClassificationResponse as StartClassificationResponse, index_StartClassificationValidationTaskInfo as StartClassificationValidationTaskInfo, index_StartClassificationValidationTaskRequest as StartClassificationValidationTaskRequest, index_StartDigitizationFromAttachmentModel as StartDigitizationFromAttachmentModel, index_StartDigitizationResponse as StartDigitizationResponse, index_StartExtractionResponse as StartExtractionResponse, index_StartExtractionValidationArtifactsRequest as StartExtractionValidationArtifactsRequest, index_StartExtractionValidationTaskInfo as StartExtractionValidationTaskInfo, index_StartExtractionValidationTaskRequestV2_0 as StartExtractionValidationTaskRequestV2_0, index_StartValidationArtifactsTaskResponse as StartValidationArtifactsTaskResponse, index_StartValidationTaskResponse as StartValidationTaskResponse, index_SwaggerGetDigitizeJobResponse as SwaggerGetDigitizeJobResponse, index_SwaggerGetDigitizeJobResult as SwaggerGetDigitizeJobResult, index_TagEntity as TagEntity, index_TaggedClassifier as TaggedClassifier, index_TaggedExtractor as TaggedExtractor, index_TrackFinishClassificationValidationRequest as TrackFinishClassificationValidationRequest, index_TrackFinishExtractionValidationRequest as TrackFinishExtractionValidationRequest, index_TrackStartClassificationValidationRequest as TrackStartClassificationValidationRequest, index_TrackStartExtractionValidationRequest as TrackStartExtractionValidationRequest, index_TypeField as TypeField, index_UserData as UserData, index_Word as Word, index_WordGroup as WordGroup };
13390
14766
  }
13391
14767
 
13392
14768
  /**
@@ -13651,103 +15027,11 @@ declare enum UiPathMetaTags {
13651
15027
  FOLDER_KEY = "uipath:folder-key"
13652
15028
  }
13653
15029
 
13654
- /**
13655
- * Telemetry type definitions
13656
- */
13657
- interface TelemetryAttributes {
13658
- [key: string]: string | number | boolean;
13659
- }
13660
- interface TelemetryConfig {
13661
- baseUrl?: string;
13662
- orgName?: string;
13663
- tenantName?: string;
13664
- clientId?: string;
13665
- redirectUri?: string;
13666
- }
13667
- interface TrackOptions {
13668
- condition?: boolean | ((...args: any[]) => boolean);
13669
- attributes?: TelemetryAttributes;
13670
- }
13671
-
13672
- /**
13673
- * SDK Track decorator and function for telemetry
13674
- */
13675
-
13676
- /**
13677
- * Track decorator that can be used to automatically track function calls
13678
- *
13679
- * Usage:
13680
- * @track("Service.Method")
13681
- * function myFunction() { ... }
13682
- *
13683
- * @track("Queue.GetAll")
13684
- * async getAll() { ... }
13685
- *
13686
- * @track("Tasks.Create")
13687
- * async create() { ... }
13688
- *
13689
- * @track("Assets.Update", { condition: false })
13690
- * function myFunction() { ... }
13691
- *
13692
- * @track("Processes.Start", { attributes: { customProp: "value" } })
13693
- * function myFunction() { ... }
13694
- */
13695
- declare function track(nameOrOptions?: string | TrackOptions, options?: TrackOptions): MethodDecorator | ((target: any) => any);
13696
- /**
13697
- * Direct tracking function
13698
- */
13699
- declare function trackEvent(eventName: string, name?: string, attributes?: TelemetryAttributes): void;
13700
-
13701
- /**
13702
- * Singleton telemetry client
13703
- */
13704
- declare class TelemetryClient {
13705
- private static instance;
13706
- private isInitialized;
13707
- private logProvider?;
13708
- private logger?;
13709
- private telemetryContext?;
13710
- private constructor();
13711
- static getInstance(): TelemetryClient;
13712
- /**
13713
- * Initialize telemetry
13714
- */
13715
- initialize(config?: TelemetryConfig): void;
13716
- private getConnectionString;
13717
- private setupTelemetryProvider;
13718
- /**
13719
- * Track a telemetry event
13720
- */
13721
- track(eventName: string, name?: string, extraAttributes?: TelemetryAttributes): void;
13722
- /**
13723
- * Get enriched attributes for telemetry events
13724
- */
13725
- private getEnrichedAttributes;
13726
- /**
13727
- * Create cloud URL from base URL, organization ID, and tenant ID
13728
- */
13729
- private createCloudUrl;
13730
- }
13731
- declare const telemetryClient: TelemetryClient;
13732
-
13733
- /**
13734
- * SDK Telemetry constants
13735
- */
13736
- declare const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
13737
- declare const SDK_VERSION = "1.3.7";
13738
- declare const VERSION = "Version";
13739
- declare const SERVICE = "Service";
13740
- declare const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
13741
- declare const CLOUD_TENANT_NAME = "CloudTenantName";
13742
- declare const CLOUD_URL = "CloudUrl";
13743
- declare const CLOUD_CLIENT_ID = "CloudClientId";
13744
- declare const CLOUD_REDIRECT_URI = "CloudRedirectUri";
13745
- declare const APP_NAME = "ApplicationName";
13746
- declare const CLOUD_ROLE_NAME = "uipath-ts-sdk";
13747
- declare const SDK_SERVICE_NAME = "UiPath.TypeScript.Sdk";
13748
- declare const SDK_LOGGER_NAME = "uipath-ts-sdk-telemetry";
13749
- declare const SDK_RUN_EVENT = "Sdk.Run";
13750
- declare const UNKNOWN = "";
15030
+ declare const track: _uipath_core_telemetry.Track;
15031
+ declare const trackEvent: (eventName: string, name?: string, attributes?: _uipath_core_telemetry.TelemetryAttributes) => void;
15032
+ declare const telemetryClient: {
15033
+ initialize(context?: TelemetryContext): void;
15034
+ };
13751
15035
 
13752
- export { APP_NAME, AgentMap, AssetValueScope, AssetValueType, AuthenticationError, AuthorizationError, BucketOptions, CLOUD_CLIENT_ID, CLOUD_ORGANIZATION_NAME, CLOUD_REDIRECT_URI, CLOUD_ROLE_NAME, CLOUD_TENANT_NAME, CLOUD_URL, CONNECTION_STRING, CitationErrorType, ConversationMap, DEFAULT_ITEMS_FIELD, DEFAULT_PAGE_SIZE, DEFAULT_TOTAL_COUNT_FIELD, DataDirectionType, DebugMode, index as DuFramework, EntityAggregateFunction, EntityFieldDataType, EntityType, ErrorType, EscalationActionType, EscalationRecipientScope, EscalationTriggerType, ExchangeMap, FeedbackRating, FeedbackStatus, FieldDisplayType, HttpStatus, InputStreamSpeechSensitivity, InterruptType, JobPriority, JobSourceType, JobState, JobSubState, JobType, JoinType, LogicalOperator$1 as LogicalOperator, MAX_PAGE_SIZE, MessageMap, MessageRole, NetworkError, NotFoundError, PackageSourceType, PackageType, ProcessIncidentSeverity, ProcessIncidentStatus, ProcessIncidentType, QueryFilterOperator, RateLimitError, ReferenceType, RemoteControlAccess, RobotSize, RuntimeType, SDK_LOGGER_NAME, SDK_RUN_EVENT, SDK_SERVICE_NAME, SDK_VERSION, SERVICE, SLADurationUnit, ServerError, ServerlessJobType, SortOrder, StageTaskType, StartStrategy, StopStrategy, TargetFramework, TaskActivityType, TaskPriority, TaskSlaCriteria, TaskSlaStatus, TaskSourceName, TaskStatus, TaskType, TaskUserType, UNKNOWN, UiPath, UiPathError, UiPathMetaTags, UserSettingsMap, VERSION, ValidationError, createAgentWithMethods, createCaseInstanceWithMethods, createConversationWithMethods, createEntityWithMethods, createJobWithMethods, createProcessInstanceWithMethods, createProcessWithMethods, createTaskWithMethods, getAppBase, getAsset, getErrorDetails, getLimitedPageSize, isAuthenticationError, isAuthorizationError, isNetworkError, isNotFoundError, isRateLimitError, isServerError, isUiPathError, isValidationError, loadFromMetaTags, telemetryClient, track, trackEvent };
13753
- export type { AgentAppearance, AgentConversationServiceModel, AgentCreateConversationOptions, AgentGetByIdResponse, AgentGetResponse, AgentInput, AgentMethods, AgentStartingPrompt, ArgumentMetadata, AssetGetAllOptions, AssetGetByIdOptions, AssetGetByNameOptions, AssetGetResponse, AssetServiceModel, AsyncInputStream, AsyncInputStreamChunkEvent, AsyncInputStreamEndEvent, AsyncInputStreamEvent, AsyncInputStreamStartEvent, AsyncToolCallStream, AttachmentGetByIdOptions, AttachmentResponse, AttachmentServiceModel, BaseConfig, BaseOptions, BaseProcessStartRequest, BlobItem, BodyOptions, BpmnXmlString, BucketGetAllOptions, BucketGetByIdOptions, BucketGetFileMetaDataOptions, BucketGetFileMetaDataResponse, BucketGetFileMetaDataWithPaginationOptions, BucketGetReadUriOptions, BucketGetResponse, BucketGetUriOptions, BucketGetUriResponse, BucketServiceModel, BucketUploadFileOptions, BucketUploadResponse, CaseAppConfig, CaseAppOverview, CaseGetAllResponse, CaseGetStageResponse, CaseInstanceExecutionHistoryResponse, CaseInstanceGetAllOptions, CaseInstanceGetAllWithPaginationOptions, CaseInstanceGetResponse, CaseInstanceMethods, CaseInstanceOperationOptions, CaseInstanceOperationResponse, CaseInstanceReopenOptions, CaseInstanceRun, CaseInstancesServiceModel, CasesServiceModel, ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, Citation, CitationEndEvent, CitationError, CitationEvent, CitationOptions, CitationSource, CitationSourceBase, CitationSourceMedia, CitationSourceUrl, CitationStartEvent, CollectionResponse, CompletedContentPart, CompletedMessage, CompletedToolCall, ContentPart, ContentPartChunkEvent, ContentPartData, ContentPartEndEvent, ContentPartEvent, ContentPartGetResponse, ContentPartInterrupted, ContentPartStartEvent, ContentPartStartMetaData, ContentPartStream, ConversationAttachmentCreateResponse, ConversationAttachmentUploadResponse, ConversationCreateOptions, ConversationCreateResponse, ConversationDeleteResponse, ConversationEvent, ConversationExchangeServiceModel, ConversationGetAllOptions, ConversationGetResponse, ConversationJobStartOverrides, ConversationMethods, ConversationServiceModel, ConversationSessionMethods, ConversationSessionOptions, ConversationUpdateOptions, ConversationUpdateResponse, ConversationalAgentOptions, ConversationalAgentServiceModel, CreateFeedbackOptions, CustomKeyValuePair, ElementExecutionMetadata, ElementMetaData, ElementRunMetadata, EntityAggregate, EntityBatchInsertOptions, EntityBatchInsertResponse, EntityCreateFieldOptions, EntityCreateOptions, EntityDeleteAttachmentResponse, EntityDeleteOptions, EntityDeleteRecordsOptions, EntityDeleteResponse, EntityFieldBase, EntityFieldUpdateOptions, EntityFileType, EntityGetAllRecordsOptions, EntityGetRecordByIdOptions, EntityGetRecordsByIdOptions, EntityGetResponse, EntityImportRecordsResponse, EntityInsertOptions, EntityInsertRecordOptions, EntityInsertRecordsOptions, EntityInsertResponse, EntityMethods, EntityOperationOptions, EntityOperationResponse, EntityQueryFilter, EntityQueryFilterGroup, EntityQueryRecordsOptions, EntityQueryRecordsResponse, EntityQuerySortOption, EntityRecord, EntityRemoveFieldOptions, EntityServiceModel, EntityUpdateByIdOptions, EntityUpdateOptions, EntityUpdateRecordOptions, EntityUpdateRecordResponse, EntityUpdateRecordsOptions, EntityUpdateResponse, EntityUploadAttachmentOptions, EntityUploadAttachmentResponse, ErrorEndEvent, ErrorEvent, ErrorStartEvent, EscalationAction, EscalationRecipient, EscalationRule, EscalationTriggerMetadata, Exchange, ExchangeEndEvent, ExchangeEvent, ExchangeGetAllOptions, ExchangeGetByIdOptions, ExchangeGetResponse, ExchangeServiceModel, ExchangeStartEvent, ExchangeStream, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, ExternalValue, FailureRecord, FeatureFlags, FeedbackCategory, FeedbackCreateResponse, FeedbackGetAllOptions, FeedbackGetResponse, FeedbackOptions, FeedbackServiceModel, Field$1 as Field, FieldDataType, FieldMetaData, FileUploadAccess, FolderProperties, FolderScopedOptions, GenericInterruptStartEvent, GlobalVariableMetaData, HasPaginationOptions, Headers, HttpMethod, InlineOrExternalValue, InlineValue, Interrupt, InterruptEndEvent, InterruptEvent, InterruptStartEvent, JSONArray, JSONObject, JSONPrimitive, JSONValue, JobAttachment, JobError, JobGetAllOptions, JobGetByIdOptions, JobGetResponse, JobMethods, JobResumeOptions, JobServiceModel, JobStopOptions, LabelUpdatedEvent, Machine, MaestroProcessGetAllResponse, MaestroProcessesServiceModel, MakeOptional, MakeRequired, Message, MessageEndEvent, MessageEvent, MessageGetResponse, MessageServiceModel, MessageStartEvent, MessageStream, MetaData, MetaEvent, NonPaginatedResponse, OAuthFields, OperationResponse, PaginatedResponse, PaginationCursor, PaginationMetadata, PaginationMethodUnion, PaginationOptions, PartialUiPathConfig, ProcessGetAllOptions, ProcessGetByIdOptions, ProcessGetByNameOptions, ProcessGetResponse, ProcessIncidentGetAllResponse, ProcessIncidentGetResponse, ProcessIncidentsServiceModel, ProcessInstanceExecutionHistoryResponse, ProcessInstanceGetAllOptions, ProcessInstanceGetAllWithPaginationOptions, ProcessInstanceGetResponse, ProcessInstanceGetVariablesOptions, ProcessInstanceGetVariablesResponse, ProcessInstanceMethods, ProcessInstanceOperationOptions, ProcessInstanceOperationResponse, ProcessInstanceRun, ProcessInstancesServiceModel, ProcessMetadata, ProcessMethods, ProcessProperties, ProcessServiceModel, ProcessStartRequest, ProcessStartRequestWithKey, ProcessStartRequestWithName, ProcessStartResponse, QueryParams, QueueGetAllOptions, QueueGetByIdOptions, QueueGetResponse, QueueServiceModel, RawAgentGetByIdResponse, RawAgentGetResponse, RawCaseInstanceGetResponse, RawConversationGetResponse, RawEntityGetResponse, RawJobGetResponse, RawMaestroProcessGetAllResponse, RawProcessInstanceGetResponse, RawTaskCreateResponse, RawTaskGetResponse, RequestOptions, RequestSpec, ResponseDictionary, ResponseType, RetryOptions, RobotMetadata, SessionCapabilities, SessionEndEvent, SessionEndingEvent, SessionStartEvent, SessionStartedEvent, SessionStream, Simplify, SourceJoinCriteria, SqlType, StageSLA, StageTask, Tag, TaskActivity, TaskAssignOptions, TaskAssignment, TaskAssignmentOptions, TaskAssignmentResponse, TaskBaseResponse, TaskCompleteOptions, TaskCompletionOptions, TaskCreateOptions, TaskCreateResponse, TaskGetAllOptions, TaskGetByIdOptions, TaskGetResponse, TaskGetUsersOptions, TaskMethods, TaskServiceModel, TaskSlaDetail, TaskSource, TasksUnassignOptions, TimeoutOptions, ToolCall, ToolCallConfirmationEndValue, ToolCallConfirmationEvent, ToolCallConfirmationInterruptStartEvent, ToolCallConfirmationValue, ToolCallEndEvent, ToolCallEvent, ToolCallInputValue, ToolCallOutputValue, ToolCallResult, ToolCallStartEvent, ToolCallStream, UiPathSDKConfig, UserLoginInfo, UserSettingsGetResponse, UserSettingsServiceModel, UserSettingsUpdateOptions, UserSettingsUpdateResponse };
15036
+ export { AgentMap, AssetValueScope, AssetValueType, AuthenticationError, AuthorizationError, BucketOptions, CitationErrorType, ConversationGetAllFilterMap, ConversationMap, DEFAULT_ITEMS_FIELD, DEFAULT_PAGE_SIZE, DEFAULT_TOTAL_COUNT_FIELD, DataDirectionType, DebugMode, index as DuFramework, EntityAggregateFunction, EntityFieldDataType, EntityType, ErrorType, EscalationActionType, EscalationRecipientScope, EscalationTriggerType, ExchangeMap, FeedbackRating, FeedbackStatus, FieldDisplayType, HttpStatus, InputStreamSpeechSensitivity, InstanceFinalStatus, InstanceStatus, InterruptType, JobPriority, JobSourceType, JobState, JobSubState, JobType, JoinType, LogicalOperator$1 as LogicalOperator, MAX_PAGE_SIZE, MessageMap, MessageRole, NetworkError, NotFoundError, PackageSourceType, PackageType, ProcessIncidentSeverity, ProcessIncidentStatus, ProcessIncidentType, QueryFilterOperator, RateLimitError, ReferenceType, RemoteControlAccess, RobotSize, RuntimeType, SLADurationUnit, ServerError, ServerlessJobType, SlaSummaryStatus, SortOrder, StageTaskType, StartStrategy, StopStrategy, TargetFramework, TaskActivityType, TaskPriority, TaskSlaCriteria, TaskSlaStatus, TaskSourceName, TaskStatus, TaskType, TaskUserType, TimeInterval, UiPath, UiPathError, UiPathMetaTags, UserSettingsMap, ValidationError, createAgentWithMethods, createCaseInstanceWithMethods, createConversationWithMethods, createEntityWithMethods, createJobWithMethods, createProcessInstanceWithMethods, createProcessWithMethods, createTaskWithMethods, getAppBase, getAsset, getErrorDetails, getLimitedPageSize, isAuthenticationError, isAuthorizationError, isNetworkError, isNotFoundError, isRateLimitError, isServerError, isUiPathError, isValidationError, loadFromMetaTags, telemetryClient, track, trackEvent };
15037
+ export type { AgentAppearance, AgentConversationServiceModel, AgentCreateConversationOptions, AgentGetByIdResponse, AgentGetResponse, AgentInput, AgentMethods, AgentStartingPrompt, ArgumentMetadata, AssetGetAllOptions, AssetGetByIdOptions, AssetGetByNameOptions, AssetGetResponse, AssetServiceModel, AsyncInputStream, AsyncInputStreamChunkEvent, AsyncInputStreamEndEvent, AsyncInputStreamEvent, AsyncInputStreamStartEvent, AsyncToolCallStream, AttachmentGetByIdOptions, AttachmentResponse, AttachmentServiceModel, BaseConfig, BaseOptions, BaseProcessStartRequest, BlobItem, BodyOptions, BpmnXmlString, BucketGetAllOptions, BucketGetByIdOptions, BucketGetByNameOptions, BucketGetFileMetaDataOptions, BucketGetFileMetaDataResponse, BucketGetFileMetaDataWithPaginationOptions, BucketGetReadUriOptions, BucketGetResponse, BucketGetUriOptions, BucketGetUriResponse, BucketServiceModel, BucketUploadFileOptions, BucketUploadResponse, CaseAppConfig, CaseAppOverview, CaseGetAllResponse, CaseGetStageResponse, CaseGetTopDurationResponse, CaseGetTopFaultedCountResponse, CaseGetTopRunCountResponse, CaseInstanceExecutionHistoryResponse, CaseInstanceGetAllOptions, CaseInstanceGetAllWithPaginationOptions, CaseInstanceGetResponse, CaseInstanceMethods, CaseInstanceOperationOptions, CaseInstanceOperationResponse, CaseInstanceReopenOptions, CaseInstanceRun, CaseInstanceSlaSummaryOptions, CaseInstanceStageSLAOptions, CaseInstanceStageSLAResponse, CaseInstanceStageSLAStage, CaseInstancesServiceModel, CasesServiceModel, ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, Citation, CitationEndEvent, CitationError, CitationEvent, CitationOptions, CitationSource, CitationSourceBase, CitationSourceMedia, CitationSourceUrl, CitationStartEvent, CollectionResponse, CompletedContentPart, CompletedMessage, CompletedToolCall, ContentPart, ContentPartChunkEvent, ContentPartData, ContentPartEndEvent, ContentPartEvent, ContentPartGetResponse, ContentPartInterrupted, ContentPartStartEvent, ContentPartStartMetaData, ContentPartStream, ConversationAttachmentCreateResponse, ConversationAttachmentUploadResponse, ConversationCreateOptions, ConversationCreateResponse, ConversationDeleteResponse, ConversationEvent, ConversationExchangeServiceModel, ConversationGetAllOptions, ConversationGetResponse, ConversationJobStartOverrides, ConversationMethods, ConversationServiceModel, ConversationSessionMethods, ConversationSessionOptions, ConversationUpdateOptions, ConversationUpdateResponse, ConversationalAgentOptions, ConversationalAgentServiceModel, CreateFeedbackOptions, CustomKeyValuePair, ElementExecutionMetadata, ElementMetaData, ElementRunMetadata, EntityAggregate, EntityBatchInsertOptions, EntityBatchInsertResponse, EntityCreateFieldOptions, EntityCreateOptions, EntityDeleteAttachmentResponse, EntityDeleteOptions, EntityDeleteRecordsOptions, EntityDeleteResponse, EntityFieldBase, EntityFieldUpdateOptions, EntityFileType, EntityGetAllRecordsOptions, EntityGetRecordByIdOptions, EntityGetRecordsByIdOptions, EntityGetResponse, EntityImportRecordsResponse, EntityInsertOptions, EntityInsertRecordOptions, EntityInsertRecordsOptions, EntityInsertResponse, EntityMethods, EntityOperationOptions, EntityOperationResponse, EntityQueryFilter, EntityQueryFilterGroup, EntityQueryRecordsOptions, EntityQueryRecordsResponse, EntityQuerySortOption, EntityRecord, EntityRemoveFieldOptions, EntityServiceModel, EntityUpdateByIdOptions, EntityUpdateOptions, EntityUpdateRecordOptions, EntityUpdateRecordResponse, EntityUpdateRecordsOptions, EntityUpdateResponse, EntityUploadAttachmentOptions, EntityUploadAttachmentResponse, ErrorEndEvent, ErrorEvent, ErrorStartEvent, EscalationAction, EscalationRecipient, EscalationRule, EscalationTriggerMetadata, Exchange, ExchangeEndEvent, ExchangeEvent, ExchangeGetAllOptions, ExchangeGetByIdOptions, ExchangeGetResponse, ExchangeServiceModel, ExchangeStartEvent, ExchangeStream, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, ExternalValue, FailureRecord, FeatureFlags, FeedbackCategory, FeedbackCategoryInput, FeedbackCategoryResponse, FeedbackCreateCategoryOptions, FeedbackCreateResponse, FeedbackDeleteCategoryOptions, FeedbackGetAllOptions, FeedbackGetCategoriesOptions, FeedbackGetResponse, FeedbackOptions, FeedbackResponse, FeedbackServiceModel, FeedbackSubmitOptions, FeedbackUpdateOptions, Field$1 as Field, FieldDataType, FieldMetaData, FileUploadAccess, FolderProperties, FolderScopedOptions, GenericInterruptStartEvent, GetTopBaseResponse, GetTopDurationResponse, GetTopFaultedCountResponse, GetTopRunCountResponse, GlobalVariableMetaData, HasPaginationOptions, Headers, HttpMethod, InlineOrExternalValue, InlineValue, InstanceStatusTimelineResponse, Interrupt, InterruptEndEvent, InterruptEvent, InterruptStartEvent, JSONArray, JSONObject, JSONPrimitive, JSONValue, JobAttachment, JobError, JobGetAllOptions, JobGetByIdOptions, JobGetResponse, JobMethods, JobResumeOptions, JobServiceModel, JobStopOptions, LabelUpdatedEvent, Machine, MaestroProcessGetAllResponse, MaestroProcessesServiceModel, MakeOptional, MakeRequired, Message, MessageEndEvent, MessageEvent, MessageGetResponse, MessageServiceModel, MessageStartEvent, MessageStream, MetaData, MetaEvent, NonPaginatedResponse, OAuthFields, OperationResponse, PaginatedResponse, PaginationCursor, PaginationMetadata, PaginationMethodUnion, PaginationOptions, PartialUiPathConfig, ProcessGetAllOptions, ProcessGetByIdOptions, ProcessGetByNameOptions, ProcessGetResponse, ProcessGetTopDurationResponse, ProcessGetTopFaultedCountResponse, ProcessGetTopRunCountResponse, ProcessIncidentGetAllResponse, ProcessIncidentGetResponse, ProcessIncidentsServiceModel, ProcessInstanceExecutionHistoryResponse, ProcessInstanceGetAllOptions, ProcessInstanceGetAllWithPaginationOptions, ProcessInstanceGetResponse, ProcessInstanceGetVariablesOptions, ProcessInstanceGetVariablesResponse, ProcessInstanceMethods, ProcessInstanceOperationOptions, ProcessInstanceOperationResponse, ProcessInstanceRun, ProcessInstancesServiceModel, ProcessMetadata, ProcessMethods, ProcessProperties, ProcessServiceModel, ProcessStartRequest, ProcessStartRequestWithKey, ProcessStartRequestWithName, ProcessStartResponse, QueryParams, QueueGetAllOptions, QueueGetByIdOptions, QueueGetResponse, QueueServiceModel, RawAgentGetByIdResponse, RawAgentGetResponse, RawCaseInstanceGetResponse, RawConversationGetResponse, RawEntityGetResponse, RawJobGetResponse, RawMaestroProcessGetAllResponse, RawProcessInstanceGetResponse, RawTaskCreateResponse, RawTaskGetResponse, RequestOptions, RequestSpec, ResponseDictionary, ResponseType, RetryOptions, RobotMetadata, SessionCapabilities, SessionEndEvent, SessionEndingEvent, SessionStartEvent, SessionStartedEvent, SessionStream, Simplify, SlaSummaryResponse, SourceJoinCriteria, SqlType, StageSLA, StageTask, Tag, TaskActivity, TaskAssignOptions, TaskAssignment, TaskAssignmentOptions, TaskAssignmentResponse, TaskBaseResponse, TaskCompleteOptions, TaskCompletionOptions, TaskCreateOptions, TaskCreateResponse, TaskGetAllOptions, TaskGetByIdOptions, TaskGetResponse, TaskGetUsersOptions, TaskMethods, TaskServiceModel, TaskSlaDetail, TaskSource, TasksUnassignOptions, TimelineOptions, TimeoutOptions, ToolCall, ToolCallConfirmationEndValue, ToolCallConfirmationEvent, ToolCallConfirmationInterruptStartEvent, ToolCallConfirmationValue, ToolCallEndEvent, ToolCallEvent, ToolCallInputValue, ToolCallOutputValue, ToolCallResult, ToolCallStartEvent, ToolCallStream, TopQueryOptions, UiPathSDKConfig, UserLoginInfo, UserSettingsGetResponse, UserSettingsServiceModel, UserSettingsUpdateOptions, UserSettingsUpdateResponse };