@uipath/uipath-typescript 1.3.8 → 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 (39) hide show
  1. package/dist/assets/index.cjs +25 -270
  2. package/dist/assets/index.mjs +25 -270
  3. package/dist/attachments/index.cjs +23 -267
  4. package/dist/attachments/index.mjs +23 -267
  5. package/dist/buckets/index.cjs +54 -270
  6. package/dist/buckets/index.d.ts +50 -1
  7. package/dist/buckets/index.mjs +54 -270
  8. package/dist/cases/index.cjs +408 -337
  9. package/dist/cases/index.d.ts +534 -2
  10. package/dist/cases/index.mjs +409 -338
  11. package/dist/conversational-agent/index.cjs +71 -281
  12. package/dist/conversational-agent/index.d.ts +62 -12
  13. package/dist/conversational-agent/index.mjs +71 -282
  14. package/dist/core/index.cjs +39 -289
  15. package/dist/core/index.d.ts +9 -98
  16. package/dist/core/index.mjs +40 -275
  17. package/dist/document-understanding/index.cjs +18 -1
  18. package/dist/document-understanding/index.d.ts +636 -610
  19. package/dist/document-understanding/index.mjs +18 -1
  20. package/dist/entities/index.cjs +25 -270
  21. package/dist/entities/index.mjs +25 -270
  22. package/dist/feedback/index.cjs +23 -268
  23. package/dist/feedback/index.mjs +23 -268
  24. package/dist/index.cjs +600 -293
  25. package/dist/index.d.ts +1603 -722
  26. package/dist/index.mjs +600 -279
  27. package/dist/index.umd.js +789 -158
  28. package/dist/jobs/index.cjs +25 -270
  29. package/dist/jobs/index.mjs +25 -270
  30. package/dist/maestro-processes/index.cjs +1751 -1720
  31. package/dist/maestro-processes/index.d.ts +430 -2
  32. package/dist/maestro-processes/index.mjs +1752 -1721
  33. package/dist/processes/index.cjs +25 -270
  34. package/dist/processes/index.mjs +25 -270
  35. package/dist/queues/index.cjs +25 -270
  36. package/dist/queues/index.mjs +25 -270
  37. package/dist/tasks/index.cjs +25 -270
  38. package/dist/tasks/index.mjs +25 -270
  39. 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
  */
@@ -2668,10 +2671,107 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
2668
2671
  getById<T extends ChoiceSetGetByIdOptions = ChoiceSetGetByIdOptions>(choiceSetId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ChoiceSetGetResponse> : NonPaginatedResponse<ChoiceSetGetResponse>>;
2669
2672
  }
2670
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
+
2671
2770
  /**
2672
2771
  * Maestro Process Types
2673
2772
  * Types and interfaces for Maestro process management
2674
2773
  */
2774
+
2675
2775
  /**
2676
2776
  * Process information with instance statistics
2677
2777
  */
@@ -2711,6 +2811,27 @@ interface RawMaestroProcessGetAllResponse {
2711
2811
  /** Process instance count - canceling */
2712
2812
  cancelingCount: number;
2713
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
+ }
2714
2835
 
2715
2836
  /**
2716
2837
  * Process Incident Status
@@ -2838,6 +2959,161 @@ interface MaestroProcessesServiceModel {
2838
2959
  * ```
2839
2960
  */
2840
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[]>;
2841
3117
  }
2842
3118
  interface ProcessMethods {
2843
3119
  /**
@@ -3376,6 +3652,7 @@ interface ProcessIncidentsServiceModel {
3376
3652
  * Maestro Cases Types
3377
3653
  * Types and interfaces for Maestro case management
3378
3654
  */
3655
+
3379
3656
  /**
3380
3657
  * Case information with instance statistics
3381
3658
  */
@@ -3415,6 +3692,27 @@ interface CaseGetAllResponse {
3415
3692
  /** Case instance count - canceling */
3416
3693
  cancelingCount: number;
3417
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
+ }
3418
3716
 
3419
3717
  /**
3420
3718
  * Maestro Cases Models
@@ -3455,6 +3753,161 @@ interface CasesServiceModel {
3455
3753
  * ```
3456
3754
  */
3457
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[]>;
3458
3911
  }
3459
3912
 
3460
3913
  /**
@@ -3616,6 +4069,41 @@ type CaseInstanceSlaSummaryOptions = PaginationOptions & {
3616
4069
  /** Filter by event end time in UTC */
3617
4070
  endTimeUtc?: Date;
3618
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
+ }
3619
4107
  /**
3620
4108
  * Case stage task type
3621
4109
  */
@@ -4339,6 +4827,11 @@ declare function createTaskWithMethods(taskData: RawTaskGetResponse | RawTaskCre
4339
4827
  * const caseInstances = new CaseInstances(sdk);
4340
4828
  * const allInstances = await caseInstances.getAll();
4341
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.
4342
4835
  */
4343
4836
  interface CaseInstancesServiceModel {
4344
4837
  /**
@@ -4606,6 +5099,35 @@ interface CaseInstancesServiceModel {
4606
5099
  * ```
4607
5100
  */
4608
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[]>;
4609
5131
  }
4610
5132
  interface CaseInstanceMethods {
4611
5133
  /**
@@ -4663,6 +5185,12 @@ interface CaseInstanceMethods {
4663
5185
  * @returns Promise resolving to SLA summary items for this case instance
4664
5186
  */
4665
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[]>;
4666
5194
  }
4667
5195
  type CaseInstanceGetResponse = RawCaseInstanceGetResponse & CaseInstanceMethods;
4668
5196
  /**
@@ -4686,29 +5214,184 @@ declare class MaestroProcessesService extends BaseService implements MaestroProc
4686
5214
  */
4687
5215
  constructor(instance: IUiPath);
4688
5216
  /**
4689
- * Get all processes with their instance statistics
4690
- * @returns Promise resolving to array of MaestroProcess objects
5217
+ * Get all processes with their instance statistics
5218
+ * @returns Promise resolving to array of MaestroProcess objects
5219
+ *
5220
+ * @example
5221
+ * ```typescript
5222
+ * import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
5223
+ *
5224
+ * const maestroProcesses = new MaestroProcesses(sdk);
5225
+ * const processes = await maestroProcesses.getAll();
5226
+ *
5227
+ * // Access process information
5228
+ * for (const process of processes) {
5229
+ * console.log(`Process: ${process.processKey}`);
5230
+ * console.log(`Running instances: ${process.runningCount}`);
5231
+ * console.log(`Faulted instances: ${process.faultedCount}`);
5232
+ * }
5233
+ * ```
5234
+ */
5235
+ getAll(): Promise<MaestroProcessGetAllResponse[]>;
5236
+ /**
5237
+ * Get incidents for a specific process
5238
+ */
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.
4691
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}
4692
5329
  * @example
4693
5330
  * ```typescript
4694
5331
  * import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
4695
5332
  *
4696
5333
  * const maestroProcesses = new MaestroProcesses(sdk);
4697
- * const processes = await maestroProcesses.getAll();
4698
5334
  *
4699
- * // Access process information
4700
- * for (const process of processes) {
4701
- * console.log(`Process: ${process.processKey}`);
4702
- * console.log(`Running instances: ${process.runningCount}`);
4703
- * console.log(`Faulted instances: ${process.faultedCount}`);
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`);
4704
5343
  * }
4705
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
+ * ```
4706
5355
  */
4707
- getAll(): Promise<MaestroProcessGetAllResponse[]>;
5356
+ getTopFaultedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopFaultedCountResponse[]>;
4708
5357
  /**
4709
- * Get incidents for a specific process
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
+ * ```
4710
5393
  */
4711
- getIncidents(processKey: string, folderKey: string): Promise<ProcessIncidentGetResponse[]>;
5394
+ getTopExecutionDuration(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopDurationResponse[]>;
4712
5395
  }
4713
5396
 
4714
5397
  declare class ProcessInstancesService extends BaseService implements ProcessInstancesServiceModel {
@@ -4888,6 +5571,161 @@ declare class CasesService extends BaseService implements CasesServiceModel {
4888
5571
  * ```
4889
5572
  */
4890
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[]>;
4891
5729
  /**
4892
5730
  * Extract a readable case name from the packageId
4893
5731
  * @param packageId - The full package identifier
@@ -5114,6 +5952,35 @@ declare class CaseInstancesService extends BaseService implements CaseInstancesS
5114
5952
  * ```
5115
5953
  */
5116
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[]>;
5117
5984
  }
5118
5985
 
5119
5986
  /**
@@ -5428,6 +6295,11 @@ type BucketGetAllOptions = RequestOptions & PaginationOptions & {
5428
6295
  };
5429
6296
  interface BucketGetByIdOptions extends BaseOptions {
5430
6297
  }
6298
+ /**
6299
+ * Options for getting a single bucket by name
6300
+ */
6301
+ interface BucketGetByNameOptions extends FolderScopedOptions {
6302
+ }
5431
6303
  /**
5432
6304
  * Maps header names to their values
5433
6305
  *
@@ -5638,6 +6510,26 @@ interface BucketServiceModel {
5638
6510
  * ```
5639
6511
  */
5640
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>' });
6530
+ * ```
6531
+ */
6532
+ getByName(name: string, options?: BucketGetByNameOptions): Promise<BucketGetResponse>;
5641
6533
  /**
5642
6534
  * Gets metadata for files in a bucket with optional filtering and pagination
5643
6535
  *
@@ -5736,6 +6628,30 @@ declare class BucketService extends FolderScopedService implements BucketService
5736
6628
  * ```
5737
6629
  */
5738
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>;
5739
6655
  /**
5740
6656
  * Gets all buckets across folders with optional filtering and folder scoping
5741
6657
  *
@@ -7591,6 +8507,15 @@ declare function loadFromMetaTags(): MetaTagConfig | null;
7591
8507
  declare const ConversationMap: {
7592
8508
  [key: string]: string;
7593
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
+ };
7594
8519
  /**
7595
8520
  * Maps fields for Exchange entity to ensure consistent SDK naming
7596
8521
  */
@@ -11179,8 +12104,12 @@ interface ConversationServiceModel {
11179
12104
  /**
11180
12105
  * Gets all conversations with optional filtering and pagination
11181
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
+ *
11182
12111
  * @param options - Options for querying conversations including optional pagination parameters
11183
- * @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
11184
12113
  *
11185
12114
  * @example Basic usage - get all conversations
11186
12115
  * ```typescript
@@ -11211,6 +12140,14 @@ interface ConversationServiceModel {
11211
12140
  * pageSize: 20
11212
12141
  * });
11213
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
+ * ```
11214
12151
  */
11215
12152
  getAll<T extends ConversationGetAllOptions = ConversationGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ConversationGetResponse> : NonPaginatedResponse<ConversationGetResponse>>;
11216
12153
  /**
@@ -11603,6 +12540,14 @@ interface ConversationUpdateOptions {
11603
12540
  type ConversationGetAllOptions = PaginationOptions & {
11604
12541
  /** Sort order for conversations */
11605
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;
11606
12551
  };
11607
12552
  /**
11608
12553
  * File upload access details for uploading file content to blob storage
@@ -11748,8 +12693,10 @@ interface RawAgentGetResponse {
11748
12693
  description: string;
11749
12694
  /** Process version */
11750
12695
  processVersion: string;
11751
- /** Process key identifier */
12696
+ /** Process key identifier (a dotted-path string like `Solution.Package.Agent`) */
11752
12697
  processKey: string;
12698
+ /** GUID key of the agent release */
12699
+ releaseKey?: string;
11753
12700
  /** Folder ID */
11754
12701
  folderId: number;
11755
12702
  /** Feed ID */
@@ -12624,8 +13571,8 @@ declare enum DocumentActionType {
12624
13571
  Classification = "Classification"
12625
13572
  }
12626
13573
  interface UserData {
12627
- id?: number | null;
12628
- emailAddress?: string | null;
13574
+ Id?: number | null;
13575
+ EmailAddress?: string | null;
12629
13576
  }
12630
13577
 
12631
13578
  declare enum ComparisonOperator {
@@ -12674,103 +13621,96 @@ declare enum RuleType {
12674
13621
  IsEmpty = "IsEmpty"
12675
13622
  }
12676
13623
  interface DataSource {
12677
- resourceId?: string | null;
12678
- elementFieldId?: string | null;
13624
+ ResourceId?: string | null;
13625
+ ElementFieldId?: string | null;
12679
13626
  }
12680
13627
  interface DocumentGroup {
12681
- name?: string | null;
12682
- categories?: string[] | null;
13628
+ Name?: string | null;
13629
+ Categories?: string[] | null;
12683
13630
  }
12684
13631
  interface DocumentTaxonomy {
12685
- dataContractVersion?: string | null;
12686
- documentTypes?: DocumentTypeEntity[] | null;
12687
- groups?: DocumentGroup[] | null;
12688
- supportedLanguages?: LanguageInfo[] | null;
12689
- reportAsExceptionSettings?: ReportAsExceptionSettings;
13632
+ DataContractVersion?: string | null;
13633
+ DocumentTypes?: DocumentTypeEntity[] | null;
13634
+ Groups?: DocumentGroup[] | null;
13635
+ SupportedLanguages?: LanguageInfo[] | null;
13636
+ ReportAsExceptionSettings?: ReportAsExceptionSettings;
12690
13637
  }
12691
13638
  interface DocumentTypeEntity {
12692
- documentTypeId?: string | null;
12693
- group?: string | null;
12694
- category?: string | null;
12695
- name?: string | null;
12696
- optionalUniqueIdentifier?: string | null;
12697
- typeField?: TypeField;
12698
- fields?: Field[] | null;
12699
- 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;
12700
13647
  }
12701
13648
  interface ExceptionReasonOption {
12702
- exceptionReason?: string | null;
13649
+ ExceptionReason?: string | null;
12703
13650
  }
12704
13651
  interface Field {
12705
- fieldId?: string | null;
12706
- fieldName?: string | null;
12707
- isMultiValue?: boolean;
12708
- type?: FieldType;
12709
- deriveFieldsFormat?: string | null;
12710
- components?: Field[] | null;
12711
- setValues?: string[] | null;
12712
- metadata?: MetadataEntry[] | null;
12713
- ruleSet?: RuleSet;
12714
- defaultValue?: string | null;
12715
- 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;
12716
13663
  }
12717
13664
  interface LanguageInfo {
12718
- name?: string | null;
12719
- code?: string | null;
13665
+ Name?: string | null;
13666
+ Code?: string | null;
12720
13667
  }
12721
13668
  interface MetadataEntry {
12722
- key?: string | null;
12723
- value?: string | null;
13669
+ Key?: string | null;
13670
+ Value?: string | null;
12724
13671
  }
12725
13672
  interface ReportAsExceptionSettings {
12726
- exceptionReasonOptions?: ExceptionReasonOption[] | null;
13673
+ ExceptionReasonOptions?: ExceptionReasonOption[] | null;
12727
13674
  }
12728
13675
  interface Rule {
12729
- name?: string | null;
12730
- type?: RuleType;
12731
- logicalOperator?: LogicalOperator;
12732
- comparisonOperator?: ComparisonOperator;
12733
- expression?: string | null;
12734
- setValues?: string[] | null;
13676
+ Name?: string | null;
13677
+ Type?: RuleType;
13678
+ LogicalOperator?: LogicalOperator;
13679
+ ComparisonOperator?: ComparisonOperator;
13680
+ Expression?: string | null;
13681
+ SetValues?: string[] | null;
12735
13682
  }
12736
13683
  interface RuleSet {
12737
- criticality?: Criticality;
12738
- rules?: Rule[] | null;
13684
+ Criticality?: Criticality;
13685
+ Rules?: Rule[] | null;
12739
13686
  }
12740
13687
  interface TypeField {
12741
- fieldId?: string | null;
12742
- fieldName?: string | null;
13688
+ FieldId?: string | null;
13689
+ FieldName?: string | null;
12743
13690
  }
12744
13691
 
12745
13692
  interface FieldValue {
12746
- value?: string | null;
12747
- derivedValue?: string | null;
13693
+ Value?: string | null;
13694
+ DerivedValue?: string | null;
12748
13695
  }
12749
13696
  interface FieldValueResult {
12750
- value?: FieldValue;
12751
- isValid?: boolean;
12752
- rules?: RuleResult[] | null;
13697
+ Value?: FieldValue;
13698
+ IsValid?: boolean;
13699
+ Rules?: RuleResult[] | null;
12753
13700
  }
12754
13701
  interface RuleResult {
12755
- rule?: Rule;
12756
- isValid?: boolean;
13702
+ Rule?: Rule;
13703
+ IsValid?: boolean;
12757
13704
  }
12758
13705
  interface RuleSetResult {
12759
- fieldId?: string | null;
12760
- fieldType?: FieldType;
12761
- criticality?: Criticality;
12762
- isValid?: boolean;
12763
- results?: FieldValueResult[] | null;
12764
- brokenRules?: Rule[] | null;
12765
- rowIndex?: number | null;
12766
- tableFieldId?: string | null;
12767
- }
12768
-
12769
- interface ErrorResponse {
12770
- message?: string | null;
12771
- severity?: 'Info' | 'Warning' | 'Error';
12772
- code?: string | null;
12773
- 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;
12774
13714
  }
12775
13715
 
12776
13716
  declare enum ClassifierDocumentTypeType {
@@ -12793,101 +13733,107 @@ declare enum GptFieldType {
12793
13733
  Number = "Number",
12794
13734
  Text = "Text"
12795
13735
  }
13736
+ declare enum JobStatus {
13737
+ Succeeded = "Succeeded",
13738
+ Failed = "Failed",
13739
+ Running = "Running",
13740
+ NotStarted = "NotStarted"
13741
+ }
12796
13742
  declare enum ValidationDisplayMode {
12797
13743
  Classic = "Classic",
12798
13744
  Compact = "Compact"
12799
13745
  }
12800
13746
  interface ClassificationPrompt {
12801
- name?: string | null;
12802
- description?: string | null;
13747
+ Name?: string | null;
13748
+ Description?: string | null;
12803
13749
  }
12804
13750
  interface ClassificationValidationConfiguration {
12805
- enablePageReordering?: boolean;
13751
+ EnablePageReordering?: boolean;
12806
13752
  }
12807
13753
  interface ContentValidationData {
12808
- bucketName?: string | null;
12809
- bucketId?: number;
12810
- folderId?: number;
12811
- folderKey?: string;
12812
- documentId?: string;
12813
- encodedDocumentPath?: string | null;
12814
- textPath?: string | null;
12815
- documentObjectModelPath?: string | null;
12816
- taxonomyPath?: string | null;
12817
- automaticExtractionResultsPath?: string | null;
12818
- validatedExtractionResultsPath?: string | null;
12819
- 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;
12820
13766
  }
12821
13767
  interface DocumentClassificationActionDataModel {
12822
- id?: number | null;
12823
- status?: DocumentActionStatus;
12824
- title?: string | null;
12825
- priority?: DocumentActionPriority;
12826
- taskCatalogName?: string | null;
12827
- taskUrl?: string | null;
12828
- folderPath?: string | null;
12829
- folderId?: number | null;
12830
- data?: unknown | null;
12831
- action?: string | null;
12832
- isDeleted?: boolean | null;
12833
- assignedToUser?: UserData;
12834
- creatorUser?: UserData;
12835
- deleterUser?: UserData;
12836
- lastModifierUser?: UserData;
12837
- completedByUser?: UserData;
12838
- creationTime?: string | null;
12839
- lastAssignedTime?: string | null;
12840
- completionTime?: string | null;
12841
- processingTime?: number | null;
12842
- 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;
12843
13789
  }
12844
13790
  interface DocumentExtractionActionDataModel {
12845
- id?: number | null;
12846
- status?: DocumentActionStatus;
12847
- title?: string | null;
12848
- priority?: DocumentActionPriority;
12849
- taskCatalogName?: string | null;
12850
- taskUrl?: string | null;
12851
- folderPath?: string | null;
12852
- folderId?: number | null;
12853
- data?: unknown | null;
12854
- action?: string | null;
12855
- isDeleted?: boolean | null;
12856
- assignedToUser?: UserData;
12857
- creatorUser?: UserData;
12858
- deleterUser?: UserData;
12859
- lastModifierUser?: UserData;
12860
- completedByUser?: UserData;
12861
- creationTime?: string | null;
12862
- lastAssignedTime?: string | null;
12863
- completionTime?: string | null;
12864
- processingTime?: number | null;
12865
- 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;
12866
13812
  }
12867
13813
  interface ExtractionPrompt {
12868
- id?: string | null;
12869
- question?: string | null;
12870
- fieldType?: GptFieldType;
12871
- multiValued?: boolean | null;
13814
+ Id?: string | null;
13815
+ Question?: string | null;
13816
+ FieldType?: GptFieldType;
13817
+ MultiValued?: boolean | null;
12872
13818
  }
12873
13819
  interface ExtractionValidationConfigurationV2 {
12874
- enableRtlControls?: boolean;
12875
- displayMode?: ValidationDisplayMode;
12876
- fieldsValidationConfidence?: number | null;
12877
- allowChangeOfDocumentType?: boolean | null;
13820
+ EnableRtlControls?: boolean;
13821
+ DisplayMode?: ValidationDisplayMode;
13822
+ FieldsValidationConfidence?: number | null;
13823
+ AllowChangeOfDocumentType?: boolean | null;
12878
13824
  }
12879
13825
  interface FieldGroupValueProjection {
12880
- fieldGroupName?: string | null;
12881
- fieldValues?: FieldValueProjection[] | null;
13826
+ FieldGroupName?: string | null;
13827
+ FieldValues?: FieldValueProjection[] | null;
12882
13828
  }
12883
13829
  interface FieldValueProjection {
12884
- id?: string | null;
12885
- name?: string | null;
12886
- value?: string | null;
12887
- unformattedValue?: string | null;
12888
- confidence?: number | null;
12889
- ocrConfidence?: number | null;
12890
- 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;
12891
13837
  }
12892
13838
 
12893
13839
  declare enum MarkupType {
@@ -12938,59 +13884,59 @@ declare enum WordGroupType {
12938
13884
  Other = "Other"
12939
13885
  }
12940
13886
  interface DocumentEntity {
12941
- documentId?: string | null;
12942
- contentType?: string | null;
12943
- length?: number;
12944
- pages?: Page[] | null;
12945
- documentMetadata?: Metadata[] | null;
13887
+ DocumentId?: string | null;
13888
+ ContentType?: string | null;
13889
+ Length?: number;
13890
+ Pages?: Page[] | null;
13891
+ DocumentMetadata?: Metadata[] | null;
12946
13892
  }
12947
13893
  interface Metadata {
12948
- key?: string | null;
12949
- value?: string | null;
13894
+ Key?: string | null;
13895
+ Value?: string | null;
12950
13896
  }
12951
13897
  interface Page {
12952
- pageIndex?: number;
12953
- size?: number[];
12954
- sections?: PageSection[] | null;
12955
- pageMarkups?: PageMarkup[] | null;
12956
- processingSource?: ProcessingSource;
12957
- indexInText?: number;
12958
- textLength?: number;
12959
- skewAngle?: number;
12960
- rotation?: Rotation;
12961
- 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;
12962
13908
  }
12963
13909
  interface PageMarkup {
12964
- box?: number[];
12965
- polygon?: number[] | null;
12966
- ocrConfidence?: number;
12967
- text?: string | null;
12968
- markupType?: MarkupType;
13910
+ Box?: number[];
13911
+ Polygon?: number[] | null;
13912
+ OcrConfidence?: number;
13913
+ Text?: string | null;
13914
+ MarkupType?: MarkupType;
12969
13915
  }
12970
13916
  interface PageSection {
12971
- indexInText?: number;
12972
- language?: string | null;
12973
- length?: number;
12974
- rotation?: Rotation;
12975
- skewAngle?: number;
12976
- type?: SectionType;
12977
- 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;
12978
13924
  }
12979
13925
  interface Word {
12980
- box?: number[];
12981
- polygon?: number[] | null;
12982
- indexInText?: number;
12983
- ocrConfidence?: number;
12984
- text?: string | null;
12985
- visualLineNumber?: number;
12986
- textType?: TextType;
12987
- 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;
12988
13934
  }
12989
13935
  interface WordGroup {
12990
- indexInText?: number;
12991
- length?: number;
12992
- type?: WordGroupType;
12993
- words?: Word[] | null;
13936
+ IndexInText?: number;
13937
+ Length?: number;
13938
+ Type?: WordGroupType;
13939
+ Words?: Word[] | null;
12994
13940
  }
12995
13941
 
12996
13942
  declare enum ResultsDataSource {
@@ -13001,170 +13947,172 @@ declare enum ResultsDataSource {
13001
13947
  External = "External"
13002
13948
  }
13003
13949
  interface ClassificationResult {
13004
- documentTypeId?: string | null;
13005
- documentId?: string | null;
13006
- confidence?: number;
13007
- ocrConfidence?: number;
13008
- reference?: ResultsContentReference;
13009
- documentBounds?: ResultsDocumentBounds;
13010
- 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;
13011
13957
  }
13012
13958
  interface ExtractionResult {
13013
- documentId?: string | null;
13014
- resultsVersion?: number;
13015
- resultsDocument?: ResultsDocument;
13016
- extractorPayloads?: ExtractorPayload[] | null;
13017
- businessRulesResults?: RuleSetResult[] | null;
13959
+ DocumentId?: string | null;
13960
+ ResultsVersion?: number;
13961
+ ResultsDocument?: ResultsDocument;
13962
+ ExtractorPayloads?: ExtractorPayload[] | null;
13963
+ BusinessRulesResults?: RuleSetResult[] | null;
13018
13964
  }
13019
13965
  interface ExtractorPayload {
13020
- id?: string | null;
13021
- payload?: string | null;
13022
- savedPayloadId?: string | null;
13023
- taxonomySchemaMapping?: string | null;
13966
+ Id?: string | null;
13967
+ Payload?: string | null;
13968
+ SavedPayloadId?: string | null;
13969
+ TaxonomySchemaMapping?: string | null;
13024
13970
  }
13025
13971
  interface ResultsContentReference {
13026
- textStartIndex?: number;
13027
- textLength?: number;
13028
- tokens?: ResultsValueTokens[] | null;
13972
+ TextStartIndex?: number;
13973
+ TextLength?: number;
13974
+ Tokens?: ResultsValueTokens[] | null;
13029
13975
  }
13030
13976
  interface ResultsDataPoint {
13031
- fieldId?: string | null;
13032
- fieldName?: string | null;
13033
- fieldType?: FieldType;
13034
- isMissing?: boolean;
13035
- dataSource?: ResultsDataSource;
13036
- values?: ResultsValue[] | null;
13037
- dataVersion?: number;
13038
- operatorConfirmed?: boolean;
13039
- validatorNotes?: string | null;
13040
- 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;
13041
13987
  }
13042
13988
  interface ResultsDerivedField {
13043
- fieldId?: string | null;
13044
- value?: string | null;
13989
+ FieldId?: string | null;
13990
+ Value?: string | null;
13045
13991
  }
13046
13992
  interface ResultsDocument {
13047
- bounds?: ResultsDocumentBounds;
13048
- language?: string | null;
13049
- documentGroup?: string | null;
13050
- documentCategory?: string | null;
13051
- documentTypeId?: string | null;
13052
- documentTypeName?: string | null;
13053
- documentTypeDataVersion?: number;
13054
- dataVersion?: number;
13055
- documentTypeSource?: ResultsDataSource;
13056
- documentTypeField?: ResultsValue;
13057
- fields?: ResultsDataPoint[] | null;
13058
- 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;
13059
14005
  }
13060
14006
  interface ResultsDocumentBounds {
13061
- startPage?: number;
13062
- pageCount?: number;
13063
- textStartIndex?: number;
13064
- textLength?: number;
13065
- pageRange?: string | null;
14007
+ PageCount?: number;
14008
+ PageRange?: string | null;
13066
14009
  }
13067
14010
  interface ResultsTable {
13068
- fieldId?: string | null;
13069
- fieldName?: string | null;
13070
- isMissing?: boolean;
13071
- dataSource?: ResultsDataSource;
13072
- dataVersion?: number;
13073
- operatorConfirmed?: boolean;
13074
- values?: ResultsTableValue[] | null;
13075
- validatorNotes?: string | null;
13076
- 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;
13077
14020
  }
13078
14021
  interface ResultsTableCell {
13079
- rowIndex?: number;
13080
- columnIndex?: number;
13081
- isHeader?: boolean;
13082
- isMissing?: boolean;
13083
- operatorConfirmed?: boolean;
13084
- dataSource?: ResultsDataSource;
13085
- dataVersion?: number;
13086
- 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;
13087
14030
  }
13088
14031
  interface ResultsTableColumnInfo {
13089
- fieldId?: string | null;
13090
- fieldName?: string | null;
13091
- fieldType?: FieldType;
14032
+ FieldId?: string | null;
14033
+ FieldName?: string | null;
14034
+ FieldType?: FieldType;
13092
14035
  }
13093
14036
  interface ResultsTableValue {
13094
- operatorConfirmed?: boolean;
13095
- confidence?: number;
13096
- ocrConfidence?: number;
13097
- cells?: ResultsTableCell[] | null;
13098
- columnInfo?: ResultsTableColumnInfo[] | null;
13099
- numberOfRows?: number;
13100
- validatorNotes?: string | null;
13101
- 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;
13102
14045
  }
13103
14046
  interface ResultsValue {
13104
- components?: ResultsDataPoint[] | null;
13105
- value?: string | null;
13106
- unformattedValue?: string | null;
13107
- reference?: ResultsContentReference;
13108
- derivedFields?: ResultsDerivedField[] | null;
13109
- confidence?: number;
13110
- operatorConfirmed?: boolean;
13111
- ocrConfidence?: number;
13112
- textType?: TextType;
13113
- validatorNotes?: string | null;
13114
- 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;
13115
14058
  }
13116
14059
  interface ResultsValueTokens {
13117
- textStartIndex?: number;
13118
- textLength?: number;
13119
- page?: number;
13120
- pageWidth?: number;
13121
- pageHeight?: number;
13122
- boxes?: number[][] | null;
14060
+ TextStartIndex?: number;
14061
+ TextLength?: number;
14062
+ Page?: number;
14063
+ PageWidth?: number;
14064
+ PageHeight?: number;
14065
+ Boxes?: number[][] | null;
13123
14066
  }
13124
14067
 
13125
14068
  interface ClassificationRequestBody {
13126
- documentId?: string;
13127
- prompts?: ClassificationPrompt[] | null;
14069
+ DocumentId?: string;
14070
+ Prompts?: ClassificationPrompt[] | null;
13128
14071
  }
13129
14072
  interface ClassificationResponse {
13130
- classificationResults?: ClassificationResult[] | null;
14073
+ ClassificationResults?: ClassificationResult[] | null;
13131
14074
  }
13132
14075
  interface StartClassificationResponse {
13133
- operationId?: string;
13134
- resultUrl?: string | null;
13135
- }
13136
- interface SwaggerGetClassificationResultResponse {
13137
- status?: 'Succeeded' | 'Failed' | 'Running' | 'NotStarted';
13138
- createdAt?: string;
13139
- lastUpdatedAt?: string;
13140
- error?: ErrorResponse;
13141
- result?: ClassificationResponse;
14076
+ OperationId?: string;
14077
+ ResultUrl?: string | null;
13142
14078
  }
13143
14079
 
13144
14080
  interface DataDeletionRequest {
13145
- 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;
13146
14094
  }
13147
14095
 
13148
14096
  interface StartDigitizationFromAttachmentModel {
13149
- attachmentId?: string;
13150
- folderId?: string | null;
13151
- fileName?: string | null;
13152
- mimeType?: string | null;
14097
+ AttachmentId?: string;
14098
+ FolderId?: string | null;
14099
+ FileName?: string | null;
14100
+ MimeType?: string | null;
13153
14101
  }
13154
14102
  interface StartDigitizationResponse {
13155
- documentId?: string;
13156
- resultUrl?: string | null;
14103
+ DocumentId?: string;
14104
+ ResultUrl?: string | null;
13157
14105
  }
13158
14106
  interface SwaggerGetDigitizeJobResponse {
13159
- status?: 'Succeeded' | 'Failed' | 'Running' | 'NotStarted';
13160
- error?: ErrorResponse;
13161
- result?: SwaggerGetDigitizeJobResult;
13162
- createdAt?: string;
13163
- lastUpdatedAt?: string;
14107
+ Status?: JobStatus;
14108
+ Error?: ErrorResponse;
14109
+ Result?: SwaggerGetDigitizeJobResult;
14110
+ CreatedAt?: string;
14111
+ LastUpdatedAt?: string;
13164
14112
  }
13165
14113
  interface SwaggerGetDigitizeJobResult {
13166
- documentObjectModel?: DocumentEntity;
13167
- documentText?: string | null;
14114
+ DocumentObjectModel?: DocumentEntity;
14115
+ DocumentText?: string | null;
13168
14116
  }
13169
14117
 
13170
14118
  declare enum ProjectProperties {
@@ -13198,213 +14146,206 @@ declare enum ResourceType {
13198
14146
  Unknown = "Unknown"
13199
14147
  }
13200
14148
  interface Classifier {
13201
- id?: string | null;
13202
- name?: string | null;
13203
- resourceType?: ResourceType;
13204
- status?: ResourceStatus;
13205
- documentTypeIds?: string[] | null;
13206
- detailsUrl?: string | null;
13207
- syncUrl?: string | null;
13208
- asyncUrl?: string | null;
13209
- projectVersion?: number | null;
13210
- projectVersionName?: string | null;
13211
- 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;
13212
14160
  }
13213
14161
  interface DiscoveredDocumentType {
13214
- id?: string | null;
13215
- name?: string | null;
13216
- resourceType?: ResourceType;
13217
- detailsUrl?: string | null;
14162
+ Id?: string | null;
14163
+ Name?: string | null;
14164
+ ResourceType?: ResourceType;
14165
+ DetailsUrl?: string | null;
13218
14166
  }
13219
14167
  interface DiscoveredExtractorResourceSummaryResponse {
13220
- id?: string | null;
13221
- name?: string | null;
13222
- resourceType?: ResourceType;
13223
- detailsUrl?: string | null;
13224
- documentTypeId?: string | null;
13225
- documentTypeName?: string | null;
13226
- projectVersion?: number | null;
13227
- projectVersionName?: string | null;
13228
- createdOn?: string | null;
13229
- 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;
13230
14178
  }
13231
14179
  interface DiscoveredProjectVersionResponseV2_0 {
13232
- version?: number;
13233
- versionName?: string | null;
13234
- tags?: string[] | null;
13235
- date?: string;
13236
- deployed?: boolean;
14180
+ Version?: number;
14181
+ VersionName?: string | null;
14182
+ Tags?: string[] | null;
14183
+ Date?: string;
14184
+ Deployed?: boolean;
13237
14185
  }
13238
14186
  interface DiscoveredResourceSummaryResponse {
13239
- id?: string | null;
13240
- name?: string | null;
13241
- resourceType?: ResourceType;
13242
- detailsUrl?: string | null;
13243
- projectVersion?: number | null;
13244
- projectVersionName?: string | null;
13245
- createdOn?: string | null;
13246
- 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;
13247
14195
  }
13248
14196
  interface Extractor {
13249
- id?: string | null;
13250
- name?: string | null;
13251
- documentTypeId?: string | null;
13252
- resourceType?: ResourceType;
13253
- status?: ResourceStatus;
13254
- detailsUrl?: string | null;
13255
- syncUrl?: string | null;
13256
- asyncUrl?: string | null;
13257
- projectVersion?: number | null;
13258
- projectVersionName?: string | null;
13259
- 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;
13260
14208
  }
13261
14209
  interface GetClassifierDetailsDocumentTypeResponse {
13262
- id?: string | null;
13263
- name?: string | null;
13264
- resourceType?: ResourceType;
13265
- type?: ClassifierDocumentTypeType;
13266
- createdOn?: string | null;
14210
+ Id?: string | null;
14211
+ Name?: string | null;
14212
+ ResourceType?: ResourceType;
14213
+ Type?: ClassifierDocumentTypeType;
14214
+ CreatedOn?: string | null;
13267
14215
  }
13268
14216
  interface GetClassifierDetailsResponse {
13269
- id?: string | null;
13270
- name?: string | null;
13271
- resourceType?: ResourceType;
13272
- status?: ResourceStatus;
13273
- documentTypes?: GetClassifierDetailsDocumentTypeResponse[] | null;
13274
- createdOn?: string | null;
13275
- syncUrl?: string | null;
13276
- asyncUrl?: string | null;
13277
- projectVersion?: number | null;
13278
- projectVersionName?: string | null;
13279
- 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;
13280
14228
  }
13281
14229
  interface GetClassifiersResponse {
13282
- classifiers?: Classifier[] | null;
14230
+ Classifiers?: Classifier[] | null;
13283
14231
  }
13284
14232
  interface GetDocumentTypeDetailsByTagResponseV2_0 {
13285
- id?: string | null;
13286
- name?: string | null;
13287
- resourceType?: ResourceType;
13288
- createdOn?: string | null;
13289
- documentTaxonomy?: DocumentTaxonomy;
14233
+ Id?: string | null;
14234
+ Name?: string | null;
14235
+ ResourceType?: ResourceType;
14236
+ CreatedOn?: string | null;
14237
+ DocumentTaxonomy?: DocumentTaxonomy;
13290
14238
  }
13291
14239
  interface GetDocumentTypeDetailsResponseV2_0 {
13292
- id?: string | null;
13293
- name?: string | null;
13294
- resourceType?: ResourceType;
13295
- createdOn?: string | null;
13296
- classifiers?: DiscoveredResourceSummaryResponse[] | null;
13297
- 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;
13298
14246
  }
13299
14247
  interface GetDocumentTypesResponse {
13300
- documentTypes?: DiscoveredDocumentType[] | null;
14248
+ DocumentTypes?: DiscoveredDocumentType[] | null;
13301
14249
  }
13302
14250
  interface GetExtractorDetailsResponseV2_0 {
13303
- id?: string | null;
13304
- name?: string | null;
13305
- resourceType?: ResourceType;
13306
- status?: ResourceStatus;
13307
- projectId?: string;
13308
- projectVersion?: number | null;
13309
- projectVersionName?: string | null;
13310
- documentTypeName?: string | null;
13311
- documentTypeId?: string | null;
13312
- createdOn?: string | null;
13313
- syncUrl?: string | null;
13314
- asyncUrl?: string | null;
13315
- description?: string | null;
13316
- 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;
13317
14265
  }
13318
14266
  interface GetExtractorsResponse {
13319
- extractors?: Extractor[] | null;
14267
+ Extractors?: Extractor[] | null;
13320
14268
  }
13321
14269
  interface GetProjectDetailsResponseV2_0 {
13322
- id?: string;
13323
- name?: string | null;
13324
- description?: string | null;
13325
- type?: ProjectType;
13326
- properties?: ProjectProperties[] | null;
13327
- documentTypes?: DiscoveredResourceSummaryResponse[] | null;
13328
- classifiers?: DiscoveredResourceSummaryResponse[] | null;
13329
- extractors?: DiscoveredExtractorResourceSummaryResponse[] | null;
13330
- projectVersions?: DiscoveredProjectVersionResponseV2_0[] | null;
13331
- 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;
13332
14280
  }
13333
14281
  interface GetProjectsResponse {
13334
- projects?: Project[] | null;
14282
+ Projects?: Project[] | null;
13335
14283
  }
13336
14284
  interface GetProjectTaxonomyResponse {
13337
- documentTaxonomy?: DocumentTaxonomy;
14285
+ DocumentTaxonomy?: DocumentTaxonomy;
13338
14286
  }
13339
14287
  interface GetTagsResponse {
13340
- tags?: TagEntity[] | null;
14288
+ Tags?: TagEntity[] | null;
13341
14289
  }
13342
14290
  interface Project {
13343
- id?: string;
13344
- name?: string | null;
13345
- type?: ProjectType;
13346
- description?: string | null;
13347
- createdOn?: string | null;
13348
- detailsUrl?: string | null;
13349
- digitizationStartUrl?: string | null;
13350
- classifiersDiscoveryUrl?: string | null;
13351
- extractorsDiscoveryUrl?: string | null;
13352
- 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;
13353
14301
  }
13354
14302
  interface TagEntity {
13355
- name?: string | null;
13356
- projectVersion?: number | null;
13357
- projectVersionName?: string | null;
13358
- extractors?: TaggedExtractor[] | null;
13359
- classifiers?: TaggedClassifier[] | null;
14303
+ Name?: string | null;
14304
+ ProjectVersion?: number | null;
14305
+ ProjectVersionName?: string | null;
14306
+ Extractors?: TaggedExtractor[] | null;
14307
+ Classifiers?: TaggedClassifier[] | null;
13360
14308
  }
13361
14309
  interface TaggedClassifier {
13362
- name?: string | null;
13363
- documentTypes?: DiscoveredDocumentType[] | null;
13364
- syncUrl?: string | null;
13365
- asyncUrl?: string | null;
14310
+ Name?: string | null;
14311
+ DocumentTypes?: DiscoveredDocumentType[] | null;
14312
+ SyncUrl?: string | null;
14313
+ AsyncUrl?: string | null;
13366
14314
  }
13367
14315
  interface TaggedExtractor {
13368
- name?: string | null;
13369
- documentType?: DiscoveredDocumentType;
13370
- syncUrl?: string | null;
13371
- asyncUrl?: string | null;
14316
+ Name?: string | null;
14317
+ DocumentType?: DiscoveredDocumentType;
14318
+ SyncUrl?: string | null;
14319
+ AsyncUrl?: string | null;
13372
14320
  }
13373
14321
 
13374
14322
  interface ExtractionPromptRequestBody {
13375
- id?: string | null;
13376
- question?: string | null;
13377
- fieldType?: GptFieldType;
13378
- multiValued?: boolean | null;
14323
+ Id?: string | null;
14324
+ Question?: string | null;
14325
+ FieldType?: GptFieldType;
14326
+ MultiValued?: boolean | null;
13379
14327
  }
13380
14328
  interface ExtractRequestBodyConfiguration {
13381
- autoValidationConfidenceThreshold?: number | null;
14329
+ AutoValidationConfidenceThreshold?: number | null;
13382
14330
  }
13383
14331
  interface ExtractRequestBodyV2_0 {
13384
- documentId?: string;
13385
- pageRange?: string | null;
13386
- prompts?: ExtractionPromptRequestBody[] | null;
13387
- configuration?: ExtractRequestBodyConfiguration;
13388
- documentTaxonomy?: DocumentTaxonomy;
14332
+ DocumentId?: string;
14333
+ PageRange?: string | null;
14334
+ Prompts?: ExtractionPromptRequestBody[] | null;
14335
+ Configuration?: ExtractRequestBodyConfiguration;
14336
+ DocumentTaxonomy?: DocumentTaxonomy;
13389
14337
  }
13390
14338
  interface ExtractSyncResult {
13391
- extractionResult?: ExtractionResult;
14339
+ ExtractionResult?: ExtractionResult;
13392
14340
  }
13393
14341
  interface StartExtractionResponse {
13394
- operationId?: string;
13395
- resultUrl?: string | null;
13396
- }
13397
- interface SwaggerGetExtractionResultResponse {
13398
- status?: 'Succeeded' | 'Failed' | 'Running' | 'NotStarted';
13399
- createdAt?: string;
13400
- lastUpdatedAt?: string;
13401
- error?: ErrorResponse;
13402
- result?: ExtractSyncResult;
14342
+ OperationId?: string;
14343
+ ResultUrl?: string | null;
13403
14344
  }
13404
14345
 
13405
14346
  declare enum ModelKind {
13406
- Classifier = "Classifier",
13407
- Extractor = "Extractor"
14347
+ Extractor = "Extractor",
14348
+ Classifier = "Classifier"
13408
14349
  }
13409
14350
  declare enum ModelType {
13410
14351
  IXP = "IXP",
@@ -13412,40 +14353,42 @@ declare enum ModelType {
13412
14353
  Predefined = "Predefined"
13413
14354
  }
13414
14355
  interface FolderBasedStartExtractionRequest {
13415
- documentId?: string;
13416
- documentTaxonomy?: DocumentTaxonomy;
13417
- pageRange?: string | null;
14356
+ DocumentId?: string;
14357
+ DocumentTaxonomy?: DocumentTaxonomy;
14358
+ PageRange?: string | null;
13418
14359
  }
13419
14360
  interface FolderBasedStartExtractionResponse {
13420
- operationId?: string;
13421
- resultUrl?: string | null;
14361
+ OperationId?: string;
14362
+ ResultUrl?: string | null;
13422
14363
  }
13423
14364
  interface FolderModelsResponse {
13424
- folderKey?: string | null;
13425
- fullyQualifiedName?: string | null;
13426
- models?: ModelSummaryResponse[] | null;
14365
+ FolderKey?: string | null;
14366
+ FullyQualifiedName?: string | null;
14367
+ Models?: ModelSummaryResponse[] | null;
13427
14368
  }
13428
14369
  interface GetModelDetailsResponse {
13429
- fullyQualifiedName?: string | null;
13430
- kind?: ModelKind;
13431
- type?: ModelType;
13432
- description?: string | null;
13433
- asyncDigitizationUrl?: string | null;
13434
- asyncExtractionUrl?: string | null;
13435
- 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;
13436
14378
  }
13437
14379
  interface GetModelsResponse {
13438
- folders?: FolderModelsResponse[] | null;
14380
+ Folders?: FolderModelsResponse[] | null;
13439
14381
  }
13440
14382
  interface ModelSummaryResponse {
13441
- modelName?: string | null;
13442
- description?: string | null;
13443
- kind?: ModelKind;
13444
- type?: ModelType;
13445
- fullyQualifiedName?: string | null;
13446
- detailsUrl?: string | null;
13447
- asyncDigitizationUrl?: string | null;
13448
- 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;
13449
14392
  }
13450
14393
 
13451
14394
  declare enum ActionStatus {
@@ -13454,174 +14397,198 @@ declare enum ActionStatus {
13454
14397
  Completed = "Completed"
13455
14398
  }
13456
14399
  interface ClassificationValidationResult {
13457
- actionStatus?: ActionStatus;
13458
- actionData?: DocumentClassificationActionDataModel;
13459
- validatedClassificationResults?: ClassificationResult[] | null;
14400
+ ActionStatus?: ActionStatus;
14401
+ ActionData?: DocumentClassificationActionDataModel;
14402
+ ValidatedClassificationResults?: ClassificationResult[] | null;
13460
14403
  }
13461
14404
  interface ExtractionValidationArtifactsResult {
13462
- validatedExtractionResults?: ExtractionResult;
14405
+ ValidatedExtractionResults?: ExtractionResult;
13463
14406
  }
13464
14407
  interface ExtractionValidationResult {
13465
- actionStatus?: ActionStatus;
13466
- actionData?: DocumentExtractionActionDataModel;
13467
- validatedExtractionResults?: ExtractionResult;
13468
- dataProjection?: FieldGroupValueProjection[] | null;
14408
+ ActionStatus?: ActionStatus;
14409
+ ActionData?: DocumentExtractionActionDataModel;
14410
+ ValidatedExtractionResults?: ExtractionResult;
14411
+ DataProjection?: FieldGroupValueProjection[] | null;
13469
14412
  }
13470
14413
  interface GetClassificationValidationTaskResponse {
13471
- status?: 'Succeeded' | 'Failed' | 'Running' | 'NotStarted';
13472
- error?: ErrorResponse;
13473
- createdAt?: string;
13474
- lastUpdatedAt?: string;
13475
- result?: ClassificationValidationResult;
14414
+ Status?: JobStatus;
14415
+ Error?: ErrorResponse;
14416
+ CreatedAt?: string;
14417
+ LastUpdatedAt?: string;
14418
+ Result?: ClassificationValidationResult;
13476
14419
  }
13477
14420
  interface GetExtractionValidationArtifactsResultTaskResponse {
13478
- result?: ExtractionValidationArtifactsResult;
14421
+ Result?: ExtractionValidationArtifactsResult;
13479
14422
  }
13480
14423
  interface GetExtractionValidationArtifactsTaskResponse {
13481
- status?: 'Succeeded' | 'Failed' | 'Running' | 'NotStarted';
13482
- error?: ErrorResponse;
13483
- createdAt?: string;
13484
- lastUpdatedAt?: string;
13485
- contentValidationData?: ContentValidationData;
14424
+ Status?: JobStatus;
14425
+ Error?: ErrorResponse;
14426
+ CreatedAt?: string;
14427
+ LastUpdatedAt?: string;
14428
+ ContentValidationData?: ContentValidationData;
13486
14429
  }
13487
14430
  interface GetExtractionValidationTaskResponse {
13488
- status?: 'Succeeded' | 'Failed' | 'Running' | 'NotStarted';
13489
- error?: ErrorResponse;
13490
- createdAt?: string;
13491
- lastUpdatedAt?: string;
13492
- result?: ExtractionValidationResult;
14431
+ Status?: JobStatus;
14432
+ Error?: ErrorResponse;
14433
+ CreatedAt?: string;
14434
+ LastUpdatedAt?: string;
14435
+ Result?: ExtractionValidationResult;
13493
14436
  }
13494
14437
  interface StartClassificationValidationTaskRequest {
13495
- documentId?: string | null;
13496
- actionTitle?: string | null;
13497
- actionPriority?: CreateTaskPriority;
13498
- actionCatalog?: string | null;
13499
- actionFolder?: string | null;
13500
- storageBucketName?: string | null;
13501
- storageBucketDirectoryPath?: string | null;
13502
- prompts?: ClassificationPrompt[] | null;
13503
- configuration?: ClassificationValidationConfiguration;
13504
- 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;
13505
14448
  }
13506
14449
  interface StartExtractionValidationArtifactsRequest {
13507
- documentId?: string;
13508
- extractionResult?: ExtractionResult;
13509
- documentTaxonomy?: DocumentTaxonomy;
13510
- folderName?: string | null;
13511
- storageBucketName?: string | null;
13512
- storageBucketDirectoryPath?: string | null;
14450
+ DocumentId?: string;
14451
+ ExtractionResult?: ExtractionResult;
14452
+ DocumentTaxonomy?: DocumentTaxonomy;
14453
+ FolderName?: string | null;
14454
+ StorageBucketName?: string | null;
14455
+ StorageBucketDirectoryPath?: string | null;
13513
14456
  }
13514
14457
  interface StartExtractionValidationTaskRequestV2_0 {
13515
- documentId?: string | null;
13516
- actionTitle?: string | null;
13517
- actionPriority?: CreateTaskPriority;
13518
- actionCatalog?: string | null;
13519
- actionFolder?: string | null;
13520
- storageBucketName?: string | null;
13521
- storageBucketDirectoryPath?: string | null;
13522
- fieldsValidationConfidence?: number | null;
13523
- allowChangeOfDocumentType?: boolean | null;
13524
- prompts?: ExtractionPrompt[] | null;
13525
- extractionResult?: ExtractionResult;
13526
- configuration?: ExtractionValidationConfigurationV2;
13527
- 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;
13528
14469
  }
13529
14470
  interface StartValidationArtifactsTaskResponse {
13530
- operationId?: string;
13531
- artifactsUrl?: string | null;
13532
- resultUrl?: string | null;
14471
+ OperationId?: string;
14472
+ ArtifactsUrl?: string | null;
14473
+ ResultUrl?: string | null;
13533
14474
  }
13534
14475
  interface StartValidationTaskResponse {
13535
- operationId?: string;
13536
- resultUrl?: string | null;
14476
+ OperationId?: string;
14477
+ ResultUrl?: string | null;
13537
14478
  }
13538
14479
 
13539
14480
  interface ClassificationValidationFinishedTaskInfo {
13540
- id?: number;
13541
- title?: string | null;
13542
- priority?: DocumentActionPriority;
13543
- status?: ActionStatus;
13544
- creationTime?: string;
13545
- completionTime?: string | null;
13546
- lastAssignedTime?: string;
13547
- url?: string | null;
13548
- assignedToUser?: string | null;
13549
- completedByUser?: string | null;
13550
- lastModifierUser?: string | null;
13551
- documentRejectionReason?: string | null;
13552
- catalogName?: string | null;
13553
- folderName?: string | null;
13554
- 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;
13555
14496
  }
13556
14497
  interface FinishExtractionValidationTaskInfo {
13557
- id?: number;
13558
- title?: string | null;
13559
- priority?: DocumentActionPriority;
13560
- status?: ActionStatus;
13561
- creationTime?: string;
13562
- completionTime?: string | null;
13563
- lastAssignedTime?: string;
13564
- url?: string | null;
13565
- assignedToUser?: string | null;
13566
- completedByUser?: string | null;
13567
- lastModifierUser?: string | null;
13568
- documentRejectionReason?: string | null;
13569
- catalogName?: string | null;
13570
- folderName?: string | null;
13571
- 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;
13572
14513
  }
13573
14514
  interface StartClassificationValidationTaskInfo {
13574
- id?: number;
13575
- title?: string | null;
13576
- folderName?: string | null;
13577
- storageBucketName?: string | null;
13578
- storageBucketDirectoryPath?: string | null;
13579
- catalogName?: string | null;
13580
- priority?: DocumentActionPriority;
13581
- 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;
13582
14523
  }
13583
14524
  interface StartExtractionValidationTaskInfo {
13584
- id?: number;
13585
- title?: string | null;
13586
- folderName?: string | null;
13587
- storageBucketName?: string | null;
13588
- storageBucketDirectoryPath?: string | null;
13589
- catalogName?: string | null;
13590
- priority?: DocumentActionPriority;
13591
- 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;
13592
14533
  }
13593
14534
  interface TrackFinishClassificationValidationRequest {
13594
- classifierId?: string | null;
13595
- tag?: string | null;
13596
- documentId?: string;
13597
- task?: ClassificationValidationFinishedTaskInfo;
13598
- classificationResult?: ClassificationResult[] | null;
14535
+ ClassifierId?: string | null;
14536
+ Tag?: string | null;
14537
+ DocumentId?: string;
14538
+ Task?: ClassificationValidationFinishedTaskInfo;
14539
+ ClassificationResult?: ClassificationResult[] | null;
13599
14540
  }
13600
14541
  interface TrackFinishExtractionValidationRequest {
13601
- extractorId?: string | null;
13602
- tag?: string | null;
13603
- documentTypeId?: string | null;
13604
- documentId?: string;
13605
- task?: FinishExtractionValidationTaskInfo;
13606
- extractionResult?: ExtractionResult;
13607
- 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;
13608
14549
  }
13609
14550
  interface TrackStartClassificationValidationRequest {
13610
- classifierId?: string | null;
13611
- tag?: string | null;
13612
- documentId?: string;
13613
- duration?: number;
13614
- task?: StartClassificationValidationTaskInfo;
13615
- classificationResult?: ClassificationResult[] | null;
14551
+ ClassifierId?: string | null;
14552
+ Tag?: string | null;
14553
+ DocumentId?: string;
14554
+ Duration?: number;
14555
+ Task?: StartClassificationValidationTaskInfo;
14556
+ ClassificationResult?: ClassificationResult[] | null;
13616
14557
  }
13617
14558
  interface TrackStartExtractionValidationRequest {
13618
- extractorId?: string | null;
13619
- tag?: string | null;
13620
- documentTypeId?: string | null;
13621
- documentId?: string;
13622
- duration?: number;
13623
- task?: StartExtractionValidationTaskInfo;
13624
- 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;
13625
14592
  }
13626
14593
 
13627
14594
  type index_ActionStatus = ActionStatus;
@@ -13662,6 +14629,8 @@ type index_DocumentGroup = DocumentGroup;
13662
14629
  type index_DocumentTaxonomy = DocumentTaxonomy;
13663
14630
  type index_DocumentTypeEntity = DocumentTypeEntity;
13664
14631
  type index_ErrorResponse = ErrorResponse;
14632
+ type index_ErrorSeverity = ErrorSeverity;
14633
+ declare const index_ErrorSeverity: typeof ErrorSeverity;
13665
14634
  type index_ExceptionReasonOption = ExceptionReasonOption;
13666
14635
  type index_ExtractRequestBodyConfiguration = ExtractRequestBodyConfiguration;
13667
14636
  type index_ExtractRequestBodyV2_0 = ExtractRequestBodyV2_0;
@@ -13685,13 +14654,17 @@ type index_FinishExtractionValidationTaskInfo = FinishExtractionValidationTaskIn
13685
14654
  type index_FolderBasedStartExtractionRequest = FolderBasedStartExtractionRequest;
13686
14655
  type index_FolderBasedStartExtractionResponse = FolderBasedStartExtractionResponse;
13687
14656
  type index_FolderModelsResponse = FolderModelsResponse;
14657
+ type index_GetClassificationResultResponse = GetClassificationResultResponse;
13688
14658
  type index_GetClassificationValidationTaskResponse = GetClassificationValidationTaskResponse;
13689
14659
  type index_GetClassifierDetailsDocumentTypeResponse = GetClassifierDetailsDocumentTypeResponse;
13690
14660
  type index_GetClassifierDetailsResponse = GetClassifierDetailsResponse;
13691
14661
  type index_GetClassifiersResponse = GetClassifiersResponse;
14662
+ type index_GetDigitizeJobResponse = GetDigitizeJobResponse;
14663
+ type index_GetDigitizeJobResult = GetDigitizeJobResult;
13692
14664
  type index_GetDocumentTypeDetailsByTagResponseV2_0 = GetDocumentTypeDetailsByTagResponseV2_0;
13693
14665
  type index_GetDocumentTypeDetailsResponseV2_0 = GetDocumentTypeDetailsResponseV2_0;
13694
14666
  type index_GetDocumentTypesResponse = GetDocumentTypesResponse;
14667
+ type index_GetExtractionResultResponse = GetExtractionResultResponse;
13695
14668
  type index_GetExtractionValidationArtifactsResultTaskResponse = GetExtractionValidationArtifactsResultTaskResponse;
13696
14669
  type index_GetExtractionValidationArtifactsTaskResponse = GetExtractionValidationArtifactsTaskResponse;
13697
14670
  type index_GetExtractionValidationTaskResponse = GetExtractionValidationTaskResponse;
@@ -13705,6 +14678,8 @@ type index_GetProjectsResponse = GetProjectsResponse;
13705
14678
  type index_GetTagsResponse = GetTagsResponse;
13706
14679
  type index_GptFieldType = GptFieldType;
13707
14680
  declare const index_GptFieldType: typeof GptFieldType;
14681
+ type index_JobStatus = JobStatus;
14682
+ declare const index_JobStatus: typeof JobStatus;
13708
14683
  type index_LanguageInfo = LanguageInfo;
13709
14684
  type index_LogicalOperator = LogicalOperator;
13710
14685
  declare const index_LogicalOperator: typeof LogicalOperator;
@@ -13766,10 +14741,8 @@ type index_StartExtractionValidationTaskInfo = StartExtractionValidationTaskInfo
13766
14741
  type index_StartExtractionValidationTaskRequestV2_0 = StartExtractionValidationTaskRequestV2_0;
13767
14742
  type index_StartValidationArtifactsTaskResponse = StartValidationArtifactsTaskResponse;
13768
14743
  type index_StartValidationTaskResponse = StartValidationTaskResponse;
13769
- type index_SwaggerGetClassificationResultResponse = SwaggerGetClassificationResultResponse;
13770
14744
  type index_SwaggerGetDigitizeJobResponse = SwaggerGetDigitizeJobResponse;
13771
14745
  type index_SwaggerGetDigitizeJobResult = SwaggerGetDigitizeJobResult;
13772
- type index_SwaggerGetExtractionResultResponse = SwaggerGetExtractionResultResponse;
13773
14746
  type index_TagEntity = TagEntity;
13774
14747
  type index_TaggedClassifier = TaggedClassifier;
13775
14748
  type index_TaggedExtractor = TaggedExtractor;
@@ -13788,8 +14761,8 @@ type index_WordGroup = WordGroup;
13788
14761
  type index_WordGroupType = WordGroupType;
13789
14762
  declare const index_WordGroupType: typeof WordGroupType;
13790
14763
  declare namespace index {
13791
- 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 };
13792
- 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 };
13793
14766
  }
13794
14767
 
13795
14768
  /**
@@ -14054,103 +15027,11 @@ declare enum UiPathMetaTags {
14054
15027
  FOLDER_KEY = "uipath:folder-key"
14055
15028
  }
14056
15029
 
14057
- /**
14058
- * Telemetry type definitions
14059
- */
14060
- interface TelemetryAttributes {
14061
- [key: string]: string | number | boolean;
14062
- }
14063
- interface TelemetryConfig {
14064
- baseUrl?: string;
14065
- orgName?: string;
14066
- tenantName?: string;
14067
- clientId?: string;
14068
- redirectUri?: string;
14069
- }
14070
- interface TrackOptions {
14071
- condition?: boolean | ((...args: any[]) => boolean);
14072
- attributes?: TelemetryAttributes;
14073
- }
14074
-
14075
- /**
14076
- * SDK Track decorator and function for telemetry
14077
- */
14078
-
14079
- /**
14080
- * Track decorator that can be used to automatically track function calls
14081
- *
14082
- * Usage:
14083
- * @track("Service.Method")
14084
- * function myFunction() { ... }
14085
- *
14086
- * @track("Queue.GetAll")
14087
- * async getAll() { ... }
14088
- *
14089
- * @track("Tasks.Create")
14090
- * async create() { ... }
14091
- *
14092
- * @track("Assets.Update", { condition: false })
14093
- * function myFunction() { ... }
14094
- *
14095
- * @track("Processes.Start", { attributes: { customProp: "value" } })
14096
- * function myFunction() { ... }
14097
- */
14098
- declare function track(nameOrOptions?: string | TrackOptions, options?: TrackOptions): MethodDecorator | ((target: any) => any);
14099
- /**
14100
- * Direct tracking function
14101
- */
14102
- declare function trackEvent(eventName: string, name?: string, attributes?: TelemetryAttributes): void;
14103
-
14104
- /**
14105
- * Singleton telemetry client
14106
- */
14107
- declare class TelemetryClient {
14108
- private static instance;
14109
- private isInitialized;
14110
- private logProvider?;
14111
- private logger?;
14112
- private telemetryContext?;
14113
- private constructor();
14114
- static getInstance(): TelemetryClient;
14115
- /**
14116
- * Initialize telemetry
14117
- */
14118
- initialize(config?: TelemetryConfig): void;
14119
- private getConnectionString;
14120
- private setupTelemetryProvider;
14121
- /**
14122
- * Track a telemetry event
14123
- */
14124
- track(eventName: string, name?: string, extraAttributes?: TelemetryAttributes): void;
14125
- /**
14126
- * Get enriched attributes for telemetry events
14127
- */
14128
- private getEnrichedAttributes;
14129
- /**
14130
- * Create cloud URL from base URL, organization ID, and tenant ID
14131
- */
14132
- private createCloudUrl;
14133
- }
14134
- declare const telemetryClient: TelemetryClient;
14135
-
14136
- /**
14137
- * SDK Telemetry constants
14138
- */
14139
- 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";
14140
- declare const SDK_VERSION = "1.3.8";
14141
- declare const VERSION = "Version";
14142
- declare const SERVICE = "Service";
14143
- declare const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
14144
- declare const CLOUD_TENANT_NAME = "CloudTenantName";
14145
- declare const CLOUD_URL = "CloudUrl";
14146
- declare const CLOUD_CLIENT_ID = "CloudClientId";
14147
- declare const CLOUD_REDIRECT_URI = "CloudRedirectUri";
14148
- declare const APP_NAME = "ApplicationName";
14149
- declare const CLOUD_ROLE_NAME = "uipath-ts-sdk";
14150
- declare const SDK_SERVICE_NAME = "UiPath.TypeScript.Sdk";
14151
- declare const SDK_LOGGER_NAME = "uipath-ts-sdk-telemetry";
14152
- declare const SDK_RUN_EVENT = "Sdk.Run";
14153
- 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
+ };
14154
15035
 
14155
- 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, 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, SDK_LOGGER_NAME, SDK_RUN_EVENT, SDK_SERVICE_NAME, SDK_VERSION, SERVICE, SLADurationUnit, ServerError, ServerlessJobType, SlaSummaryStatus, 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 };
14156
- 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, CaseInstanceSlaSummaryOptions, 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, 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, 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, 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 };