@uipath/uipath-typescript 1.3.8 → 1.3.10
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.
- package/dist/assets/index.cjs +44 -276
- package/dist/assets/index.mjs +44 -276
- package/dist/attachments/index.cjs +42 -273
- package/dist/attachments/index.mjs +42 -273
- package/dist/buckets/index.cjs +195 -276
- package/dist/buckets/index.d.ts +213 -1
- package/dist/buckets/index.mjs +195 -276
- package/dist/cases/index.cjs +427 -343
- package/dist/cases/index.d.ts +534 -2
- package/dist/cases/index.mjs +428 -344
- package/dist/conversational-agent/index.cjs +90 -287
- package/dist/conversational-agent/index.d.ts +62 -12
- package/dist/conversational-agent/index.mjs +90 -288
- package/dist/core/index.cjs +39 -289
- package/dist/core/index.d.ts +9 -98
- package/dist/core/index.mjs +40 -275
- package/dist/document-understanding/index.cjs +18 -1
- package/dist/document-understanding/index.d.ts +636 -610
- package/dist/document-understanding/index.mjs +18 -1
- package/dist/entities/index.cjs +251 -277
- package/dist/entities/index.d.ts +305 -2
- package/dist/entities/index.mjs +251 -277
- package/dist/feedback/index.cjs +42 -274
- package/dist/feedback/index.mjs +42 -274
- package/dist/index.cjs +998 -351
- package/dist/index.d.ts +2159 -762
- package/dist/index.mjs +998 -337
- package/dist/index.umd.js +1208 -237
- package/dist/jobs/index.cjs +44 -276
- package/dist/jobs/index.mjs +44 -276
- package/dist/maestro-processes/index.cjs +1761 -1717
- package/dist/maestro-processes/index.d.ts +430 -2
- package/dist/maestro-processes/index.mjs +1762 -1718
- package/dist/processes/index.cjs +72 -305
- package/dist/processes/index.d.ts +76 -26
- package/dist/processes/index.mjs +72 -305
- package/dist/queues/index.cjs +44 -276
- package/dist/queues/index.mjs +44 -276
- package/dist/tasks/index.cjs +44 -276
- package/dist/tasks/index.mjs +44 -276
- 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
|
*/
|
|
@@ -2475,6 +2478,8 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2475
2478
|
* Only exposes essential fields to SDK users
|
|
2476
2479
|
*/
|
|
2477
2480
|
interface ChoiceSetGetAllResponse {
|
|
2481
|
+
/** UUID of the choice set */
|
|
2482
|
+
id: string;
|
|
2478
2483
|
/** Name identifier of the choice set */
|
|
2479
2484
|
name: string;
|
|
2480
2485
|
/** Human-readable display name of the choice set*/
|
|
@@ -2519,6 +2524,46 @@ interface ChoiceSetGetResponse {
|
|
|
2519
2524
|
* Options for getting choice set values by choice set ID
|
|
2520
2525
|
*/
|
|
2521
2526
|
type ChoiceSetGetByIdOptions = PaginationOptions;
|
|
2527
|
+
/**
|
|
2528
|
+
* Options for creating a new choice set
|
|
2529
|
+
*/
|
|
2530
|
+
interface ChoiceSetCreateOptions {
|
|
2531
|
+
/** Human-readable display name */
|
|
2532
|
+
displayName?: string;
|
|
2533
|
+
/** Optional choice set description */
|
|
2534
|
+
description?: string;
|
|
2535
|
+
/** UUID of the folder to place the choice set in (defaults to the tenant-level folder) */
|
|
2536
|
+
folderKey?: string;
|
|
2537
|
+
}
|
|
2538
|
+
/**
|
|
2539
|
+
* Options for updating an existing choice set's metadata
|
|
2540
|
+
*/
|
|
2541
|
+
interface ChoiceSetUpdateOptions {
|
|
2542
|
+
/** New display name for the choice set */
|
|
2543
|
+
displayName?: string;
|
|
2544
|
+
/** New description for the choice set */
|
|
2545
|
+
description?: string;
|
|
2546
|
+
}
|
|
2547
|
+
/**
|
|
2548
|
+
* Optional fields when inserting a single value into a choice set.
|
|
2549
|
+
*
|
|
2550
|
+
* The required `name` identifier is passed as a positional argument to
|
|
2551
|
+
* `insertValueById`.
|
|
2552
|
+
*/
|
|
2553
|
+
interface ChoiceSetValueInsertOptions {
|
|
2554
|
+
/** Human-readable display name */
|
|
2555
|
+
displayName?: string;
|
|
2556
|
+
}
|
|
2557
|
+
/**
|
|
2558
|
+
* Response returned after inserting a choice-set value — the full value object.
|
|
2559
|
+
*/
|
|
2560
|
+
interface ChoiceSetValueInsertResponse extends ChoiceSetGetResponse {
|
|
2561
|
+
}
|
|
2562
|
+
/**
|
|
2563
|
+
* Response returned after updating a choice-set value — the full value object.
|
|
2564
|
+
*/
|
|
2565
|
+
interface ChoiceSetValueUpdateResponse extends ChoiceSetGetResponse {
|
|
2566
|
+
}
|
|
2522
2567
|
|
|
2523
2568
|
/**
|
|
2524
2569
|
* Service for managing UiPath Data Fabric Choice Sets
|
|
@@ -2601,6 +2646,134 @@ interface ChoiceSetServiceModel {
|
|
|
2601
2646
|
* ```
|
|
2602
2647
|
*/
|
|
2603
2648
|
getById<T extends ChoiceSetGetByIdOptions = ChoiceSetGetByIdOptions>(choiceSetId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ChoiceSetGetResponse> : NonPaginatedResponse<ChoiceSetGetResponse>>;
|
|
2649
|
+
/**
|
|
2650
|
+
* Creates a new Data Fabric choice set
|
|
2651
|
+
*
|
|
2652
|
+
* @param name - Choice set name. Must start with a
|
|
2653
|
+
* letter, may contain only letters, numbers, and underscores, length
|
|
2654
|
+
* 3–100 characters (e.g., `"expenseTypes"`).
|
|
2655
|
+
* @param options - Optional choice-set-level settings ({@link ChoiceSetCreateOptions})
|
|
2656
|
+
* @returns Promise resolving to the UUID of the created choice set
|
|
2657
|
+
*
|
|
2658
|
+
* @example
|
|
2659
|
+
* ```typescript
|
|
2660
|
+
* // Minimal create
|
|
2661
|
+
* const expenseTypesId = await choicesets.create("expense_types");
|
|
2662
|
+
*
|
|
2663
|
+
* // With display name and description
|
|
2664
|
+
* const priorityLevelsId = await choicesets.create("priority_levels", {
|
|
2665
|
+
* displayName: "Priority Levels",
|
|
2666
|
+
* description: "Ticket priority categories",
|
|
2667
|
+
* });
|
|
2668
|
+
* ```
|
|
2669
|
+
* @internal
|
|
2670
|
+
*/
|
|
2671
|
+
create(name: string, options?: ChoiceSetCreateOptions): Promise<string>;
|
|
2672
|
+
/**
|
|
2673
|
+
* Updates an existing choice set's metadata (display name and/or description).
|
|
2674
|
+
*
|
|
2675
|
+
* **At least one of `displayName` or `description` must be provided** —
|
|
2676
|
+
* the call throws `ValidationError` if both are omitted.
|
|
2677
|
+
*
|
|
2678
|
+
* @param choiceSetId - UUID of the choice set to update
|
|
2679
|
+
* @param options - Metadata fields to change ({@link ChoiceSetUpdateOptions})
|
|
2680
|
+
* @returns Promise resolving when the update is complete
|
|
2681
|
+
*
|
|
2682
|
+
* @example
|
|
2683
|
+
* ```typescript
|
|
2684
|
+
* // First, get the choice set ID using getAll()
|
|
2685
|
+
* const allChoiceSets = await choicesets.getAll();
|
|
2686
|
+
* const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
|
|
2687
|
+
*
|
|
2688
|
+
* await choicesets.updateById(expenseTypes.id, {
|
|
2689
|
+
* displayName: "Expense Categories",
|
|
2690
|
+
* description: "Updated description",
|
|
2691
|
+
* });
|
|
2692
|
+
* ```
|
|
2693
|
+
* @internal
|
|
2694
|
+
*/
|
|
2695
|
+
updateById(choiceSetId: string, options: ChoiceSetUpdateOptions): Promise<void>;
|
|
2696
|
+
/**
|
|
2697
|
+
* Deletes a Data Fabric choice set and all its values.
|
|
2698
|
+
*
|
|
2699
|
+
* @param choiceSetId - UUID of the choice set to delete
|
|
2700
|
+
* @returns Promise resolving when the choice set is deleted
|
|
2701
|
+
*
|
|
2702
|
+
* @example
|
|
2703
|
+
* ```typescript
|
|
2704
|
+
* // First, get the choice set ID using getAll()
|
|
2705
|
+
* const allChoiceSets = await choicesets.getAll();
|
|
2706
|
+
* const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
|
|
2707
|
+
*
|
|
2708
|
+
* await choicesets.deleteById(expenseTypes.id);
|
|
2709
|
+
* ```
|
|
2710
|
+
* @internal
|
|
2711
|
+
*/
|
|
2712
|
+
deleteById(choiceSetId: string): Promise<void>;
|
|
2713
|
+
/**
|
|
2714
|
+
* Inserts a single value into a choice set.
|
|
2715
|
+
*
|
|
2716
|
+
* @param choiceSetId - UUID of the parent choice set
|
|
2717
|
+
* @param name - Identifier name of the new value (e.g., `"TRAVEL"`)
|
|
2718
|
+
* @param options - Optional fields ({@link ChoiceSetValueInsertOptions})
|
|
2719
|
+
* @returns Promise resolving to the inserted value ({@link ChoiceSetValueInsertResponse})
|
|
2720
|
+
*
|
|
2721
|
+
* @example
|
|
2722
|
+
* ```typescript
|
|
2723
|
+
* // First, get the choice set ID using getAll()
|
|
2724
|
+
* const allChoiceSets = await choicesets.getAll();
|
|
2725
|
+
* const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
|
|
2726
|
+
*
|
|
2727
|
+
* const inserted = await choicesets.insertValueById(expenseTypes.id, 'TRAVEL', {
|
|
2728
|
+
* displayName: 'Travel',
|
|
2729
|
+
* });
|
|
2730
|
+
* console.log(inserted.id);
|
|
2731
|
+
* ```
|
|
2732
|
+
* @internal
|
|
2733
|
+
*/
|
|
2734
|
+
insertValueById(choiceSetId: string, name: string, options?: ChoiceSetValueInsertOptions): Promise<ChoiceSetValueInsertResponse>;
|
|
2735
|
+
/**
|
|
2736
|
+
* Updates an existing choice-set value's display name.
|
|
2737
|
+
*
|
|
2738
|
+
* Only `displayName` is mutable; the value's `name` (identifier) is fixed at
|
|
2739
|
+
* insert time and cannot be changed.
|
|
2740
|
+
*
|
|
2741
|
+
* @param choiceSetId - UUID of the parent choice set
|
|
2742
|
+
* @param valueId - UUID of the value to update
|
|
2743
|
+
* @param displayName - New human-readable display name for the value
|
|
2744
|
+
* @returns Promise resolving to the updated value ({@link ChoiceSetValueUpdateResponse})
|
|
2745
|
+
*
|
|
2746
|
+
* @example
|
|
2747
|
+
* ```typescript
|
|
2748
|
+
* // Get the choice set ID from getAll() and the value ID from getById()
|
|
2749
|
+
* const allChoiceSets = await choicesets.getAll();
|
|
2750
|
+
* const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
|
|
2751
|
+
* const values = await choicesets.getById(expenseTypes.id);
|
|
2752
|
+
* const travel = values.items.find(v => v.name === 'TRAVEL');
|
|
2753
|
+
*
|
|
2754
|
+
* await choicesets.updateValueById(expenseTypes.id, travel.id, 'Business Travel');
|
|
2755
|
+
* ```
|
|
2756
|
+
* @internal
|
|
2757
|
+
*/
|
|
2758
|
+
updateValueById(choiceSetId: string, valueId: string, displayName: string): Promise<ChoiceSetValueUpdateResponse>;
|
|
2759
|
+
/**
|
|
2760
|
+
* Deletes one or more values from a choice set.
|
|
2761
|
+
*
|
|
2762
|
+
* @param choiceSetId - UUID of the parent choice set
|
|
2763
|
+
* @param valueIds - Array of value UUIDs to delete
|
|
2764
|
+
* @returns Promise resolving when the values are deleted
|
|
2765
|
+
*
|
|
2766
|
+
* @example
|
|
2767
|
+
* ```typescript
|
|
2768
|
+
* // Get the value IDs from getById()
|
|
2769
|
+
* const values = await choicesets.getById('<choiceSetId>');
|
|
2770
|
+
* const idsToDelete = values.items.slice(0, 2).map(v => v.id);
|
|
2771
|
+
*
|
|
2772
|
+
* await choicesets.deleteValuesById('<choiceSetId>', idsToDelete);
|
|
2773
|
+
* ```
|
|
2774
|
+
* @internal
|
|
2775
|
+
*/
|
|
2776
|
+
deleteValuesById(choiceSetId: string, valueIds: string[]): Promise<void>;
|
|
2604
2777
|
}
|
|
2605
2778
|
|
|
2606
2779
|
declare class ChoiceSetService extends BaseService implements ChoiceSetServiceModel {
|
|
@@ -2639,7 +2812,7 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
|
|
|
2639
2812
|
*
|
|
2640
2813
|
* @example
|
|
2641
2814
|
* ```typescript
|
|
2642
|
-
* import { ChoiceSets } from '@uipath/uipath-typescript/
|
|
2815
|
+
* import { ChoiceSets } from '@uipath/uipath-typescript/entities';
|
|
2643
2816
|
*
|
|
2644
2817
|
* const choiceSets = new ChoiceSets(sdk);
|
|
2645
2818
|
*
|
|
@@ -2666,12 +2839,242 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
|
|
|
2666
2839
|
* ```
|
|
2667
2840
|
*/
|
|
2668
2841
|
getById<T extends ChoiceSetGetByIdOptions = ChoiceSetGetByIdOptions>(choiceSetId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ChoiceSetGetResponse> : NonPaginatedResponse<ChoiceSetGetResponse>>;
|
|
2842
|
+
/**
|
|
2843
|
+
* Creates a new Data Fabric choice set
|
|
2844
|
+
*
|
|
2845
|
+
* @param name - Choice set name. Must start with a
|
|
2846
|
+
* letter, may contain only letters, numbers, and underscores, length
|
|
2847
|
+
* 3–100 characters (e.g., `"expenseTypes"`).
|
|
2848
|
+
* @param options - Optional choice-set-level settings ({@link ChoiceSetCreateOptions})
|
|
2849
|
+
* @returns Promise resolving to the UUID of the created choice set
|
|
2850
|
+
*
|
|
2851
|
+
* @example
|
|
2852
|
+
* ```typescript
|
|
2853
|
+
* import { ChoiceSets } from '@uipath/uipath-typescript/entities';
|
|
2854
|
+
*
|
|
2855
|
+
* const choicesets = new ChoiceSets(sdk);
|
|
2856
|
+
*
|
|
2857
|
+
* // Minimal create
|
|
2858
|
+
* const expenseTypesId = await choicesets.create("expense_types");
|
|
2859
|
+
*
|
|
2860
|
+
* // With display name and description
|
|
2861
|
+
* const priorityLevelsId = await choicesets.create("priority_levels", {
|
|
2862
|
+
* displayName: "Priority Levels",
|
|
2863
|
+
* description: "Ticket priority categories",
|
|
2864
|
+
* });
|
|
2865
|
+
* ```
|
|
2866
|
+
* @internal
|
|
2867
|
+
*/
|
|
2868
|
+
create(name: string, options?: ChoiceSetCreateOptions): Promise<string>;
|
|
2869
|
+
/**
|
|
2870
|
+
* Updates an existing choice set's metadata (display name and/or description).
|
|
2871
|
+
*
|
|
2872
|
+
* **At least one of `displayName` or `description` must be provided** —
|
|
2873
|
+
* the call throws `ValidationError` if both are omitted.
|
|
2874
|
+
*
|
|
2875
|
+
* @param choiceSetId - UUID of the choice set to update
|
|
2876
|
+
* @param options - Metadata fields to change ({@link ChoiceSetUpdateOptions})
|
|
2877
|
+
* @returns Promise resolving when the update is complete
|
|
2878
|
+
*
|
|
2879
|
+
* @example
|
|
2880
|
+
* ```typescript
|
|
2881
|
+
* // First, get the choice set ID using getAll()
|
|
2882
|
+
* const allChoiceSets = await choicesets.getAll();
|
|
2883
|
+
* const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
|
|
2884
|
+
*
|
|
2885
|
+
* await choicesets.updateById(expenseTypes.id, {
|
|
2886
|
+
* displayName: "Expense Categories",
|
|
2887
|
+
* description: "Updated description",
|
|
2888
|
+
* });
|
|
2889
|
+
* ```
|
|
2890
|
+
* @internal
|
|
2891
|
+
*/
|
|
2892
|
+
updateById(choiceSetId: string, options: ChoiceSetUpdateOptions): Promise<void>;
|
|
2893
|
+
/**
|
|
2894
|
+
* Deletes a Data Fabric choice set and all its values.
|
|
2895
|
+
*
|
|
2896
|
+
* @param choiceSetId - UUID of the choice set to delete
|
|
2897
|
+
* @returns Promise resolving when the choice set is deleted
|
|
2898
|
+
*
|
|
2899
|
+
* @example
|
|
2900
|
+
* ```typescript
|
|
2901
|
+
* // First, get the choice set ID using getAll()
|
|
2902
|
+
* const allChoiceSets = await choicesets.getAll();
|
|
2903
|
+
* const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
|
|
2904
|
+
*
|
|
2905
|
+
* await choicesets.deleteById(expenseTypes.id);
|
|
2906
|
+
* ```
|
|
2907
|
+
* @internal
|
|
2908
|
+
*/
|
|
2909
|
+
deleteById(choiceSetId: string): Promise<void>;
|
|
2910
|
+
/**
|
|
2911
|
+
* Inserts a single value into a choice set.
|
|
2912
|
+
*
|
|
2913
|
+
* @param choiceSetId - UUID of the parent choice set
|
|
2914
|
+
* @param name - Identifier name of the new value (e.g., `"TRAVEL"`)
|
|
2915
|
+
* @param options - Optional fields ({@link ChoiceSetValueInsertOptions})
|
|
2916
|
+
* @returns Promise resolving to the inserted value ({@link ChoiceSetValueInsertResponse})
|
|
2917
|
+
*
|
|
2918
|
+
* @example
|
|
2919
|
+
* ```typescript
|
|
2920
|
+
* // First, get the choice set ID using getAll()
|
|
2921
|
+
* const allChoiceSets = await choicesets.getAll();
|
|
2922
|
+
* const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
|
|
2923
|
+
*
|
|
2924
|
+
* const inserted = await choicesets.insertValueById(expenseTypes.id, 'TRAVEL', {
|
|
2925
|
+
* displayName: 'Travel',
|
|
2926
|
+
* });
|
|
2927
|
+
* console.log(inserted.id);
|
|
2928
|
+
* ```
|
|
2929
|
+
* @internal
|
|
2930
|
+
*/
|
|
2931
|
+
insertValueById(choiceSetId: string, name: string, options?: ChoiceSetValueInsertOptions): Promise<ChoiceSetValueInsertResponse>;
|
|
2932
|
+
/**
|
|
2933
|
+
* Updates an existing choice-set value's display name.
|
|
2934
|
+
*
|
|
2935
|
+
* Only `displayName` is mutable; the value's `name` (identifier) is fixed at
|
|
2936
|
+
* insert time and cannot be changed.
|
|
2937
|
+
*
|
|
2938
|
+
* @param choiceSetId - UUID of the parent choice set
|
|
2939
|
+
* @param valueId - UUID of the value to update
|
|
2940
|
+
* @param displayName - New human-readable display name for the value
|
|
2941
|
+
* @returns Promise resolving to the updated value ({@link ChoiceSetValueUpdateResponse})
|
|
2942
|
+
*
|
|
2943
|
+
* @example
|
|
2944
|
+
* ```typescript
|
|
2945
|
+
* // Get the choice set ID from getAll() and the value ID from getById()
|
|
2946
|
+
* const allChoiceSets = await choicesets.getAll();
|
|
2947
|
+
* const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
|
|
2948
|
+
* const values = await choicesets.getById(expenseTypes.id);
|
|
2949
|
+
* const travel = values.items.find(v => v.name === 'TRAVEL');
|
|
2950
|
+
*
|
|
2951
|
+
* await choicesets.updateValueById(expenseTypes.id, travel.id, 'Business Travel');
|
|
2952
|
+
* ```
|
|
2953
|
+
* @internal
|
|
2954
|
+
*/
|
|
2955
|
+
updateValueById(choiceSetId: string, valueId: string, displayName: string): Promise<ChoiceSetValueUpdateResponse>;
|
|
2956
|
+
/**
|
|
2957
|
+
* Deletes one or more values from a choice set.
|
|
2958
|
+
*
|
|
2959
|
+
* @param choiceSetId - UUID of the parent choice set
|
|
2960
|
+
* @param valueIds - Array of value UUIDs to delete
|
|
2961
|
+
* @returns Promise resolving when the values are deleted
|
|
2962
|
+
*
|
|
2963
|
+
* @example
|
|
2964
|
+
* ```typescript
|
|
2965
|
+
* // Get the value IDs from getById()
|
|
2966
|
+
* const values = await choicesets.getById('<choiceSetId>');
|
|
2967
|
+
* const idsToDelete = values.items.slice(0, 2).map(v => v.id);
|
|
2968
|
+
*
|
|
2969
|
+
* await choicesets.deleteValuesById('<choiceSetId>', idsToDelete);
|
|
2970
|
+
* ```
|
|
2971
|
+
* @internal
|
|
2972
|
+
*/
|
|
2973
|
+
deleteValuesById(choiceSetId: string, valueIds: string[]): Promise<void>;
|
|
2974
|
+
private resolveChoiceSetName;
|
|
2975
|
+
}
|
|
2976
|
+
|
|
2977
|
+
/**
|
|
2978
|
+
* Insights Types
|
|
2979
|
+
* Shared types for Maestro insights analytics endpoints
|
|
2980
|
+
*/
|
|
2981
|
+
/**
|
|
2982
|
+
* Optional filters for Insights "top" endpoint queries.
|
|
2983
|
+
* All fields are optional — pass any combination to narrow results.
|
|
2984
|
+
*/
|
|
2985
|
+
interface TopQueryOptions {
|
|
2986
|
+
/** Filter by package identifier */
|
|
2987
|
+
packageId?: string;
|
|
2988
|
+
/** Filter by process key */
|
|
2989
|
+
processKey?: string;
|
|
2990
|
+
/** Filter by package version */
|
|
2991
|
+
version?: string;
|
|
2992
|
+
}
|
|
2993
|
+
/**
|
|
2994
|
+
* Common fields returned by all Insights "top" endpoints
|
|
2995
|
+
*/
|
|
2996
|
+
interface GetTopBaseResponse {
|
|
2997
|
+
/** The package identifier */
|
|
2998
|
+
packageId: string;
|
|
2999
|
+
/** The unique process key */
|
|
3000
|
+
processKey: string;
|
|
3001
|
+
}
|
|
3002
|
+
/**
|
|
3003
|
+
* Response for the top run count Insights endpoint
|
|
3004
|
+
*/
|
|
3005
|
+
interface GetTopRunCountResponse extends GetTopBaseResponse {
|
|
3006
|
+
/** Number of times the process was run in the given time range */
|
|
3007
|
+
runCount: number;
|
|
3008
|
+
}
|
|
3009
|
+
/**
|
|
3010
|
+
* Response for the top failure count Insights endpoint
|
|
3011
|
+
*/
|
|
3012
|
+
interface GetTopFaultedCountResponse extends GetTopBaseResponse {
|
|
3013
|
+
/** Number of faulted instances in the given time range */
|
|
3014
|
+
faultedCount: number;
|
|
3015
|
+
}
|
|
3016
|
+
/**
|
|
3017
|
+
* Time bucketing granularity for insights time-series queries.
|
|
3018
|
+
*
|
|
3019
|
+
* Controls how data points are grouped on the time axis.
|
|
3020
|
+
*/
|
|
3021
|
+
declare enum TimeInterval {
|
|
3022
|
+
/** Group data points by hour */
|
|
3023
|
+
Hour = "HOUR",
|
|
3024
|
+
/** Group data points by day */
|
|
3025
|
+
Day = "DAY",
|
|
3026
|
+
/** Group data points by week */
|
|
3027
|
+
Week = "WEEK"
|
|
3028
|
+
}
|
|
3029
|
+
/**
|
|
3030
|
+
* Options for insights time-series queries.
|
|
3031
|
+
*/
|
|
3032
|
+
interface TimelineOptions {
|
|
3033
|
+
/**
|
|
3034
|
+
* How to group data points on the time axis.
|
|
3035
|
+
* @default TimeInterval.Day
|
|
3036
|
+
*/
|
|
3037
|
+
groupBy?: TimeInterval;
|
|
3038
|
+
}
|
|
3039
|
+
/**
|
|
3040
|
+
* Final instance statuses returned by the instance status timeline endpoint.
|
|
3041
|
+
*
|
|
3042
|
+
* Only includes statuses where the instance has finished execution — Completed, Faulted, or Cancelled.
|
|
3043
|
+
* Active statuses like Running or Paused are not included.
|
|
3044
|
+
*/
|
|
3045
|
+
declare enum InstanceFinalStatus {
|
|
3046
|
+
/** Instance completed successfully */
|
|
3047
|
+
Completed = "Completed",
|
|
3048
|
+
/** Instance encountered an error */
|
|
3049
|
+
Faulted = "Faulted",
|
|
3050
|
+
/** Instance was cancelled */
|
|
3051
|
+
Cancelled = "Cancelled"
|
|
3052
|
+
}
|
|
3053
|
+
/**
|
|
3054
|
+
* Instance count for a process with a given status
|
|
3055
|
+
* within a specific time bucket.
|
|
3056
|
+
*/
|
|
3057
|
+
interface InstanceStatusTimelineResponse {
|
|
3058
|
+
/** Start of the time bucket in local timezone (e.g. `"5/8/2026 12:00:00 AM"`) */
|
|
3059
|
+
startTime: string;
|
|
3060
|
+
/** Instance status */
|
|
3061
|
+
status: InstanceFinalStatus;
|
|
3062
|
+
/** Number of instances with this status in the time bucket */
|
|
3063
|
+
count: number;
|
|
3064
|
+
}
|
|
3065
|
+
/**
|
|
3066
|
+
* Response for the top duration Insights endpoint
|
|
3067
|
+
*/
|
|
3068
|
+
interface GetTopDurationResponse extends GetTopBaseResponse {
|
|
3069
|
+
/** Total execution duration in milliseconds */
|
|
3070
|
+
duration: number;
|
|
2669
3071
|
}
|
|
2670
3072
|
|
|
2671
3073
|
/**
|
|
2672
3074
|
* Maestro Process Types
|
|
2673
3075
|
* Types and interfaces for Maestro process management
|
|
2674
3076
|
*/
|
|
3077
|
+
|
|
2675
3078
|
/**
|
|
2676
3079
|
* Process information with instance statistics
|
|
2677
3080
|
*/
|
|
@@ -2711,6 +3114,27 @@ interface RawMaestroProcessGetAllResponse {
|
|
|
2711
3114
|
/** Process instance count - canceling */
|
|
2712
3115
|
cancelingCount: number;
|
|
2713
3116
|
}
|
|
3117
|
+
/**
|
|
3118
|
+
* Response for a single entry in top processes by run count
|
|
3119
|
+
*/
|
|
3120
|
+
interface ProcessGetTopRunCountResponse extends GetTopRunCountResponse {
|
|
3121
|
+
/** Human-readable process name */
|
|
3122
|
+
name: string;
|
|
3123
|
+
}
|
|
3124
|
+
/**
|
|
3125
|
+
* Response for a single entry in top processes by failure count
|
|
3126
|
+
*/
|
|
3127
|
+
interface ProcessGetTopFaultedCountResponse extends GetTopFaultedCountResponse {
|
|
3128
|
+
/** Human-readable process name */
|
|
3129
|
+
name: string;
|
|
3130
|
+
}
|
|
3131
|
+
/**
|
|
3132
|
+
* Response for a single entry in top processes by duration
|
|
3133
|
+
*/
|
|
3134
|
+
interface ProcessGetTopDurationResponse extends GetTopDurationResponse {
|
|
3135
|
+
/** Human-readable process name */
|
|
3136
|
+
name: string;
|
|
3137
|
+
}
|
|
2714
3138
|
|
|
2715
3139
|
/**
|
|
2716
3140
|
* Process Incident Status
|
|
@@ -2838,29 +3262,184 @@ interface MaestroProcessesServiceModel {
|
|
|
2838
3262
|
* ```
|
|
2839
3263
|
*/
|
|
2840
3264
|
getIncidents(processKey: string, folderKey: string): Promise<ProcessIncidentGetResponse[]>;
|
|
2841
|
-
}
|
|
2842
|
-
interface ProcessMethods {
|
|
2843
3265
|
/**
|
|
2844
|
-
*
|
|
3266
|
+
* Get the top 5 processes ranked by run count within a time range.
|
|
2845
3267
|
*
|
|
2846
|
-
*
|
|
3268
|
+
* Returns an array of up to 5 processes sorted by how many times they were executed,
|
|
3269
|
+
* useful for identifying the most active processes in a given period.
|
|
3270
|
+
*
|
|
3271
|
+
* @param startTime - Start of the time range to query
|
|
3272
|
+
* @param endTime - End of the time range to query
|
|
3273
|
+
* @param options - Optional filters (packageId, processKey, version)
|
|
3274
|
+
* @returns Promise resolving to an array of {@link ProcessGetTopRunCountResponse}
|
|
3275
|
+
* @example
|
|
3276
|
+
* ```typescript
|
|
3277
|
+
* import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
|
|
3278
|
+
*
|
|
3279
|
+
* const maestroProcesses = new MaestroProcesses(sdk);
|
|
3280
|
+
*
|
|
3281
|
+
* // Get top processes by run count for the last 7 days
|
|
3282
|
+
* const topProcesses = await maestroProcesses.getTopRunCount(
|
|
3283
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
3284
|
+
* new Date()
|
|
3285
|
+
* );
|
|
3286
|
+
*
|
|
3287
|
+
* for (const process of topProcesses) {
|
|
3288
|
+
* console.log(`${process.packageId}: ${process.runCount} runs`);
|
|
3289
|
+
* }
|
|
3290
|
+
* ```
|
|
3291
|
+
*
|
|
3292
|
+
* @example
|
|
3293
|
+
* ```typescript
|
|
3294
|
+
* // Get top processes by run count for a specific package
|
|
3295
|
+
* const filtered = await maestroProcesses.getTopRunCount(
|
|
3296
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
3297
|
+
* new Date(),
|
|
3298
|
+
* { packageId: '<packageId>' }
|
|
3299
|
+
* );
|
|
3300
|
+
* ```
|
|
2847
3301
|
*/
|
|
2848
|
-
|
|
2849
|
-
|
|
2850
|
-
|
|
2851
|
-
|
|
2852
|
-
|
|
2853
|
-
|
|
2854
|
-
|
|
2855
|
-
|
|
2856
|
-
|
|
2857
|
-
|
|
2858
|
-
|
|
2859
|
-
|
|
2860
|
-
|
|
2861
|
-
|
|
2862
|
-
|
|
2863
|
-
|
|
3302
|
+
getTopRunCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopRunCountResponse[]>;
|
|
3303
|
+
/**
|
|
3304
|
+
* Get the top 10 processes ranked by failure count within a time range.
|
|
3305
|
+
*
|
|
3306
|
+
* Returns an array of up to 10 processes sorted by how many instances faulted,
|
|
3307
|
+
* useful for identifying the most error-prone processes in a given period.
|
|
3308
|
+
*
|
|
3309
|
+
* @param startTime - Start of the time range to query
|
|
3310
|
+
* @param endTime - End of the time range to query
|
|
3311
|
+
* @param options - Optional filters (packageId, processKey, version)
|
|
3312
|
+
* @returns Promise resolving to an array of {@link ProcessGetTopFaultedCountResponse}
|
|
3313
|
+
* @example
|
|
3314
|
+
* ```typescript
|
|
3315
|
+
* import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
|
|
3316
|
+
*
|
|
3317
|
+
* const maestroProcesses = new MaestroProcesses(sdk);
|
|
3318
|
+
*
|
|
3319
|
+
* // Get top processes by faulted count for the last 7 days
|
|
3320
|
+
* const topFailing = await maestroProcesses.getTopFaultedCount(
|
|
3321
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
3322
|
+
* new Date()
|
|
3323
|
+
* );
|
|
3324
|
+
*
|
|
3325
|
+
* for (const process of topFailing) {
|
|
3326
|
+
* console.log(`${process.packageId}: ${process.faultedCount} failures`);
|
|
3327
|
+
* }
|
|
3328
|
+
* ```
|
|
3329
|
+
*
|
|
3330
|
+
* @example
|
|
3331
|
+
* ```typescript
|
|
3332
|
+
* // Get top processes by faulted count for a specific package
|
|
3333
|
+
* const filtered = await maestroProcesses.getTopFaultedCount(
|
|
3334
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
3335
|
+
* new Date(),
|
|
3336
|
+
* { packageId: '<packageId>' }
|
|
3337
|
+
* );
|
|
3338
|
+
* ```
|
|
3339
|
+
*/
|
|
3340
|
+
getTopFaultedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopFaultedCountResponse[]>;
|
|
3341
|
+
/**
|
|
3342
|
+
* Get all instances status counts aggregated by date for maestro processes.
|
|
3343
|
+
*
|
|
3344
|
+
* Returns time-grouped counts of instances grouped by status (Completed, Faulted, Cancelled),
|
|
3345
|
+
* useful for rendering time-series charts. Use `groupBy` to control the time bucket size
|
|
3346
|
+
* (hour, day, or week) — defaults to day if not provided.
|
|
3347
|
+
*
|
|
3348
|
+
* @param startTime - Start of the time range to query
|
|
3349
|
+
* @param endTime - End of the time range to query
|
|
3350
|
+
* @param options - Optional settings for time bucketing granularity
|
|
3351
|
+
* @returns Promise resolving to an array of {@link InstanceStatusTimelineResponse}
|
|
3352
|
+
*
|
|
3353
|
+
* @example
|
|
3354
|
+
* ```typescript
|
|
3355
|
+
* // Get daily instance status for the last 7 days
|
|
3356
|
+
* const now = new Date();
|
|
3357
|
+
* const sevenDaysAgo = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
|
|
3358
|
+
* const statuses = await maestroProcesses.getInstanceStatusTimeline(sevenDaysAgo, now);
|
|
3359
|
+
*
|
|
3360
|
+
* for (const entry of statuses) {
|
|
3361
|
+
* console.log(`${entry.startTime} — ${entry.status}: ${entry.count}`);
|
|
3362
|
+
* }
|
|
3363
|
+
* ```
|
|
3364
|
+
*
|
|
3365
|
+
* @example
|
|
3366
|
+
* ```typescript
|
|
3367
|
+
* import { TimeInterval } from '@uipath/uipath-typescript/maestro-processes';
|
|
3368
|
+
*
|
|
3369
|
+
* // Get hourly breakdown
|
|
3370
|
+
* const statuses = await maestroProcesses.getInstanceStatusTimeline(startTime, endTime, {
|
|
3371
|
+
* groupBy: TimeInterval.Hour,
|
|
3372
|
+
* });
|
|
3373
|
+
* ```
|
|
3374
|
+
*
|
|
3375
|
+
* @example
|
|
3376
|
+
* ```typescript
|
|
3377
|
+
* // Get all-time data (from Unix epoch to now)
|
|
3378
|
+
* const allTime = await maestroProcesses.getInstanceStatusTimeline(new Date(0), new Date());
|
|
3379
|
+
* ```
|
|
3380
|
+
*/
|
|
3381
|
+
getInstanceStatusTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<InstanceStatusTimelineResponse[]>;
|
|
3382
|
+
/**
|
|
3383
|
+
* Get the top 5 processes ranked by total duration within a time range.
|
|
3384
|
+
*
|
|
3385
|
+
* Returns an array of up to 5 processes sorted by their total execution time,
|
|
3386
|
+
* useful for identifying the longest-running processes in a given period.
|
|
3387
|
+
*
|
|
3388
|
+
* @param startTime - Start of the time range to query
|
|
3389
|
+
* @param endTime - End of the time range to query
|
|
3390
|
+
* @param options - Optional filters (packageId, processKey, version)
|
|
3391
|
+
* @returns Promise resolving to an array of {@link ProcessGetTopDurationResponse}
|
|
3392
|
+
* @example
|
|
3393
|
+
* ```typescript
|
|
3394
|
+
* import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
|
|
3395
|
+
*
|
|
3396
|
+
* const maestroProcesses = new MaestroProcesses(sdk);
|
|
3397
|
+
*
|
|
3398
|
+
* // Get top processes by duration for the last 7 days
|
|
3399
|
+
* const topProcesses = await maestroProcesses.getTopExecutionDuration(
|
|
3400
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
3401
|
+
* new Date()
|
|
3402
|
+
* );
|
|
3403
|
+
*
|
|
3404
|
+
* for (const process of topProcesses) {
|
|
3405
|
+
* console.log(`${process.packageId}: ${process.duration}ms total`);
|
|
3406
|
+
* }
|
|
3407
|
+
* ```
|
|
3408
|
+
*
|
|
3409
|
+
* @example
|
|
3410
|
+
* ```typescript
|
|
3411
|
+
* // Get top processes by duration for a specific package
|
|
3412
|
+
* const filtered = await maestroProcesses.getTopExecutionDuration(
|
|
3413
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
3414
|
+
* new Date(),
|
|
3415
|
+
* { packageId: '<packageId>' }
|
|
3416
|
+
* );
|
|
3417
|
+
* ```
|
|
3418
|
+
*/
|
|
3419
|
+
getTopExecutionDuration(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopDurationResponse[]>;
|
|
3420
|
+
}
|
|
3421
|
+
interface ProcessMethods {
|
|
3422
|
+
/**
|
|
3423
|
+
* Gets incidents for this process
|
|
3424
|
+
*
|
|
3425
|
+
* @returns Promise resolving to array of process incidents
|
|
3426
|
+
*/
|
|
3427
|
+
getIncidents(): Promise<ProcessIncidentGetResponse[]>;
|
|
3428
|
+
}
|
|
3429
|
+
type MaestroProcessGetAllResponse = RawMaestroProcessGetAllResponse & ProcessMethods;
|
|
3430
|
+
/**
|
|
3431
|
+
* Creates an actionable process by combining API process data with operational methods.
|
|
3432
|
+
*
|
|
3433
|
+
* @param processData - The process data from API
|
|
3434
|
+
* @param service - The process service instance
|
|
3435
|
+
* @returns A process object with added methods
|
|
3436
|
+
*/
|
|
3437
|
+
declare function createProcessWithMethods(processData: MaestroProcessGetAllResponse, service: MaestroProcessesServiceModel): MaestroProcessGetAllResponse;
|
|
3438
|
+
|
|
3439
|
+
/**
|
|
3440
|
+
* Constants used throughout the pagination system
|
|
3441
|
+
*/
|
|
3442
|
+
/** Maximum number of items that can be requested in a single page */
|
|
2864
3443
|
declare const MAX_PAGE_SIZE = 1000;
|
|
2865
3444
|
/** Default page size when jumpToPage is used without specifying pageSize */
|
|
2866
3445
|
declare const DEFAULT_PAGE_SIZE = 50;
|
|
@@ -3376,6 +3955,7 @@ interface ProcessIncidentsServiceModel {
|
|
|
3376
3955
|
* Maestro Cases Types
|
|
3377
3956
|
* Types and interfaces for Maestro case management
|
|
3378
3957
|
*/
|
|
3958
|
+
|
|
3379
3959
|
/**
|
|
3380
3960
|
* Case information with instance statistics
|
|
3381
3961
|
*/
|
|
@@ -3415,6 +3995,27 @@ interface CaseGetAllResponse {
|
|
|
3415
3995
|
/** Case instance count - canceling */
|
|
3416
3996
|
cancelingCount: number;
|
|
3417
3997
|
}
|
|
3998
|
+
/**
|
|
3999
|
+
* Response for a single entry in top cases by run count
|
|
4000
|
+
*/
|
|
4001
|
+
interface CaseGetTopRunCountResponse extends GetTopRunCountResponse {
|
|
4002
|
+
/** Human-readable case name */
|
|
4003
|
+
name: string;
|
|
4004
|
+
}
|
|
4005
|
+
/**
|
|
4006
|
+
* Response for a single entry in top cases by failure count
|
|
4007
|
+
*/
|
|
4008
|
+
interface CaseGetTopFaultedCountResponse extends GetTopFaultedCountResponse {
|
|
4009
|
+
/** Human-readable case name */
|
|
4010
|
+
name: string;
|
|
4011
|
+
}
|
|
4012
|
+
/**
|
|
4013
|
+
* Response for a single entry in top cases by duration
|
|
4014
|
+
*/
|
|
4015
|
+
interface CaseGetTopDurationResponse extends GetTopDurationResponse {
|
|
4016
|
+
/** Human-readable case name */
|
|
4017
|
+
name: string;
|
|
4018
|
+
}
|
|
3418
4019
|
|
|
3419
4020
|
/**
|
|
3420
4021
|
* Maestro Cases Models
|
|
@@ -3455,6 +4056,161 @@ interface CasesServiceModel {
|
|
|
3455
4056
|
* ```
|
|
3456
4057
|
*/
|
|
3457
4058
|
getAll(): Promise<CaseGetAllResponse[]>;
|
|
4059
|
+
/**
|
|
4060
|
+
* Get the top 5 case processes ranked by run count within a time range.
|
|
4061
|
+
*
|
|
4062
|
+
* Returns an array of up to 5 case processes sorted by how many times they were executed,
|
|
4063
|
+
* useful for identifying the most active case processes in a given period.
|
|
4064
|
+
*
|
|
4065
|
+
* @param startTime - Start of the time range to query
|
|
4066
|
+
* @param endTime - End of the time range to query
|
|
4067
|
+
* @param options - Optional filters (packageId, processKey, version)
|
|
4068
|
+
* @returns Promise resolving to an array of {@link CaseGetTopRunCountResponse}
|
|
4069
|
+
* @example
|
|
4070
|
+
* ```typescript
|
|
4071
|
+
* import { Cases } from '@uipath/uipath-typescript/cases';
|
|
4072
|
+
*
|
|
4073
|
+
* const cases = new Cases(sdk);
|
|
4074
|
+
*
|
|
4075
|
+
* // Get top case processes by run count for the last 7 days
|
|
4076
|
+
* const topProcesses = await cases.getTopRunCount(
|
|
4077
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
4078
|
+
* new Date()
|
|
4079
|
+
* );
|
|
4080
|
+
*
|
|
4081
|
+
* for (const process of topProcesses) {
|
|
4082
|
+
* console.log(`${process.packageId}: ${process.runCount} runs`);
|
|
4083
|
+
* }
|
|
4084
|
+
* ```
|
|
4085
|
+
*
|
|
4086
|
+
* @example
|
|
4087
|
+
* ```typescript
|
|
4088
|
+
* // Get top case processes by run count for a specific package
|
|
4089
|
+
* const filtered = await cases.getTopRunCount(
|
|
4090
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
4091
|
+
* new Date(),
|
|
4092
|
+
* { packageId: '<packageId>' }
|
|
4093
|
+
* );
|
|
4094
|
+
* ```
|
|
4095
|
+
*/
|
|
4096
|
+
getTopRunCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopRunCountResponse[]>;
|
|
4097
|
+
/**
|
|
4098
|
+
* Get the top 10 case processes ranked by failure count within a time range.
|
|
4099
|
+
*
|
|
4100
|
+
* Returns an array of up to 10 case processes sorted by how many instances faulted,
|
|
4101
|
+
* useful for identifying the most error-prone case processes in a given period.
|
|
4102
|
+
*
|
|
4103
|
+
* @param startTime - Start of the time range to query
|
|
4104
|
+
* @param endTime - End of the time range to query
|
|
4105
|
+
* @param options - Optional filters (packageId, processKey, version)
|
|
4106
|
+
* @returns Promise resolving to an array of {@link CaseGetTopFaultedCountResponse}
|
|
4107
|
+
* @example
|
|
4108
|
+
* ```typescript
|
|
4109
|
+
* import { Cases } from '@uipath/uipath-typescript/cases';
|
|
4110
|
+
*
|
|
4111
|
+
* const cases = new Cases(sdk);
|
|
4112
|
+
*
|
|
4113
|
+
* // Get top case processes by faulted count for the last 7 days
|
|
4114
|
+
* const topFailing = await cases.getTopFaultedCount(
|
|
4115
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
4116
|
+
* new Date()
|
|
4117
|
+
* );
|
|
4118
|
+
*
|
|
4119
|
+
* for (const process of topFailing) {
|
|
4120
|
+
* console.log(`${process.packageId}: ${process.faultedCount} failures`);
|
|
4121
|
+
* }
|
|
4122
|
+
* ```
|
|
4123
|
+
*
|
|
4124
|
+
* @example
|
|
4125
|
+
* ```typescript
|
|
4126
|
+
* // Get top case processes by faulted count for a specific package
|
|
4127
|
+
* const filtered = await cases.getTopFaultedCount(
|
|
4128
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
4129
|
+
* new Date(),
|
|
4130
|
+
* { packageId: '<packageId>' }
|
|
4131
|
+
* );
|
|
4132
|
+
* ```
|
|
4133
|
+
*/
|
|
4134
|
+
getTopFaultedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopFaultedCountResponse[]>;
|
|
4135
|
+
/**
|
|
4136
|
+
* Get all instances status counts aggregated by date for case management processes.
|
|
4137
|
+
*
|
|
4138
|
+
* Returns time-grouped counts of case instances grouped by status (Completed, Faulted, Cancelled),
|
|
4139
|
+
* useful for rendering time-series charts. Use `groupBy` to control the time bucket size
|
|
4140
|
+
* (hour, day, or week) — defaults to day if not provided.
|
|
4141
|
+
*
|
|
4142
|
+
* @param startTime - Start of the time range to query
|
|
4143
|
+
* @param endTime - End of the time range to query
|
|
4144
|
+
* @param options - Optional settings for time bucketing granularity
|
|
4145
|
+
* @returns Promise resolving to an array of {@link InstanceStatusTimelineResponse}
|
|
4146
|
+
*
|
|
4147
|
+
* @example
|
|
4148
|
+
* ```typescript
|
|
4149
|
+
* // Get daily instance status for the last 7 days
|
|
4150
|
+
* const now = new Date();
|
|
4151
|
+
* const sevenDaysAgo = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
|
|
4152
|
+
* const statuses = await cases.getInstanceStatusTimeline(sevenDaysAgo, now);
|
|
4153
|
+
*
|
|
4154
|
+
* for (const entry of statuses) {
|
|
4155
|
+
* console.log(`${entry.startTime} — ${entry.status}: ${entry.count}`);
|
|
4156
|
+
* }
|
|
4157
|
+
* ```
|
|
4158
|
+
*
|
|
4159
|
+
* @example
|
|
4160
|
+
* ```typescript
|
|
4161
|
+
* import { TimeInterval } from '@uipath/uipath-typescript/cases';
|
|
4162
|
+
*
|
|
4163
|
+
* // Get weekly breakdown
|
|
4164
|
+
* const statuses = await cases.getInstanceStatusTimeline(startTime, endTime, {
|
|
4165
|
+
* groupBy: TimeInterval.Week,
|
|
4166
|
+
* });
|
|
4167
|
+
* ```
|
|
4168
|
+
*
|
|
4169
|
+
* @example
|
|
4170
|
+
* ```typescript
|
|
4171
|
+
* // Get all-time data (from Unix epoch to now)
|
|
4172
|
+
* const allTime = await cases.getInstanceStatusTimeline(new Date(0), new Date());
|
|
4173
|
+
* ```
|
|
4174
|
+
*/
|
|
4175
|
+
getInstanceStatusTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<InstanceStatusTimelineResponse[]>;
|
|
4176
|
+
/**
|
|
4177
|
+
* Get the top 5 case processes ranked by total duration within a time range.
|
|
4178
|
+
*
|
|
4179
|
+
* Returns an array of up to 5 case processes sorted by their total execution time,
|
|
4180
|
+
* useful for identifying the longest-running case processes in a given period.
|
|
4181
|
+
*
|
|
4182
|
+
* @param startTime - Start of the time range to query
|
|
4183
|
+
* @param endTime - End of the time range to query
|
|
4184
|
+
* @param options - Optional filters (packageId, processKey, version)
|
|
4185
|
+
* @returns Promise resolving to an array of {@link CaseGetTopDurationResponse}
|
|
4186
|
+
* @example
|
|
4187
|
+
* ```typescript
|
|
4188
|
+
* import { Cases } from '@uipath/uipath-typescript/cases';
|
|
4189
|
+
*
|
|
4190
|
+
* const cases = new Cases(sdk);
|
|
4191
|
+
*
|
|
4192
|
+
* // Get top case processes by duration for the last 7 days
|
|
4193
|
+
* const topProcesses = await cases.getTopExecutionDuration(
|
|
4194
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
4195
|
+
* new Date()
|
|
4196
|
+
* );
|
|
4197
|
+
*
|
|
4198
|
+
* for (const process of topProcesses) {
|
|
4199
|
+
* console.log(`${process.packageId}: ${process.duration}ms total`);
|
|
4200
|
+
* }
|
|
4201
|
+
* ```
|
|
4202
|
+
*
|
|
4203
|
+
* @example
|
|
4204
|
+
* ```typescript
|
|
4205
|
+
* // Get top case processes by duration for a specific package
|
|
4206
|
+
* const filtered = await cases.getTopExecutionDuration(
|
|
4207
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
4208
|
+
* new Date(),
|
|
4209
|
+
* { packageId: '<packageId>' }
|
|
4210
|
+
* );
|
|
4211
|
+
* ```
|
|
4212
|
+
*/
|
|
4213
|
+
getTopExecutionDuration(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopDurationResponse[]>;
|
|
3458
4214
|
}
|
|
3459
4215
|
|
|
3460
4216
|
/**
|
|
@@ -3616,6 +4372,41 @@ type CaseInstanceSlaSummaryOptions = PaginationOptions & {
|
|
|
3616
4372
|
/** Filter by event end time in UTC */
|
|
3617
4373
|
endTimeUtc?: Date;
|
|
3618
4374
|
};
|
|
4375
|
+
/**
|
|
4376
|
+
* Stage SLA summary for a single stage within a case instance (from Insights RTM)
|
|
4377
|
+
*/
|
|
4378
|
+
interface CaseInstanceStageSLAStage {
|
|
4379
|
+
/** Stage element identifier */
|
|
4380
|
+
elementId: string;
|
|
4381
|
+
/** Stage display name */
|
|
4382
|
+
name: string;
|
|
4383
|
+
/** Current execution status of the stage */
|
|
4384
|
+
latestStatus: string;
|
|
4385
|
+
/** SLA deadline timestamp in UTC (e.g. `"9/17/2025 8:35:38 PM"`) or empty string if no SLA is configured */
|
|
4386
|
+
slaDueTime: string;
|
|
4387
|
+
/** SLA status for this stage */
|
|
4388
|
+
slaStatus: SlaSummaryStatus;
|
|
4389
|
+
/** Index of the current escalation rule */
|
|
4390
|
+
escalationRuleIndex: string;
|
|
4391
|
+
/** Type of the current escalation rule */
|
|
4392
|
+
escalationRuleType: EscalationTriggerType;
|
|
4393
|
+
}
|
|
4394
|
+
/**
|
|
4395
|
+
* Stages SLA summary for a single case instance (from Insights RTM)
|
|
4396
|
+
*/
|
|
4397
|
+
interface CaseInstanceStageSLAResponse {
|
|
4398
|
+
/** Case instance identifier */
|
|
4399
|
+
caseInstanceId: string;
|
|
4400
|
+
/** Stages within this case instance */
|
|
4401
|
+
stages: CaseInstanceStageSLAStage[];
|
|
4402
|
+
}
|
|
4403
|
+
/**
|
|
4404
|
+
* Options for querying stages SLA summary
|
|
4405
|
+
*/
|
|
4406
|
+
interface CaseInstanceStageSLAOptions {
|
|
4407
|
+
/** Filter to a specific case instance */
|
|
4408
|
+
caseInstanceId?: string;
|
|
4409
|
+
}
|
|
3619
4410
|
/**
|
|
3620
4411
|
* Case stage task type
|
|
3621
4412
|
*/
|
|
@@ -4339,6 +5130,11 @@ declare function createTaskWithMethods(taskData: RawTaskGetResponse | RawTaskCre
|
|
|
4339
5130
|
* const caseInstances = new CaseInstances(sdk);
|
|
4340
5131
|
* const allInstances = await caseInstances.getAll();
|
|
4341
5132
|
* ```
|
|
5133
|
+
*
|
|
5134
|
+
* !!! note
|
|
5135
|
+
* Methods that rely on the Insights Real-Time Monitoring service (`getSlaSummary`, `getStagesSlaSummary`)
|
|
5136
|
+
* may have up to ~1 minute latency before reflecting the latest updates. See
|
|
5137
|
+
* [Real-Time Monitoring Overview](https://docs.uipath.com/insights/automation-cloud/latest/user-guide/real-time-monitoring-overview) for details.
|
|
4342
5138
|
*/
|
|
4343
5139
|
interface CaseInstancesServiceModel {
|
|
4344
5140
|
/**
|
|
@@ -4606,6 +5402,35 @@ interface CaseInstancesServiceModel {
|
|
|
4606
5402
|
* ```
|
|
4607
5403
|
*/
|
|
4608
5404
|
getSlaSummary<T extends CaseInstanceSlaSummaryOptions = CaseInstanceSlaSummaryOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<SlaSummaryResponse> : NonPaginatedResponse<SlaSummaryResponse>>;
|
|
5405
|
+
/**
|
|
5406
|
+
* Get stages SLA summary for case instances across folders.
|
|
5407
|
+
*
|
|
5408
|
+
* Returns stage-level SLA status and escalation information for each case instance, aggregated from Insights Real-Time Monitoring.
|
|
5409
|
+
*
|
|
5410
|
+
* @param options - Optional filtering options
|
|
5411
|
+
* @returns Promise resolving to an array of {@link CaseInstanceStageSLAResponse}
|
|
5412
|
+
* @example
|
|
5413
|
+
* ```typescript
|
|
5414
|
+
* // Get stages SLA summary for all case instances
|
|
5415
|
+
* const stagesSla = await caseInstances.getStagesSlaSummary();
|
|
5416
|
+
* for (const item of stagesSla) {
|
|
5417
|
+
* console.log(`Instance: ${item.caseInstanceId}`);
|
|
5418
|
+
* for (const stage of item.stages) {
|
|
5419
|
+
* console.log(` Stage: ${stage.name} - SLA Status: ${stage.slaStatus}, Due: ${stage.slaDueTime}`);
|
|
5420
|
+
* }
|
|
5421
|
+
* }
|
|
5422
|
+
*
|
|
5423
|
+
* // Filter by case instance ID
|
|
5424
|
+
* const filtered = await caseInstances.getStagesSlaSummary({
|
|
5425
|
+
* caseInstanceId: '<caseInstanceId>'
|
|
5426
|
+
* });
|
|
5427
|
+
*
|
|
5428
|
+
* // Using bound method on a case instance
|
|
5429
|
+
* const instance = await caseInstances.getById('<instanceId>', '<folderKey>');
|
|
5430
|
+
* const stagesSla = await instance.getStagesSlaSummary();
|
|
5431
|
+
* ```
|
|
5432
|
+
*/
|
|
5433
|
+
getStagesSlaSummary(options?: CaseInstanceStageSLAOptions): Promise<CaseInstanceStageSLAResponse[]>;
|
|
4609
5434
|
}
|
|
4610
5435
|
interface CaseInstanceMethods {
|
|
4611
5436
|
/**
|
|
@@ -4663,6 +5488,12 @@ interface CaseInstanceMethods {
|
|
|
4663
5488
|
* @returns Promise resolving to SLA summary items for this case instance
|
|
4664
5489
|
*/
|
|
4665
5490
|
getSlaSummary<T extends Omit<CaseInstanceSlaSummaryOptions, 'caseInstanceId'> = Omit<CaseInstanceSlaSummaryOptions, 'caseInstanceId'>>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<SlaSummaryResponse> : NonPaginatedResponse<SlaSummaryResponse>>;
|
|
5491
|
+
/**
|
|
5492
|
+
* Gets the stages SLA summary for this case instance.
|
|
5493
|
+
*
|
|
5494
|
+
* @returns Promise resolving to an array of stage SLA summary items for this case instance
|
|
5495
|
+
*/
|
|
5496
|
+
getStagesSlaSummary(): Promise<CaseInstanceStageSLAResponse[]>;
|
|
4666
5497
|
}
|
|
4667
5498
|
type CaseInstanceGetResponse = RawCaseInstanceGetResponse & CaseInstanceMethods;
|
|
4668
5499
|
/**
|
|
@@ -4709,6 +5540,161 @@ declare class MaestroProcessesService extends BaseService implements MaestroProc
|
|
|
4709
5540
|
* Get incidents for a specific process
|
|
4710
5541
|
*/
|
|
4711
5542
|
getIncidents(processKey: string, folderKey: string): Promise<ProcessIncidentGetResponse[]>;
|
|
5543
|
+
/**
|
|
5544
|
+
* Get the top 5 processes ranked by run count within a time range.
|
|
5545
|
+
*
|
|
5546
|
+
* Returns an array of up to 5 processes sorted by how many times they were executed,
|
|
5547
|
+
* useful for identifying the most active processes in a given period.
|
|
5548
|
+
*
|
|
5549
|
+
* @param startTime - Start of the time range to query
|
|
5550
|
+
* @param endTime - End of the time range to query
|
|
5551
|
+
* @param options - Optional filters (packageId, processKey, version)
|
|
5552
|
+
* @returns Promise resolving to an array of {@link ProcessGetTopRunCountResponse}
|
|
5553
|
+
* @example
|
|
5554
|
+
* ```typescript
|
|
5555
|
+
* import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
|
|
5556
|
+
*
|
|
5557
|
+
* const maestroProcesses = new MaestroProcesses(sdk);
|
|
5558
|
+
*
|
|
5559
|
+
* // Get top processes by run count for the last 7 days
|
|
5560
|
+
* const topProcesses = await maestroProcesses.getTopRunCount(
|
|
5561
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
5562
|
+
* new Date()
|
|
5563
|
+
* );
|
|
5564
|
+
*
|
|
5565
|
+
* for (const process of topProcesses) {
|
|
5566
|
+
* console.log(`${process.packageId}: ${process.runCount} runs`);
|
|
5567
|
+
* }
|
|
5568
|
+
* ```
|
|
5569
|
+
*
|
|
5570
|
+
* @example
|
|
5571
|
+
* ```typescript
|
|
5572
|
+
* // Get top processes by run count for a specific package
|
|
5573
|
+
* const filtered = await maestroProcesses.getTopRunCount(
|
|
5574
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
5575
|
+
* new Date(),
|
|
5576
|
+
* { packageId: '<packageId>' }
|
|
5577
|
+
* );
|
|
5578
|
+
* ```
|
|
5579
|
+
*/
|
|
5580
|
+
getTopRunCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopRunCountResponse[]>;
|
|
5581
|
+
/**
|
|
5582
|
+
* Get all instances status counts aggregated by date for maestro processes.
|
|
5583
|
+
*
|
|
5584
|
+
* Returns time-grouped counts of instances grouped by status (Completed, Faulted, Cancelled),
|
|
5585
|
+
* useful for rendering time-series charts. Use `groupBy` to control the time bucket size
|
|
5586
|
+
* (hour, day, or week) — defaults to day if not provided.
|
|
5587
|
+
*
|
|
5588
|
+
* @param startTime - Start of the time range to query
|
|
5589
|
+
* @param endTime - End of the time range to query
|
|
5590
|
+
* @param options - Optional settings for time bucketing granularity
|
|
5591
|
+
* @returns Promise resolving to an array of {@link InstanceStatusTimelineResponse}
|
|
5592
|
+
*
|
|
5593
|
+
* @example
|
|
5594
|
+
* ```typescript
|
|
5595
|
+
* // Get daily instance status for the last 7 days
|
|
5596
|
+
* const now = new Date();
|
|
5597
|
+
* const sevenDaysAgo = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
|
|
5598
|
+
* const statuses = await maestroProcesses.getInstanceStatusTimeline(sevenDaysAgo, now);
|
|
5599
|
+
*
|
|
5600
|
+
* for (const entry of statuses) {
|
|
5601
|
+
* console.log(`${entry.startTime} — ${entry.status}: ${entry.count}`);
|
|
5602
|
+
* }
|
|
5603
|
+
* ```
|
|
5604
|
+
*
|
|
5605
|
+
* @example
|
|
5606
|
+
* ```typescript
|
|
5607
|
+
* import { TimeInterval } from '@uipath/uipath-typescript/maestro-processes';
|
|
5608
|
+
*
|
|
5609
|
+
* // Get hourly breakdown
|
|
5610
|
+
* const statuses = await maestroProcesses.getInstanceStatusTimeline(startTime, endTime, {
|
|
5611
|
+
* groupBy: TimeInterval.Hour,
|
|
5612
|
+
* });
|
|
5613
|
+
* ```
|
|
5614
|
+
*
|
|
5615
|
+
* @example
|
|
5616
|
+
* ```typescript
|
|
5617
|
+
* // Get all-time data (from Unix epoch to now)
|
|
5618
|
+
* const allTime = await maestroProcesses.getInstanceStatusTimeline(new Date(0), new Date());
|
|
5619
|
+
* ```
|
|
5620
|
+
*/
|
|
5621
|
+
getInstanceStatusTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<InstanceStatusTimelineResponse[]>;
|
|
5622
|
+
/**
|
|
5623
|
+
* Get the top 10 processes ranked by failure count within a time range.
|
|
5624
|
+
*
|
|
5625
|
+
* Returns an array of up to 10 processes sorted by how many instances faulted,
|
|
5626
|
+
* useful for identifying the most error-prone processes in a given period.
|
|
5627
|
+
*
|
|
5628
|
+
* @param startTime - Start of the time range to query
|
|
5629
|
+
* @param endTime - End of the time range to query
|
|
5630
|
+
* @param options - Optional filters (packageId, processKey, version)
|
|
5631
|
+
* @returns Promise resolving to an array of {@link ProcessGetTopFaultedCountResponse}
|
|
5632
|
+
* @example
|
|
5633
|
+
* ```typescript
|
|
5634
|
+
* import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
|
|
5635
|
+
*
|
|
5636
|
+
* const maestroProcesses = new MaestroProcesses(sdk);
|
|
5637
|
+
*
|
|
5638
|
+
* // Get top processes by faulted count for the last 7 days
|
|
5639
|
+
* const topFailing = await maestroProcesses.getTopFaultedCount(
|
|
5640
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
5641
|
+
* new Date()
|
|
5642
|
+
* );
|
|
5643
|
+
*
|
|
5644
|
+
* for (const process of topFailing) {
|
|
5645
|
+
* console.log(`${process.packageId}: ${process.faultedCount} failures`);
|
|
5646
|
+
* }
|
|
5647
|
+
* ```
|
|
5648
|
+
*
|
|
5649
|
+
* @example
|
|
5650
|
+
* ```typescript
|
|
5651
|
+
* // Get top processes by faulted count for a specific package
|
|
5652
|
+
* const filtered = await maestroProcesses.getTopFaultedCount(
|
|
5653
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
5654
|
+
* new Date(),
|
|
5655
|
+
* { packageId: '<packageId>' }
|
|
5656
|
+
* );
|
|
5657
|
+
* ```
|
|
5658
|
+
*/
|
|
5659
|
+
getTopFaultedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopFaultedCountResponse[]>;
|
|
5660
|
+
/**
|
|
5661
|
+
* Get the top 5 processes ranked by total duration within a time range.
|
|
5662
|
+
*
|
|
5663
|
+
* Returns an array of up to 5 processes sorted by their total execution time,
|
|
5664
|
+
* useful for identifying the longest-running processes in a given period.
|
|
5665
|
+
*
|
|
5666
|
+
* @param startTime - Start of the time range to query
|
|
5667
|
+
* @param endTime - End of the time range to query
|
|
5668
|
+
* @param options - Optional filters (packageId, processKey, version)
|
|
5669
|
+
* @returns Promise resolving to an array of {@link ProcessGetTopDurationResponse}
|
|
5670
|
+
* @example
|
|
5671
|
+
* ```typescript
|
|
5672
|
+
* import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
|
|
5673
|
+
*
|
|
5674
|
+
* const maestroProcesses = new MaestroProcesses(sdk);
|
|
5675
|
+
*
|
|
5676
|
+
* // Get top processes by duration for the last 7 days
|
|
5677
|
+
* const topProcesses = await maestroProcesses.getTopExecutionDuration(
|
|
5678
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
5679
|
+
* new Date()
|
|
5680
|
+
* );
|
|
5681
|
+
*
|
|
5682
|
+
* for (const process of topProcesses) {
|
|
5683
|
+
* console.log(`${process.packageId}: ${process.duration}ms total`);
|
|
5684
|
+
* }
|
|
5685
|
+
* ```
|
|
5686
|
+
*
|
|
5687
|
+
* @example
|
|
5688
|
+
* ```typescript
|
|
5689
|
+
* // Get top processes by duration for a specific package
|
|
5690
|
+
* const filtered = await maestroProcesses.getTopExecutionDuration(
|
|
5691
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
5692
|
+
* new Date(),
|
|
5693
|
+
* { packageId: '<packageId>' }
|
|
5694
|
+
* );
|
|
5695
|
+
* ```
|
|
5696
|
+
*/
|
|
5697
|
+
getTopExecutionDuration(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopDurationResponse[]>;
|
|
4712
5698
|
}
|
|
4713
5699
|
|
|
4714
5700
|
declare class ProcessInstancesService extends BaseService implements ProcessInstancesServiceModel {
|
|
@@ -4888,6 +5874,161 @@ declare class CasesService extends BaseService implements CasesServiceModel {
|
|
|
4888
5874
|
* ```
|
|
4889
5875
|
*/
|
|
4890
5876
|
getAll(): Promise<CaseGetAllResponse[]>;
|
|
5877
|
+
/**
|
|
5878
|
+
* Get the top 5 case processes ranked by run count within a time range.
|
|
5879
|
+
*
|
|
5880
|
+
* Returns an array of up to 5 case processes sorted by how many times they were executed,
|
|
5881
|
+
* useful for identifying the most active case processes in a given period.
|
|
5882
|
+
*
|
|
5883
|
+
* @param startTime - Start of the time range to query
|
|
5884
|
+
* @param endTime - End of the time range to query
|
|
5885
|
+
* @param options - Optional filters (packageId, processKey, version)
|
|
5886
|
+
* @returns Promise resolving to an array of {@link CaseGetTopRunCountResponse}
|
|
5887
|
+
* @example
|
|
5888
|
+
* ```typescript
|
|
5889
|
+
* import { Cases } from '@uipath/uipath-typescript/cases';
|
|
5890
|
+
*
|
|
5891
|
+
* const cases = new Cases(sdk);
|
|
5892
|
+
*
|
|
5893
|
+
* // Get top case processes by run count for the last 7 days
|
|
5894
|
+
* const topProcesses = await cases.getTopRunCount(
|
|
5895
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
5896
|
+
* new Date()
|
|
5897
|
+
* );
|
|
5898
|
+
*
|
|
5899
|
+
* for (const process of topProcesses) {
|
|
5900
|
+
* console.log(`${process.packageId}: ${process.runCount} runs`);
|
|
5901
|
+
* }
|
|
5902
|
+
* ```
|
|
5903
|
+
*
|
|
5904
|
+
* @example
|
|
5905
|
+
* ```typescript
|
|
5906
|
+
* // Get top case processes by run count for a specific package
|
|
5907
|
+
* const filtered = await cases.getTopRunCount(
|
|
5908
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
5909
|
+
* new Date(),
|
|
5910
|
+
* { packageId: '<packageId>' }
|
|
5911
|
+
* );
|
|
5912
|
+
* ```
|
|
5913
|
+
*/
|
|
5914
|
+
getTopRunCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopRunCountResponse[]>;
|
|
5915
|
+
/**
|
|
5916
|
+
* Get all instances status counts aggregated by date for case management processes.
|
|
5917
|
+
*
|
|
5918
|
+
* Returns time-grouped counts of case instances grouped by status (Completed, Faulted, Cancelled),
|
|
5919
|
+
* useful for rendering time-series charts. Use `groupBy` to control the time bucket size
|
|
5920
|
+
* (hour, day, or week) — defaults to day if not provided.
|
|
5921
|
+
*
|
|
5922
|
+
* @param startTime - Start of the time range to query
|
|
5923
|
+
* @param endTime - End of the time range to query
|
|
5924
|
+
* @param options - Optional settings for time bucketing granularity
|
|
5925
|
+
* @returns Promise resolving to an array of {@link InstanceStatusTimelineResponse}
|
|
5926
|
+
*
|
|
5927
|
+
* @example
|
|
5928
|
+
* ```typescript
|
|
5929
|
+
* // Get daily instance status for the last 7 days
|
|
5930
|
+
* const now = new Date();
|
|
5931
|
+
* const sevenDaysAgo = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
|
|
5932
|
+
* const statuses = await cases.getInstanceStatusTimeline(sevenDaysAgo, now);
|
|
5933
|
+
*
|
|
5934
|
+
* for (const entry of statuses) {
|
|
5935
|
+
* console.log(`${entry.startTime} — ${entry.status}: ${entry.count}`);
|
|
5936
|
+
* }
|
|
5937
|
+
* ```
|
|
5938
|
+
*
|
|
5939
|
+
* @example
|
|
5940
|
+
* ```typescript
|
|
5941
|
+
* import { TimeInterval } from '@uipath/uipath-typescript/cases';
|
|
5942
|
+
*
|
|
5943
|
+
* // Get weekly breakdown
|
|
5944
|
+
* const statuses = await cases.getInstanceStatusTimeline(startTime, endTime, {
|
|
5945
|
+
* groupBy: TimeInterval.Week,
|
|
5946
|
+
* });
|
|
5947
|
+
* ```
|
|
5948
|
+
*
|
|
5949
|
+
* @example
|
|
5950
|
+
* ```typescript
|
|
5951
|
+
* // Get all-time data (from Unix epoch to now)
|
|
5952
|
+
* const allTime = await cases.getInstanceStatusTimeline(new Date(0), new Date());
|
|
5953
|
+
* ```
|
|
5954
|
+
*/
|
|
5955
|
+
getInstanceStatusTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<InstanceStatusTimelineResponse[]>;
|
|
5956
|
+
/**
|
|
5957
|
+
* Get the top 10 case processes ranked by failure count within a time range.
|
|
5958
|
+
*
|
|
5959
|
+
* Returns an array of up to 10 case processes sorted by how many instances faulted,
|
|
5960
|
+
* useful for identifying the most error-prone case processes in a given period.
|
|
5961
|
+
*
|
|
5962
|
+
* @param startTime - Start of the time range to query
|
|
5963
|
+
* @param endTime - End of the time range to query
|
|
5964
|
+
* @param options - Optional filters (packageId, processKey, version)
|
|
5965
|
+
* @returns Promise resolving to an array of {@link CaseGetTopFaultedCountResponse}
|
|
5966
|
+
* @example
|
|
5967
|
+
* ```typescript
|
|
5968
|
+
* import { Cases } from '@uipath/uipath-typescript/cases';
|
|
5969
|
+
*
|
|
5970
|
+
* const cases = new Cases(sdk);
|
|
5971
|
+
*
|
|
5972
|
+
* // Get top case processes by faulted count for the last 7 days
|
|
5973
|
+
* const topFailing = await cases.getTopFaultedCount(
|
|
5974
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
5975
|
+
* new Date()
|
|
5976
|
+
* );
|
|
5977
|
+
*
|
|
5978
|
+
* for (const process of topFailing) {
|
|
5979
|
+
* console.log(`${process.packageId}: ${process.faultedCount} failures`);
|
|
5980
|
+
* }
|
|
5981
|
+
* ```
|
|
5982
|
+
*
|
|
5983
|
+
* @example
|
|
5984
|
+
* ```typescript
|
|
5985
|
+
* // Get top case processes by faulted count for a specific package
|
|
5986
|
+
* const filtered = await cases.getTopFaultedCount(
|
|
5987
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
5988
|
+
* new Date(),
|
|
5989
|
+
* { packageId: '<packageId>' }
|
|
5990
|
+
* );
|
|
5991
|
+
* ```
|
|
5992
|
+
*/
|
|
5993
|
+
getTopFaultedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopFaultedCountResponse[]>;
|
|
5994
|
+
/**
|
|
5995
|
+
* Get the top 5 case processes ranked by total duration within a time range.
|
|
5996
|
+
*
|
|
5997
|
+
* Returns an array of up to 5 case processes sorted by their total execution time,
|
|
5998
|
+
* useful for identifying the longest-running case processes in a given period.
|
|
5999
|
+
*
|
|
6000
|
+
* @param startTime - Start of the time range to query
|
|
6001
|
+
* @param endTime - End of the time range to query
|
|
6002
|
+
* @param options - Optional filters (packageId, processKey, version)
|
|
6003
|
+
* @returns Promise resolving to an array of {@link CaseGetTopDurationResponse}
|
|
6004
|
+
* @example
|
|
6005
|
+
* ```typescript
|
|
6006
|
+
* import { Cases } from '@uipath/uipath-typescript/cases';
|
|
6007
|
+
*
|
|
6008
|
+
* const cases = new Cases(sdk);
|
|
6009
|
+
*
|
|
6010
|
+
* // Get top case processes by duration for the last 7 days
|
|
6011
|
+
* const topProcesses = await cases.getTopExecutionDuration(
|
|
6012
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
6013
|
+
* new Date()
|
|
6014
|
+
* );
|
|
6015
|
+
*
|
|
6016
|
+
* for (const process of topProcesses) {
|
|
6017
|
+
* console.log(`${process.packageId}: ${process.duration}ms total`);
|
|
6018
|
+
* }
|
|
6019
|
+
* ```
|
|
6020
|
+
*
|
|
6021
|
+
* @example
|
|
6022
|
+
* ```typescript
|
|
6023
|
+
* // Get top case processes by duration for a specific package
|
|
6024
|
+
* const filtered = await cases.getTopExecutionDuration(
|
|
6025
|
+
* new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
|
|
6026
|
+
* new Date(),
|
|
6027
|
+
* { packageId: '<packageId>' }
|
|
6028
|
+
* );
|
|
6029
|
+
* ```
|
|
6030
|
+
*/
|
|
6031
|
+
getTopExecutionDuration(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopDurationResponse[]>;
|
|
4891
6032
|
/**
|
|
4892
6033
|
* Extract a readable case name from the packageId
|
|
4893
6034
|
* @param packageId - The full package identifier
|
|
@@ -5114,6 +6255,35 @@ declare class CaseInstancesService extends BaseService implements CaseInstancesS
|
|
|
5114
6255
|
* ```
|
|
5115
6256
|
*/
|
|
5116
6257
|
getSlaSummary<T extends CaseInstanceSlaSummaryOptions = CaseInstanceSlaSummaryOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<SlaSummaryResponse> : NonPaginatedResponse<SlaSummaryResponse>>;
|
|
6258
|
+
/**
|
|
6259
|
+
* Get stages SLA summary for case instances across folders.
|
|
6260
|
+
*
|
|
6261
|
+
* Returns stage-level SLA status and escalation information for each case instance, aggregated from Insights Real-Time Monitoring.
|
|
6262
|
+
*
|
|
6263
|
+
* @param options - Optional filtering options
|
|
6264
|
+
* @returns Promise resolving to an array of {@link CaseInstanceStageSLAResponse}
|
|
6265
|
+
* @example
|
|
6266
|
+
* ```typescript
|
|
6267
|
+
* // Get stages SLA summary for all case instances
|
|
6268
|
+
* const stagesSla = await caseInstances.getStagesSlaSummary();
|
|
6269
|
+
* for (const item of stagesSla) {
|
|
6270
|
+
* console.log(`Instance: ${item.caseInstanceId}`);
|
|
6271
|
+
* for (const stage of item.stages) {
|
|
6272
|
+
* console.log(` Stage: ${stage.name} - SLA Status: ${stage.slaStatus}, Due: ${stage.slaDueTime}`);
|
|
6273
|
+
* }
|
|
6274
|
+
* }
|
|
6275
|
+
*
|
|
6276
|
+
* // Filter by case instance ID
|
|
6277
|
+
* const filtered = await caseInstances.getStagesSlaSummary({
|
|
6278
|
+
* caseInstanceId: '<caseInstanceId>'
|
|
6279
|
+
* });
|
|
6280
|
+
*
|
|
6281
|
+
* // Using bound method on a case instance
|
|
6282
|
+
* const instance = await caseInstances.getById('<instanceId>', '<folderKey>');
|
|
6283
|
+
* const stagesSla = await instance.getStagesSlaSummary();
|
|
6284
|
+
* ```
|
|
6285
|
+
*/
|
|
6286
|
+
getStagesSlaSummary(options?: CaseInstanceStageSLAOptions): Promise<CaseInstanceStageSLAResponse[]>;
|
|
5117
6287
|
}
|
|
5118
6288
|
|
|
5119
6289
|
/**
|
|
@@ -5428,6 +6598,11 @@ type BucketGetAllOptions = RequestOptions & PaginationOptions & {
|
|
|
5428
6598
|
};
|
|
5429
6599
|
interface BucketGetByIdOptions extends BaseOptions {
|
|
5430
6600
|
}
|
|
6601
|
+
/**
|
|
6602
|
+
* Options for getting a single bucket by name
|
|
6603
|
+
*/
|
|
6604
|
+
interface BucketGetByNameOptions extends FolderScopedOptions {
|
|
6605
|
+
}
|
|
5431
6606
|
/**
|
|
5432
6607
|
* Maps header names to their values
|
|
5433
6608
|
*
|
|
@@ -5518,17 +6693,56 @@ interface BlobItem {
|
|
|
5518
6693
|
*/
|
|
5519
6694
|
path: string;
|
|
5520
6695
|
/**
|
|
5521
|
-
* Content type of the blob
|
|
6696
|
+
* Content type of the blob
|
|
6697
|
+
*/
|
|
6698
|
+
contentType: string;
|
|
6699
|
+
/**
|
|
6700
|
+
* Size of the blob in bytes
|
|
6701
|
+
*/
|
|
6702
|
+
size: number;
|
|
6703
|
+
/**
|
|
6704
|
+
* Last modified timestamp
|
|
6705
|
+
*/
|
|
6706
|
+
lastModified: string | null;
|
|
6707
|
+
}
|
|
6708
|
+
/**
|
|
6709
|
+
* Represents a file or directory entry in a bucket
|
|
6710
|
+
*/
|
|
6711
|
+
interface BucketFile {
|
|
6712
|
+
/**
|
|
6713
|
+
* Full path to the file or directory
|
|
6714
|
+
*/
|
|
6715
|
+
path: string;
|
|
6716
|
+
/**
|
|
6717
|
+
* Content type of the file (empty for directories)
|
|
6718
|
+
*/
|
|
6719
|
+
contentType: string;
|
|
6720
|
+
/**
|
|
6721
|
+
* Size of the file in bytes
|
|
6722
|
+
*/
|
|
6723
|
+
size: number;
|
|
6724
|
+
/**
|
|
6725
|
+
* Whether the entry is a directory
|
|
5522
6726
|
*/
|
|
5523
|
-
|
|
6727
|
+
isDirectory: boolean;
|
|
5524
6728
|
/**
|
|
5525
|
-
*
|
|
6729
|
+
* Identifier of the file, when available
|
|
5526
6730
|
*/
|
|
5527
|
-
|
|
6731
|
+
id: string | null;
|
|
6732
|
+
}
|
|
6733
|
+
/**
|
|
6734
|
+
* Options for listing files in a bucket directory
|
|
6735
|
+
*/
|
|
6736
|
+
type BucketGetFilesOptions = RequestOptions & PaginationOptions & FolderScopedOptions & {
|
|
5528
6737
|
/**
|
|
5529
|
-
*
|
|
6738
|
+
* Regex pattern to filter file names (e.g., '.*\\.pdf$')
|
|
5530
6739
|
*/
|
|
5531
|
-
|
|
6740
|
+
fileNameRegex?: string;
|
|
6741
|
+
};
|
|
6742
|
+
/**
|
|
6743
|
+
* Options for deleting a file from a bucket
|
|
6744
|
+
*/
|
|
6745
|
+
interface BucketDeleteFileOptions extends FolderScopedOptions {
|
|
5532
6746
|
}
|
|
5533
6747
|
/**
|
|
5534
6748
|
* Options for uploading files to a bucket
|
|
@@ -5638,6 +6852,26 @@ interface BucketServiceModel {
|
|
|
5638
6852
|
* ```
|
|
5639
6853
|
*/
|
|
5640
6854
|
getById(bucketId: number, folderId: number, options?: BucketGetByIdOptions): Promise<BucketGetResponse>;
|
|
6855
|
+
/**
|
|
6856
|
+
* Retrieves a single orchestrator storage bucket by name.
|
|
6857
|
+
*
|
|
6858
|
+
* @param name - Bucket name to search for
|
|
6859
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
|
|
6860
|
+
* @returns Promise resolving to a single bucket
|
|
6861
|
+
* {@link BucketGetResponse}
|
|
6862
|
+
* @example
|
|
6863
|
+
* ```typescript
|
|
6864
|
+
* // By folder ID
|
|
6865
|
+
* await buckets.getByName('MyBucket', { folderId: <folderId> });
|
|
6866
|
+
*
|
|
6867
|
+
* // By folder key (GUID)
|
|
6868
|
+
* await buckets.getByName('MyBucket', { folderKey: '<folderKey>' });
|
|
6869
|
+
*
|
|
6870
|
+
* // By folder path
|
|
6871
|
+
* await buckets.getByName('MyBucket', { folderPath: '<folderPath>' });
|
|
6872
|
+
* ```
|
|
6873
|
+
*/
|
|
6874
|
+
getByName(name: string, options?: BucketGetByNameOptions): Promise<BucketGetResponse>;
|
|
5641
6875
|
/**
|
|
5642
6876
|
* Gets metadata for files in a bucket with optional filtering and pagination
|
|
5643
6877
|
*
|
|
@@ -5715,6 +6949,64 @@ interface BucketServiceModel {
|
|
|
5715
6949
|
* ```
|
|
5716
6950
|
*/
|
|
5717
6951
|
uploadFile(options: BucketUploadFileOptions): Promise<BucketUploadResponse>;
|
|
6952
|
+
/**
|
|
6953
|
+
* Deletes a file from a bucket
|
|
6954
|
+
*
|
|
6955
|
+
* @param bucketId - The ID of the bucket
|
|
6956
|
+
* @param path - The full path to the file to delete
|
|
6957
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`)
|
|
6958
|
+
* @returns Promise resolving when the file is deleted
|
|
6959
|
+
* @example
|
|
6960
|
+
* ```typescript
|
|
6961
|
+
* // Delete a file from a bucket
|
|
6962
|
+
* await buckets.deleteFile(<bucketId>, '/folder/file.pdf', { folderId: <folderId> });
|
|
6963
|
+
* ```
|
|
6964
|
+
*/
|
|
6965
|
+
deleteFile(bucketId: number, path: string, options?: BucketDeleteFileOptions): Promise<void>;
|
|
6966
|
+
/**
|
|
6967
|
+
* Lists all files in a bucket.
|
|
6968
|
+
*
|
|
6969
|
+
* Returns a flat, recursive listing of all files in the bucket. Supports regex filtering
|
|
6970
|
+
* and filter / orderby / select / expand. {@link BucketFile} entries include
|
|
6971
|
+
* `isDirectory` so callers can distinguish folders from files.
|
|
6972
|
+
*
|
|
6973
|
+
* The method returns either:
|
|
6974
|
+
* - A NonPaginatedResponse with items array (when no pagination parameters are provided)
|
|
6975
|
+
* - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
|
|
6976
|
+
*
|
|
6977
|
+
* @param bucketId - The ID of the bucket
|
|
6978
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional parameters for regex filtering, query options, and pagination
|
|
6979
|
+
* {@link BucketGetFilesOptions}
|
|
6980
|
+
* @returns Promise resolving to either an array of files NonPaginatedResponse<BucketFile> or a PaginatedResponse<BucketFile> when pagination options are used.
|
|
6981
|
+
* {@link BucketFile}
|
|
6982
|
+
* @example
|
|
6983
|
+
* ```typescript
|
|
6984
|
+
* // List all files in the bucket
|
|
6985
|
+
* const files = await buckets.getFiles(<bucketId>, { folderId: <folderId> });
|
|
6986
|
+
*
|
|
6987
|
+
* // Filter by regex pattern
|
|
6988
|
+
* const pdfs = await buckets.getFiles(<bucketId>, {
|
|
6989
|
+
* folderId: <folderId>,
|
|
6990
|
+
* fileNameRegex: '.*\\.pdf$'
|
|
6991
|
+
* });
|
|
6992
|
+
*
|
|
6993
|
+
* // First page with pagination
|
|
6994
|
+
* const page1 = await buckets.getFiles(<bucketId>, { folderId: <folderId>, pageSize: 10 });
|
|
6995
|
+
*
|
|
6996
|
+
* // Navigate using cursor
|
|
6997
|
+
* if (page1.hasNextPage) {
|
|
6998
|
+
* const page2 = await buckets.getFiles(<bucketId>, { folderId: <folderId>, cursor: page1.nextCursor });
|
|
6999
|
+
* }
|
|
7000
|
+
*
|
|
7001
|
+
* // Jump to specific page
|
|
7002
|
+
* const page5 = await buckets.getFiles(<bucketId>, {
|
|
7003
|
+
* folderId: <folderId>,
|
|
7004
|
+
* jumpToPage: 5,
|
|
7005
|
+
* pageSize: 10
|
|
7006
|
+
* });
|
|
7007
|
+
* ```
|
|
7008
|
+
*/
|
|
7009
|
+
getFiles<T extends BucketGetFilesOptions = BucketGetFilesOptions>(bucketId: number, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<BucketFile> : NonPaginatedResponse<BucketFile>>;
|
|
5718
7010
|
}
|
|
5719
7011
|
|
|
5720
7012
|
declare class BucketService extends FolderScopedService implements BucketServiceModel {
|
|
@@ -5736,6 +7028,30 @@ declare class BucketService extends FolderScopedService implements BucketService
|
|
|
5736
7028
|
* ```
|
|
5737
7029
|
*/
|
|
5738
7030
|
getById(id: number, folderId: number, options?: BucketGetByIdOptions): Promise<BucketGetResponse>;
|
|
7031
|
+
/**
|
|
7032
|
+
* Retrieves a single orchestrator storage bucket by name.
|
|
7033
|
+
*
|
|
7034
|
+
* @param name - Bucket name to search for
|
|
7035
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
|
|
7036
|
+
* @returns Promise resolving to a single bucket
|
|
7037
|
+
* {@link BucketGetResponse}
|
|
7038
|
+
* @example
|
|
7039
|
+
* ```typescript
|
|
7040
|
+
* import { Buckets } from '@uipath/uipath-typescript/buckets';
|
|
7041
|
+
*
|
|
7042
|
+
* const buckets = new Buckets(sdk);
|
|
7043
|
+
*
|
|
7044
|
+
* // By folder ID
|
|
7045
|
+
* await buckets.getByName('MyBucket', { folderId: <folderId> });
|
|
7046
|
+
*
|
|
7047
|
+
* // By folder key (GUID)
|
|
7048
|
+
* await buckets.getByName('MyBucket', { folderKey: '<folderKey>' });
|
|
7049
|
+
*
|
|
7050
|
+
* // By folder path
|
|
7051
|
+
* await buckets.getByName('MyBucket', { folderPath: '<folderPath>' });
|
|
7052
|
+
* ```
|
|
7053
|
+
*/
|
|
7054
|
+
getByName(name: string, options?: BucketGetByNameOptions): Promise<BucketGetResponse>;
|
|
5739
7055
|
/**
|
|
5740
7056
|
* Gets all buckets across folders with optional filtering and folder scoping
|
|
5741
7057
|
*
|
|
@@ -5887,6 +7203,72 @@ declare class BucketService extends FolderScopedService implements BucketService
|
|
|
5887
7203
|
* @returns Promise resolving to blob file access information
|
|
5888
7204
|
*/
|
|
5889
7205
|
private _getUri;
|
|
7206
|
+
/**
|
|
7207
|
+
* Lists all files in a bucket.
|
|
7208
|
+
*
|
|
7209
|
+
* Returns a flat, recursive listing of all files in the bucket. Supports regex filtering
|
|
7210
|
+
* and filter / orderby / select / expand. {@link BucketFile} entries include
|
|
7211
|
+
* `isDirectory` so callers can distinguish folders from files.
|
|
7212
|
+
*
|
|
7213
|
+
* The method returns either:
|
|
7214
|
+
* - A NonPaginatedResponse with items array (when no pagination parameters are provided)
|
|
7215
|
+
* - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
|
|
7216
|
+
*
|
|
7217
|
+
* @param bucketId - The ID of the bucket
|
|
7218
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional parameters for regex filtering, query options, and pagination
|
|
7219
|
+
* @returns Promise resolving to either an array of files NonPaginatedResponse<BucketFile> or a PaginatedResponse<BucketFile> when pagination options are used.
|
|
7220
|
+
*
|
|
7221
|
+
* @example
|
|
7222
|
+
* ```typescript
|
|
7223
|
+
* import { Buckets } from '@uipath/uipath-typescript/buckets';
|
|
7224
|
+
*
|
|
7225
|
+
* const buckets = new Buckets(sdk);
|
|
7226
|
+
*
|
|
7227
|
+
* // List all files in the bucket
|
|
7228
|
+
* const files = await buckets.getFiles(<bucketId>, { folderId: <folderId> });
|
|
7229
|
+
*
|
|
7230
|
+
* // Filter by regex pattern
|
|
7231
|
+
* const pdfs = await buckets.getFiles(<bucketId>, {
|
|
7232
|
+
* folderId: <folderId>,
|
|
7233
|
+
* fileNameRegex: '.*\\.pdf$'
|
|
7234
|
+
* });
|
|
7235
|
+
*
|
|
7236
|
+
* // First page with pagination
|
|
7237
|
+
* const page1 = await buckets.getFiles(<bucketId>, { folderId: <folderId>, pageSize: 10 });
|
|
7238
|
+
*
|
|
7239
|
+
* // Navigate using cursor
|
|
7240
|
+
* if (page1.hasNextPage) {
|
|
7241
|
+
* const page2 = await buckets.getFiles(<bucketId>, { folderId: <folderId>, cursor: page1.nextCursor });
|
|
7242
|
+
* }
|
|
7243
|
+
*
|
|
7244
|
+
* // Jump to specific page
|
|
7245
|
+
* const page5 = await buckets.getFiles(<bucketId>, {
|
|
7246
|
+
* folderId: <folderId>,
|
|
7247
|
+
* jumpToPage: 5,
|
|
7248
|
+
* pageSize: 10
|
|
7249
|
+
* });
|
|
7250
|
+
* ```
|
|
7251
|
+
*/
|
|
7252
|
+
getFiles<T extends BucketGetFilesOptions = BucketGetFilesOptions>(bucketId: number, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<BucketFile> : NonPaginatedResponse<BucketFile>>;
|
|
7253
|
+
/**
|
|
7254
|
+
* Deletes a file from a bucket
|
|
7255
|
+
*
|
|
7256
|
+
* @param bucketId - The ID of the bucket
|
|
7257
|
+
* @param path - The full path to the file to delete
|
|
7258
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`)
|
|
7259
|
+
* @returns Promise resolving when the file is deleted
|
|
7260
|
+
*
|
|
7261
|
+
* @example
|
|
7262
|
+
* ```typescript
|
|
7263
|
+
* import { Buckets } from '@uipath/uipath-typescript/buckets';
|
|
7264
|
+
*
|
|
7265
|
+
* const buckets = new Buckets(sdk);
|
|
7266
|
+
*
|
|
7267
|
+
* // Delete a file from a bucket
|
|
7268
|
+
* await buckets.deleteFile(<bucketId>, '/folder/file.pdf', { folderId: <folderId> });
|
|
7269
|
+
* ```
|
|
7270
|
+
*/
|
|
7271
|
+
deleteFile(bucketId: number, path: string, options?: BucketDeleteFileOptions): Promise<void>;
|
|
5890
7272
|
/**
|
|
5891
7273
|
* Gets a direct upload URL for a file in the bucket
|
|
5892
7274
|
*
|
|
@@ -6255,6 +7637,17 @@ interface ProcessGetByIdOptions extends BaseOptions {
|
|
|
6255
7637
|
*/
|
|
6256
7638
|
interface ProcessGetByNameOptions extends FolderScopedOptions {
|
|
6257
7639
|
}
|
|
7640
|
+
/**
|
|
7641
|
+
* Options for starting a process. Combines folder scoping
|
|
7642
|
+
* (`folderId` / `folderKey` / `folderPath`) with the OData query options
|
|
7643
|
+
* (`expand`, `select`, `filter`, `orderby`) accepted by the start endpoint.
|
|
7644
|
+
*
|
|
7645
|
+
* Folder scoping is optional in the type — the SDK falls back to the
|
|
7646
|
+
* init-time folderKey (e.g. `<meta name="uipath:folder-key">` in coded-app
|
|
7647
|
+
* deployments). A `ValidationError` is raised when neither is provided.
|
|
7648
|
+
*/
|
|
7649
|
+
interface ProcessStartOptions extends FolderScopedOptions, RequestOptions {
|
|
7650
|
+
}
|
|
6258
7651
|
|
|
6259
7652
|
/**
|
|
6260
7653
|
* Enum for job sub-state
|
|
@@ -6791,26 +8184,45 @@ interface ProcessServiceModel {
|
|
|
6791
8184
|
*/
|
|
6792
8185
|
getByName(name: string, options?: ProcessGetByNameOptions): Promise<ProcessGetResponse>;
|
|
6793
8186
|
/**
|
|
6794
|
-
* Starts a process with the specified configuration
|
|
8187
|
+
* Starts a process with the specified configuration.
|
|
8188
|
+
*
|
|
8189
|
+
* Folder context can be supplied as `folderId`, `folderKey`, or `folderPath`
|
|
8190
|
+
* inside the options.
|
|
6795
8191
|
*
|
|
6796
8192
|
* @param request - Process start configuration
|
|
6797
|
-
* @param
|
|
6798
|
-
* @param options - Optional request options
|
|
8193
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`, `filter`, `orderby`)
|
|
6799
8194
|
* @returns Promise resolving to array of started process instances
|
|
6800
8195
|
* {@link ProcessStartResponse}
|
|
6801
8196
|
* @example
|
|
6802
8197
|
* ```typescript
|
|
6803
|
-
* //
|
|
6804
|
-
*
|
|
6805
|
-
* processKey: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
6806
|
-
* }, <folderId>); // folderId is required
|
|
8198
|
+
* // By folder ID
|
|
8199
|
+
* await processes.start({ processKey: '<processKey>' }, { folderId: <folderId> });
|
|
6807
8200
|
*
|
|
6808
|
-
* //
|
|
6809
|
-
*
|
|
6810
|
-
*
|
|
6811
|
-
*
|
|
8201
|
+
* // By folder key (GUID)
|
|
8202
|
+
* await processes.start({ processKey: '<processKey>' }, { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
|
|
8203
|
+
*
|
|
8204
|
+
* // By folder path
|
|
8205
|
+
* await processes.start({ processKey: '<processKey>' }, { folderPath: 'Shared/Finance' });
|
|
8206
|
+
*
|
|
8207
|
+
* // Start by process name (instead of processKey)
|
|
8208
|
+
* await processes.start({ processName: 'MyProcess' }, { folderId: <folderId> });
|
|
8209
|
+
*
|
|
8210
|
+
* // With additional options
|
|
8211
|
+
* await processes.start({ processKey: '<processKey>' }, { folderId: <folderId>, expand: 'Robot' });
|
|
6812
8212
|
* ```
|
|
6813
8213
|
*/
|
|
8214
|
+
start(request: ProcessStartRequest, options?: ProcessStartOptions): Promise<ProcessStartResponse[]>;
|
|
8215
|
+
/**
|
|
8216
|
+
* Starts a process — positional `folderId` form.
|
|
8217
|
+
*
|
|
8218
|
+
* @deprecated Use the options-object form: `start(request, { folderId })`. See {@link ProcessStartOptions} for the supported options.
|
|
8219
|
+
*
|
|
8220
|
+
* @param request - Process start configuration
|
|
8221
|
+
* @param folderId - Required folder ID (numeric)
|
|
8222
|
+
* @param options - Optional request options
|
|
8223
|
+
* @returns Promise resolving to array of started process instances
|
|
8224
|
+
* {@link ProcessStartResponse}
|
|
8225
|
+
*/
|
|
6814
8226
|
start(request: ProcessStartRequest, folderId: number, options?: RequestOptions): Promise<ProcessStartResponse[]>;
|
|
6815
8227
|
}
|
|
6816
8228
|
|
|
@@ -6864,12 +8276,15 @@ declare class ProcessService extends FolderScopedService implements ProcessServi
|
|
|
6864
8276
|
*/
|
|
6865
8277
|
getAll<T extends ProcessGetAllOptions = ProcessGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ProcessGetResponse> : NonPaginatedResponse<ProcessGetResponse>>;
|
|
6866
8278
|
/**
|
|
6867
|
-
* Starts a process
|
|
8279
|
+
* Starts a process with the specified configuration.
|
|
6868
8280
|
*
|
|
6869
|
-
*
|
|
6870
|
-
*
|
|
6871
|
-
*
|
|
6872
|
-
* @
|
|
8281
|
+
* Folder context can be supplied as `folderId`, `folderKey`, or `folderPath`
|
|
8282
|
+
* inside the options.
|
|
8283
|
+
*
|
|
8284
|
+
* @param request - Process start configuration
|
|
8285
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`, `filter`, `orderby`)
|
|
8286
|
+
* @returns Promise resolving to array of started process instances
|
|
8287
|
+
* {@link ProcessStartResponse}
|
|
6873
8288
|
*
|
|
6874
8289
|
* @example
|
|
6875
8290
|
* ```typescript
|
|
@@ -6877,17 +8292,34 @@ declare class ProcessService extends FolderScopedService implements ProcessServi
|
|
|
6877
8292
|
*
|
|
6878
8293
|
* const processes = new Processes(sdk);
|
|
6879
8294
|
*
|
|
6880
|
-
* //
|
|
6881
|
-
*
|
|
6882
|
-
* processKey: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
6883
|
-
* }, 123); // folderId is required
|
|
8295
|
+
* // By folder ID
|
|
8296
|
+
* await processes.start({ processKey: '<processKey>' }, { folderId: <folderId> });
|
|
6884
8297
|
*
|
|
6885
|
-
* //
|
|
6886
|
-
*
|
|
6887
|
-
*
|
|
6888
|
-
*
|
|
8298
|
+
* // By folder key (GUID)
|
|
8299
|
+
* await processes.start({ processKey: '<processKey>' }, { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
|
|
8300
|
+
*
|
|
8301
|
+
* // By folder path
|
|
8302
|
+
* await processes.start({ processKey: '<processKey>' }, { folderPath: 'Shared/Finance' });
|
|
8303
|
+
*
|
|
8304
|
+
* // Start by process name (instead of processKey)
|
|
8305
|
+
* await processes.start({ processName: 'MyProcess' }, { folderId: <folderId> });
|
|
8306
|
+
*
|
|
8307
|
+
* // With additional options
|
|
8308
|
+
* await processes.start({ processKey: '<processKey>' }, { folderId: <folderId>, expand: 'Robot' });
|
|
6889
8309
|
* ```
|
|
6890
8310
|
*/
|
|
8311
|
+
start(request: ProcessStartRequest, options?: ProcessStartOptions): Promise<ProcessStartResponse[]>;
|
|
8312
|
+
/**
|
|
8313
|
+
* Starts a process — positional `folderId` form.
|
|
8314
|
+
*
|
|
8315
|
+
* @deprecated Use the options-object form: `start(request, { folderId })`. See {@link ProcessStartOptions} for the supported options.
|
|
8316
|
+
*
|
|
8317
|
+
* @param request - Process start configuration
|
|
8318
|
+
* @param folderId - Required folder ID (numeric)
|
|
8319
|
+
* @param options - Optional request options
|
|
8320
|
+
* @returns Promise resolving to array of started process instances
|
|
8321
|
+
* {@link ProcessStartResponse}
|
|
8322
|
+
*/
|
|
6891
8323
|
start(request: ProcessStartRequest, folderId: number, options?: RequestOptions): Promise<ProcessStartResponse[]>;
|
|
6892
8324
|
/**
|
|
6893
8325
|
* Gets a single process by ID
|
|
@@ -7591,6 +9023,15 @@ declare function loadFromMetaTags(): MetaTagConfig | null;
|
|
|
7591
9023
|
declare const ConversationMap: {
|
|
7592
9024
|
[key: string]: string;
|
|
7593
9025
|
};
|
|
9026
|
+
/**
|
|
9027
|
+
* Maps API filter param names (left) to SDK-facing names (right) for the conversation list endpoint.
|
|
9028
|
+
* Used by `getAll` to translate SDK filters to the field names the backend expects. Kept separate
|
|
9029
|
+
* from `ConversationMap` because `label`/`search` would otherwise collide with the `label` field
|
|
9030
|
+
* on create/update payloads.
|
|
9031
|
+
*/
|
|
9032
|
+
declare const ConversationGetAllFilterMap: {
|
|
9033
|
+
[key: string]: string;
|
|
9034
|
+
};
|
|
7594
9035
|
/**
|
|
7595
9036
|
* Maps fields for Exchange entity to ensure consistent SDK naming
|
|
7596
9037
|
*/
|
|
@@ -11179,8 +12620,12 @@ interface ConversationServiceModel {
|
|
|
11179
12620
|
/**
|
|
11180
12621
|
* Gets all conversations with optional filtering and pagination
|
|
11181
12622
|
*
|
|
12623
|
+
* The method returns either:
|
|
12624
|
+
* - A NonPaginatedResponse with items array (when no pagination parameters are provided)
|
|
12625
|
+
* - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
|
|
12626
|
+
*
|
|
11182
12627
|
* @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
|
|
12628
|
+
* @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
12629
|
*
|
|
11185
12630
|
* @example Basic usage - get all conversations
|
|
11186
12631
|
* ```typescript
|
|
@@ -11211,6 +12656,14 @@ interface ConversationServiceModel {
|
|
|
11211
12656
|
* pageSize: 20
|
|
11212
12657
|
* });
|
|
11213
12658
|
* ```
|
|
12659
|
+
*
|
|
12660
|
+
* @example Filter by agent and search by label
|
|
12661
|
+
* ```typescript
|
|
12662
|
+
* const filtered = await conversationalAgent.conversations.getAll({
|
|
12663
|
+
* agentId: <agentId>,
|
|
12664
|
+
* label: 'budget'
|
|
12665
|
+
* });
|
|
12666
|
+
* ```
|
|
11214
12667
|
*/
|
|
11215
12668
|
getAll<T extends ConversationGetAllOptions = ConversationGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ConversationGetResponse> : NonPaginatedResponse<ConversationGetResponse>>;
|
|
11216
12669
|
/**
|
|
@@ -11603,6 +13056,14 @@ interface ConversationUpdateOptions {
|
|
|
11603
13056
|
type ConversationGetAllOptions = PaginationOptions & {
|
|
11604
13057
|
/** Sort order for conversations */
|
|
11605
13058
|
sort?: SortOrder;
|
|
13059
|
+
/** GUID key of the agent to filter conversations by. */
|
|
13060
|
+
agentKey?: string;
|
|
13061
|
+
/** Numeric ID of the agent to filter conversations by. */
|
|
13062
|
+
agentId?: number;
|
|
13063
|
+
/**
|
|
13064
|
+
* Case-insensitive substring filter applied to conversation labels (1–100 chars).
|
|
13065
|
+
*/
|
|
13066
|
+
label?: string;
|
|
11606
13067
|
};
|
|
11607
13068
|
/**
|
|
11608
13069
|
* File upload access details for uploading file content to blob storage
|
|
@@ -11748,8 +13209,10 @@ interface RawAgentGetResponse {
|
|
|
11748
13209
|
description: string;
|
|
11749
13210
|
/** Process version */
|
|
11750
13211
|
processVersion: string;
|
|
11751
|
-
/** Process key identifier */
|
|
13212
|
+
/** Process key identifier (a dotted-path string like `Solution.Package.Agent`) */
|
|
11752
13213
|
processKey: string;
|
|
13214
|
+
/** GUID key of the agent release */
|
|
13215
|
+
releaseKey?: string;
|
|
11753
13216
|
/** Folder ID */
|
|
11754
13217
|
folderId: number;
|
|
11755
13218
|
/** Feed ID */
|
|
@@ -12624,8 +14087,8 @@ declare enum DocumentActionType {
|
|
|
12624
14087
|
Classification = "Classification"
|
|
12625
14088
|
}
|
|
12626
14089
|
interface UserData {
|
|
12627
|
-
|
|
12628
|
-
|
|
14090
|
+
Id?: number | null;
|
|
14091
|
+
EmailAddress?: string | null;
|
|
12629
14092
|
}
|
|
12630
14093
|
|
|
12631
14094
|
declare enum ComparisonOperator {
|
|
@@ -12674,103 +14137,96 @@ declare enum RuleType {
|
|
|
12674
14137
|
IsEmpty = "IsEmpty"
|
|
12675
14138
|
}
|
|
12676
14139
|
interface DataSource {
|
|
12677
|
-
|
|
12678
|
-
|
|
14140
|
+
ResourceId?: string | null;
|
|
14141
|
+
ElementFieldId?: string | null;
|
|
12679
14142
|
}
|
|
12680
14143
|
interface DocumentGroup {
|
|
12681
|
-
|
|
12682
|
-
|
|
14144
|
+
Name?: string | null;
|
|
14145
|
+
Categories?: string[] | null;
|
|
12683
14146
|
}
|
|
12684
14147
|
interface DocumentTaxonomy {
|
|
12685
|
-
|
|
12686
|
-
|
|
12687
|
-
|
|
12688
|
-
|
|
12689
|
-
|
|
14148
|
+
DataContractVersion?: string | null;
|
|
14149
|
+
DocumentTypes?: DocumentTypeEntity[] | null;
|
|
14150
|
+
Groups?: DocumentGroup[] | null;
|
|
14151
|
+
SupportedLanguages?: LanguageInfo[] | null;
|
|
14152
|
+
ReportAsExceptionSettings?: ReportAsExceptionSettings;
|
|
12690
14153
|
}
|
|
12691
14154
|
interface DocumentTypeEntity {
|
|
12692
|
-
|
|
12693
|
-
|
|
12694
|
-
|
|
12695
|
-
|
|
12696
|
-
|
|
12697
|
-
|
|
12698
|
-
|
|
12699
|
-
|
|
14155
|
+
DocumentTypeId?: string | null;
|
|
14156
|
+
Group?: string | null;
|
|
14157
|
+
Category?: string | null;
|
|
14158
|
+
Name?: string | null;
|
|
14159
|
+
OptionalUniqueIdentifier?: string | null;
|
|
14160
|
+
TypeField?: TypeField;
|
|
14161
|
+
Fields?: Field[] | null;
|
|
14162
|
+
Metadata?: MetadataEntry[] | null;
|
|
12700
14163
|
}
|
|
12701
14164
|
interface ExceptionReasonOption {
|
|
12702
|
-
|
|
14165
|
+
ExceptionReason?: string | null;
|
|
12703
14166
|
}
|
|
12704
14167
|
interface Field {
|
|
12705
|
-
|
|
12706
|
-
|
|
12707
|
-
|
|
12708
|
-
|
|
12709
|
-
|
|
12710
|
-
|
|
12711
|
-
|
|
12712
|
-
|
|
12713
|
-
|
|
12714
|
-
|
|
12715
|
-
|
|
14168
|
+
FieldId?: string | null;
|
|
14169
|
+
FieldName?: string | null;
|
|
14170
|
+
IsMultiValue?: boolean;
|
|
14171
|
+
Type?: FieldType;
|
|
14172
|
+
DeriveFieldsFormat?: string | null;
|
|
14173
|
+
Components?: Field[] | null;
|
|
14174
|
+
SetValues?: string[] | null;
|
|
14175
|
+
Metadata?: MetadataEntry[] | null;
|
|
14176
|
+
RuleSet?: RuleSet;
|
|
14177
|
+
DefaultValue?: string | null;
|
|
14178
|
+
DataSource?: DataSource;
|
|
12716
14179
|
}
|
|
12717
14180
|
interface LanguageInfo {
|
|
12718
|
-
|
|
12719
|
-
|
|
14181
|
+
Name?: string | null;
|
|
14182
|
+
Code?: string | null;
|
|
12720
14183
|
}
|
|
12721
14184
|
interface MetadataEntry {
|
|
12722
|
-
|
|
12723
|
-
|
|
14185
|
+
Key?: string | null;
|
|
14186
|
+
Value?: string | null;
|
|
12724
14187
|
}
|
|
12725
14188
|
interface ReportAsExceptionSettings {
|
|
12726
|
-
|
|
14189
|
+
ExceptionReasonOptions?: ExceptionReasonOption[] | null;
|
|
12727
14190
|
}
|
|
12728
14191
|
interface Rule {
|
|
12729
|
-
|
|
12730
|
-
|
|
12731
|
-
|
|
12732
|
-
|
|
12733
|
-
|
|
12734
|
-
|
|
14192
|
+
Name?: string | null;
|
|
14193
|
+
Type?: RuleType;
|
|
14194
|
+
LogicalOperator?: LogicalOperator;
|
|
14195
|
+
ComparisonOperator?: ComparisonOperator;
|
|
14196
|
+
Expression?: string | null;
|
|
14197
|
+
SetValues?: string[] | null;
|
|
12735
14198
|
}
|
|
12736
14199
|
interface RuleSet {
|
|
12737
|
-
|
|
12738
|
-
|
|
14200
|
+
Criticality?: Criticality;
|
|
14201
|
+
Rules?: Rule[] | null;
|
|
12739
14202
|
}
|
|
12740
14203
|
interface TypeField {
|
|
12741
|
-
|
|
12742
|
-
|
|
14204
|
+
FieldId?: string | null;
|
|
14205
|
+
FieldName?: string | null;
|
|
12743
14206
|
}
|
|
12744
14207
|
|
|
12745
14208
|
interface FieldValue {
|
|
12746
|
-
|
|
12747
|
-
|
|
14209
|
+
Value?: string | null;
|
|
14210
|
+
DerivedValue?: string | null;
|
|
12748
14211
|
}
|
|
12749
14212
|
interface FieldValueResult {
|
|
12750
|
-
|
|
12751
|
-
|
|
12752
|
-
|
|
14213
|
+
Value?: FieldValue;
|
|
14214
|
+
IsValid?: boolean;
|
|
14215
|
+
Rules?: RuleResult[] | null;
|
|
12753
14216
|
}
|
|
12754
14217
|
interface RuleResult {
|
|
12755
|
-
|
|
12756
|
-
|
|
14218
|
+
Rule?: Rule;
|
|
14219
|
+
IsValid?: boolean;
|
|
12757
14220
|
}
|
|
12758
14221
|
interface RuleSetResult {
|
|
12759
|
-
|
|
12760
|
-
|
|
12761
|
-
|
|
12762
|
-
|
|
12763
|
-
|
|
12764
|
-
|
|
12765
|
-
|
|
12766
|
-
|
|
12767
|
-
}
|
|
12768
|
-
|
|
12769
|
-
interface ErrorResponse {
|
|
12770
|
-
message?: string | null;
|
|
12771
|
-
severity?: 'Info' | 'Warning' | 'Error';
|
|
12772
|
-
code?: string | null;
|
|
12773
|
-
parameters?: string[] | null;
|
|
14222
|
+
FieldId?: string | null;
|
|
14223
|
+
FieldType?: FieldType;
|
|
14224
|
+
Criticality?: Criticality;
|
|
14225
|
+
IsValid?: boolean;
|
|
14226
|
+
Results?: FieldValueResult[] | null;
|
|
14227
|
+
BrokenRules?: Rule[] | null;
|
|
14228
|
+
RowIndex?: number | null;
|
|
14229
|
+
TableFieldId?: string | null;
|
|
12774
14230
|
}
|
|
12775
14231
|
|
|
12776
14232
|
declare enum ClassifierDocumentTypeType {
|
|
@@ -12793,101 +14249,107 @@ declare enum GptFieldType {
|
|
|
12793
14249
|
Number = "Number",
|
|
12794
14250
|
Text = "Text"
|
|
12795
14251
|
}
|
|
14252
|
+
declare enum JobStatus {
|
|
14253
|
+
Succeeded = "Succeeded",
|
|
14254
|
+
Failed = "Failed",
|
|
14255
|
+
Running = "Running",
|
|
14256
|
+
NotStarted = "NotStarted"
|
|
14257
|
+
}
|
|
12796
14258
|
declare enum ValidationDisplayMode {
|
|
12797
14259
|
Classic = "Classic",
|
|
12798
14260
|
Compact = "Compact"
|
|
12799
14261
|
}
|
|
12800
14262
|
interface ClassificationPrompt {
|
|
12801
|
-
|
|
12802
|
-
|
|
14263
|
+
Name?: string | null;
|
|
14264
|
+
Description?: string | null;
|
|
12803
14265
|
}
|
|
12804
14266
|
interface ClassificationValidationConfiguration {
|
|
12805
|
-
|
|
14267
|
+
EnablePageReordering?: boolean;
|
|
12806
14268
|
}
|
|
12807
14269
|
interface ContentValidationData {
|
|
12808
|
-
|
|
12809
|
-
|
|
12810
|
-
|
|
12811
|
-
|
|
12812
|
-
|
|
12813
|
-
|
|
12814
|
-
|
|
12815
|
-
|
|
12816
|
-
|
|
12817
|
-
|
|
12818
|
-
|
|
12819
|
-
|
|
14270
|
+
BucketName?: string | null;
|
|
14271
|
+
BucketId?: number;
|
|
14272
|
+
FolderId?: number;
|
|
14273
|
+
FolderKey?: string;
|
|
14274
|
+
DocumentId?: string;
|
|
14275
|
+
EncodedDocumentPath?: string | null;
|
|
14276
|
+
TextPath?: string | null;
|
|
14277
|
+
DocumentObjectModelPath?: string | null;
|
|
14278
|
+
TaxonomyPath?: string | null;
|
|
14279
|
+
AutomaticExtractionResultsPath?: string | null;
|
|
14280
|
+
ValidatedExtractionResultsPath?: string | null;
|
|
14281
|
+
CustomizationInfoPath?: string | null;
|
|
12820
14282
|
}
|
|
12821
14283
|
interface DocumentClassificationActionDataModel {
|
|
12822
|
-
|
|
12823
|
-
|
|
12824
|
-
|
|
12825
|
-
|
|
12826
|
-
|
|
12827
|
-
|
|
12828
|
-
|
|
12829
|
-
|
|
12830
|
-
|
|
12831
|
-
|
|
12832
|
-
|
|
12833
|
-
|
|
12834
|
-
|
|
12835
|
-
|
|
12836
|
-
|
|
12837
|
-
|
|
12838
|
-
|
|
12839
|
-
|
|
12840
|
-
|
|
12841
|
-
|
|
12842
|
-
|
|
14284
|
+
Id?: number | null;
|
|
14285
|
+
Status?: DocumentActionStatus;
|
|
14286
|
+
Title?: string | null;
|
|
14287
|
+
Priority?: DocumentActionPriority;
|
|
14288
|
+
TaskCatalogName?: string | null;
|
|
14289
|
+
TaskUrl?: string | null;
|
|
14290
|
+
FolderPath?: string | null;
|
|
14291
|
+
FolderId?: number | null;
|
|
14292
|
+
Data?: unknown | null;
|
|
14293
|
+
Action?: string | null;
|
|
14294
|
+
IsDeleted?: boolean | null;
|
|
14295
|
+
AssignedToUser?: UserData;
|
|
14296
|
+
CreatorUser?: UserData;
|
|
14297
|
+
DeleterUser?: UserData;
|
|
14298
|
+
LastModifierUser?: UserData;
|
|
14299
|
+
CompletedByUser?: UserData;
|
|
14300
|
+
CreationTime?: string | null;
|
|
14301
|
+
LastAssignedTime?: string | null;
|
|
14302
|
+
CompletionTime?: string | null;
|
|
14303
|
+
ProcessingTime?: number | null;
|
|
14304
|
+
Type?: DocumentActionType;
|
|
12843
14305
|
}
|
|
12844
14306
|
interface DocumentExtractionActionDataModel {
|
|
12845
|
-
|
|
12846
|
-
|
|
12847
|
-
|
|
12848
|
-
|
|
12849
|
-
|
|
12850
|
-
|
|
12851
|
-
|
|
12852
|
-
|
|
12853
|
-
|
|
12854
|
-
|
|
12855
|
-
|
|
12856
|
-
|
|
12857
|
-
|
|
12858
|
-
|
|
12859
|
-
|
|
12860
|
-
|
|
12861
|
-
|
|
12862
|
-
|
|
12863
|
-
|
|
12864
|
-
|
|
12865
|
-
|
|
14307
|
+
Id?: number | null;
|
|
14308
|
+
Status?: DocumentActionStatus;
|
|
14309
|
+
Title?: string | null;
|
|
14310
|
+
Priority?: DocumentActionPriority;
|
|
14311
|
+
TaskCatalogName?: string | null;
|
|
14312
|
+
TaskUrl?: string | null;
|
|
14313
|
+
FolderPath?: string | null;
|
|
14314
|
+
FolderId?: number | null;
|
|
14315
|
+
Data?: unknown | null;
|
|
14316
|
+
Action?: string | null;
|
|
14317
|
+
IsDeleted?: boolean | null;
|
|
14318
|
+
AssignedToUser?: UserData;
|
|
14319
|
+
CreatorUser?: UserData;
|
|
14320
|
+
DeleterUser?: UserData;
|
|
14321
|
+
LastModifierUser?: UserData;
|
|
14322
|
+
CompletedByUser?: UserData;
|
|
14323
|
+
CreationTime?: string | null;
|
|
14324
|
+
LastAssignedTime?: string | null;
|
|
14325
|
+
CompletionTime?: string | null;
|
|
14326
|
+
ProcessingTime?: number | null;
|
|
14327
|
+
Type?: DocumentActionType;
|
|
12866
14328
|
}
|
|
12867
14329
|
interface ExtractionPrompt {
|
|
12868
|
-
|
|
12869
|
-
|
|
12870
|
-
|
|
12871
|
-
|
|
14330
|
+
Id?: string | null;
|
|
14331
|
+
Question?: string | null;
|
|
14332
|
+
FieldType?: GptFieldType;
|
|
14333
|
+
MultiValued?: boolean | null;
|
|
12872
14334
|
}
|
|
12873
14335
|
interface ExtractionValidationConfigurationV2 {
|
|
12874
|
-
|
|
12875
|
-
|
|
12876
|
-
|
|
12877
|
-
|
|
14336
|
+
EnableRtlControls?: boolean;
|
|
14337
|
+
DisplayMode?: ValidationDisplayMode;
|
|
14338
|
+
FieldsValidationConfidence?: number | null;
|
|
14339
|
+
AllowChangeOfDocumentType?: boolean | null;
|
|
12878
14340
|
}
|
|
12879
14341
|
interface FieldGroupValueProjection {
|
|
12880
|
-
|
|
12881
|
-
|
|
14342
|
+
FieldGroupName?: string | null;
|
|
14343
|
+
FieldValues?: FieldValueProjection[] | null;
|
|
12882
14344
|
}
|
|
12883
14345
|
interface FieldValueProjection {
|
|
12884
|
-
|
|
12885
|
-
|
|
12886
|
-
|
|
12887
|
-
|
|
12888
|
-
|
|
12889
|
-
|
|
12890
|
-
|
|
14346
|
+
Id?: string | null;
|
|
14347
|
+
Name?: string | null;
|
|
14348
|
+
Value?: string | null;
|
|
14349
|
+
UnformattedValue?: string | null;
|
|
14350
|
+
Confidence?: number | null;
|
|
14351
|
+
OcrConfidence?: number | null;
|
|
14352
|
+
Type?: FieldType;
|
|
12891
14353
|
}
|
|
12892
14354
|
|
|
12893
14355
|
declare enum MarkupType {
|
|
@@ -12938,59 +14400,59 @@ declare enum WordGroupType {
|
|
|
12938
14400
|
Other = "Other"
|
|
12939
14401
|
}
|
|
12940
14402
|
interface DocumentEntity {
|
|
12941
|
-
|
|
12942
|
-
|
|
12943
|
-
|
|
12944
|
-
|
|
12945
|
-
|
|
14403
|
+
DocumentId?: string | null;
|
|
14404
|
+
ContentType?: string | null;
|
|
14405
|
+
Length?: number;
|
|
14406
|
+
Pages?: Page[] | null;
|
|
14407
|
+
DocumentMetadata?: Metadata[] | null;
|
|
12946
14408
|
}
|
|
12947
14409
|
interface Metadata {
|
|
12948
|
-
|
|
12949
|
-
|
|
14410
|
+
Key?: string | null;
|
|
14411
|
+
Value?: string | null;
|
|
12950
14412
|
}
|
|
12951
14413
|
interface Page {
|
|
12952
|
-
|
|
12953
|
-
|
|
12954
|
-
|
|
12955
|
-
|
|
12956
|
-
|
|
12957
|
-
|
|
12958
|
-
|
|
12959
|
-
|
|
12960
|
-
|
|
12961
|
-
|
|
14414
|
+
PageIndex?: number;
|
|
14415
|
+
Size?: number[];
|
|
14416
|
+
Sections?: PageSection[] | null;
|
|
14417
|
+
PageMarkups?: PageMarkup[] | null;
|
|
14418
|
+
ProcessingSource?: ProcessingSource;
|
|
14419
|
+
IndexInText?: number;
|
|
14420
|
+
TextLength?: number;
|
|
14421
|
+
SkewAngle?: number;
|
|
14422
|
+
Rotation?: Rotation;
|
|
14423
|
+
PageMetadata?: Metadata[] | null;
|
|
12962
14424
|
}
|
|
12963
14425
|
interface PageMarkup {
|
|
12964
|
-
|
|
12965
|
-
|
|
12966
|
-
|
|
12967
|
-
|
|
12968
|
-
|
|
14426
|
+
Box?: number[];
|
|
14427
|
+
Polygon?: number[] | null;
|
|
14428
|
+
OcrConfidence?: number;
|
|
14429
|
+
Text?: string | null;
|
|
14430
|
+
MarkupType?: MarkupType;
|
|
12969
14431
|
}
|
|
12970
14432
|
interface PageSection {
|
|
12971
|
-
|
|
12972
|
-
|
|
12973
|
-
|
|
12974
|
-
|
|
12975
|
-
|
|
12976
|
-
|
|
12977
|
-
|
|
14433
|
+
IndexInText?: number;
|
|
14434
|
+
Language?: string | null;
|
|
14435
|
+
Length?: number;
|
|
14436
|
+
Rotation?: Rotation;
|
|
14437
|
+
SkewAngle?: number;
|
|
14438
|
+
Type?: SectionType;
|
|
14439
|
+
WordGroups?: WordGroup[] | null;
|
|
12978
14440
|
}
|
|
12979
14441
|
interface Word {
|
|
12980
|
-
|
|
12981
|
-
|
|
12982
|
-
|
|
12983
|
-
|
|
12984
|
-
|
|
12985
|
-
|
|
12986
|
-
|
|
12987
|
-
|
|
14442
|
+
Box?: number[];
|
|
14443
|
+
Polygon?: number[] | null;
|
|
14444
|
+
IndexInText?: number;
|
|
14445
|
+
OcrConfidence?: number;
|
|
14446
|
+
Text?: string | null;
|
|
14447
|
+
VisualLineNumber?: number;
|
|
14448
|
+
TextType?: TextType;
|
|
14449
|
+
MarkupType?: MarkupType[] | null;
|
|
12988
14450
|
}
|
|
12989
14451
|
interface WordGroup {
|
|
12990
|
-
|
|
12991
|
-
|
|
12992
|
-
|
|
12993
|
-
|
|
14452
|
+
IndexInText?: number;
|
|
14453
|
+
Length?: number;
|
|
14454
|
+
Type?: WordGroupType;
|
|
14455
|
+
Words?: Word[] | null;
|
|
12994
14456
|
}
|
|
12995
14457
|
|
|
12996
14458
|
declare enum ResultsDataSource {
|
|
@@ -13001,170 +14463,172 @@ declare enum ResultsDataSource {
|
|
|
13001
14463
|
External = "External"
|
|
13002
14464
|
}
|
|
13003
14465
|
interface ClassificationResult {
|
|
13004
|
-
|
|
13005
|
-
|
|
13006
|
-
|
|
13007
|
-
|
|
13008
|
-
|
|
13009
|
-
|
|
13010
|
-
|
|
14466
|
+
DocumentTypeId?: string | null;
|
|
14467
|
+
DocumentId?: string | null;
|
|
14468
|
+
Confidence?: number;
|
|
14469
|
+
OcrConfidence?: number;
|
|
14470
|
+
Reference?: ResultsContentReference;
|
|
14471
|
+
DocumentBounds?: ResultsDocumentBounds;
|
|
14472
|
+
ClassifierName?: string | null;
|
|
13011
14473
|
}
|
|
13012
14474
|
interface ExtractionResult {
|
|
13013
|
-
|
|
13014
|
-
|
|
13015
|
-
|
|
13016
|
-
|
|
13017
|
-
|
|
14475
|
+
DocumentId?: string | null;
|
|
14476
|
+
ResultsVersion?: number;
|
|
14477
|
+
ResultsDocument?: ResultsDocument;
|
|
14478
|
+
ExtractorPayloads?: ExtractorPayload[] | null;
|
|
14479
|
+
BusinessRulesResults?: RuleSetResult[] | null;
|
|
13018
14480
|
}
|
|
13019
14481
|
interface ExtractorPayload {
|
|
13020
|
-
|
|
13021
|
-
|
|
13022
|
-
|
|
13023
|
-
|
|
14482
|
+
Id?: string | null;
|
|
14483
|
+
Payload?: string | null;
|
|
14484
|
+
SavedPayloadId?: string | null;
|
|
14485
|
+
TaxonomySchemaMapping?: string | null;
|
|
13024
14486
|
}
|
|
13025
14487
|
interface ResultsContentReference {
|
|
13026
|
-
|
|
13027
|
-
|
|
13028
|
-
|
|
14488
|
+
TextStartIndex?: number;
|
|
14489
|
+
TextLength?: number;
|
|
14490
|
+
Tokens?: ResultsValueTokens[] | null;
|
|
13029
14491
|
}
|
|
13030
14492
|
interface ResultsDataPoint {
|
|
13031
|
-
|
|
13032
|
-
|
|
13033
|
-
|
|
13034
|
-
|
|
13035
|
-
|
|
13036
|
-
|
|
13037
|
-
|
|
13038
|
-
|
|
13039
|
-
|
|
13040
|
-
|
|
14493
|
+
FieldId?: string | null;
|
|
14494
|
+
FieldName?: string | null;
|
|
14495
|
+
FieldType?: FieldType;
|
|
14496
|
+
IsMissing?: boolean;
|
|
14497
|
+
DataSource?: ResultsDataSource;
|
|
14498
|
+
Values?: ResultsValue[] | null;
|
|
14499
|
+
DataVersion?: number;
|
|
14500
|
+
OperatorConfirmed?: boolean;
|
|
14501
|
+
ValidatorNotes?: string | null;
|
|
14502
|
+
ValidatorNotesInfo?: string | null;
|
|
13041
14503
|
}
|
|
13042
14504
|
interface ResultsDerivedField {
|
|
13043
|
-
|
|
13044
|
-
|
|
14505
|
+
FieldId?: string | null;
|
|
14506
|
+
Value?: string | null;
|
|
13045
14507
|
}
|
|
13046
14508
|
interface ResultsDocument {
|
|
13047
|
-
|
|
13048
|
-
|
|
13049
|
-
|
|
13050
|
-
|
|
13051
|
-
|
|
13052
|
-
|
|
13053
|
-
|
|
13054
|
-
|
|
13055
|
-
|
|
13056
|
-
|
|
13057
|
-
|
|
13058
|
-
|
|
14509
|
+
Bounds?: ResultsDocumentBounds;
|
|
14510
|
+
Language?: string | null;
|
|
14511
|
+
DocumentGroup?: string | null;
|
|
14512
|
+
DocumentCategory?: string | null;
|
|
14513
|
+
DocumentTypeId?: string | null;
|
|
14514
|
+
DocumentTypeName?: string | null;
|
|
14515
|
+
DocumentTypeDataVersion?: number;
|
|
14516
|
+
DataVersion?: number;
|
|
14517
|
+
DocumentTypeSource?: ResultsDataSource;
|
|
14518
|
+
DocumentTypeField?: ResultsValue;
|
|
14519
|
+
Fields?: ResultsDataPoint[] | null;
|
|
14520
|
+
Tables?: ResultsTable[] | null;
|
|
13059
14521
|
}
|
|
13060
14522
|
interface ResultsDocumentBounds {
|
|
13061
|
-
|
|
13062
|
-
|
|
13063
|
-
textStartIndex?: number;
|
|
13064
|
-
textLength?: number;
|
|
13065
|
-
pageRange?: string | null;
|
|
14523
|
+
PageCount?: number;
|
|
14524
|
+
PageRange?: string | null;
|
|
13066
14525
|
}
|
|
13067
14526
|
interface ResultsTable {
|
|
13068
|
-
|
|
13069
|
-
|
|
13070
|
-
|
|
13071
|
-
|
|
13072
|
-
|
|
13073
|
-
|
|
13074
|
-
|
|
13075
|
-
|
|
13076
|
-
|
|
14527
|
+
FieldId?: string | null;
|
|
14528
|
+
FieldName?: string | null;
|
|
14529
|
+
IsMissing?: boolean;
|
|
14530
|
+
DataSource?: ResultsDataSource;
|
|
14531
|
+
DataVersion?: number;
|
|
14532
|
+
OperatorConfirmed?: boolean;
|
|
14533
|
+
Values?: ResultsTableValue[] | null;
|
|
14534
|
+
ValidatorNotes?: string | null;
|
|
14535
|
+
ValidatorNotesInfo?: string | null;
|
|
13077
14536
|
}
|
|
13078
14537
|
interface ResultsTableCell {
|
|
13079
|
-
|
|
13080
|
-
|
|
13081
|
-
|
|
13082
|
-
|
|
13083
|
-
|
|
13084
|
-
|
|
13085
|
-
|
|
13086
|
-
|
|
14538
|
+
RowIndex?: number;
|
|
14539
|
+
ColumnIndex?: number;
|
|
14540
|
+
IsHeader?: boolean;
|
|
14541
|
+
IsMissing?: boolean;
|
|
14542
|
+
OperatorConfirmed?: boolean;
|
|
14543
|
+
DataSource?: ResultsDataSource;
|
|
14544
|
+
DataVersion?: number;
|
|
14545
|
+
Values?: ResultsValue[] | null;
|
|
13087
14546
|
}
|
|
13088
14547
|
interface ResultsTableColumnInfo {
|
|
13089
|
-
|
|
13090
|
-
|
|
13091
|
-
|
|
14548
|
+
FieldId?: string | null;
|
|
14549
|
+
FieldName?: string | null;
|
|
14550
|
+
FieldType?: FieldType;
|
|
13092
14551
|
}
|
|
13093
14552
|
interface ResultsTableValue {
|
|
13094
|
-
|
|
13095
|
-
|
|
13096
|
-
|
|
13097
|
-
|
|
13098
|
-
|
|
13099
|
-
|
|
13100
|
-
|
|
13101
|
-
|
|
14553
|
+
OperatorConfirmed?: boolean;
|
|
14554
|
+
Confidence?: number;
|
|
14555
|
+
OcrConfidence?: number;
|
|
14556
|
+
Cells?: ResultsTableCell[] | null;
|
|
14557
|
+
ColumnInfo?: ResultsTableColumnInfo[] | null;
|
|
14558
|
+
NumberOfRows?: number;
|
|
14559
|
+
ValidatorNotes?: string | null;
|
|
14560
|
+
ValidatorNotesInfo?: string | null;
|
|
13102
14561
|
}
|
|
13103
14562
|
interface ResultsValue {
|
|
13104
|
-
|
|
13105
|
-
|
|
13106
|
-
|
|
13107
|
-
|
|
13108
|
-
|
|
13109
|
-
|
|
13110
|
-
|
|
13111
|
-
|
|
13112
|
-
|
|
13113
|
-
|
|
13114
|
-
|
|
14563
|
+
Components?: ResultsDataPoint[] | null;
|
|
14564
|
+
Value?: string | null;
|
|
14565
|
+
UnformattedValue?: string | null;
|
|
14566
|
+
Reference?: ResultsContentReference;
|
|
14567
|
+
DerivedFields?: ResultsDerivedField[] | null;
|
|
14568
|
+
Confidence?: number;
|
|
14569
|
+
OperatorConfirmed?: boolean;
|
|
14570
|
+
OcrConfidence?: number;
|
|
14571
|
+
TextType?: TextType;
|
|
14572
|
+
ValidatorNotes?: string | null;
|
|
14573
|
+
ValidatorNotesInfo?: string | null;
|
|
13115
14574
|
}
|
|
13116
14575
|
interface ResultsValueTokens {
|
|
13117
|
-
|
|
13118
|
-
|
|
13119
|
-
|
|
13120
|
-
|
|
13121
|
-
|
|
13122
|
-
|
|
14576
|
+
TextStartIndex?: number;
|
|
14577
|
+
TextLength?: number;
|
|
14578
|
+
Page?: number;
|
|
14579
|
+
PageWidth?: number;
|
|
14580
|
+
PageHeight?: number;
|
|
14581
|
+
Boxes?: number[][] | null;
|
|
13123
14582
|
}
|
|
13124
14583
|
|
|
13125
14584
|
interface ClassificationRequestBody {
|
|
13126
|
-
|
|
13127
|
-
|
|
14585
|
+
DocumentId?: string;
|
|
14586
|
+
Prompts?: ClassificationPrompt[] | null;
|
|
13128
14587
|
}
|
|
13129
14588
|
interface ClassificationResponse {
|
|
13130
|
-
|
|
14589
|
+
ClassificationResults?: ClassificationResult[] | null;
|
|
13131
14590
|
}
|
|
13132
14591
|
interface StartClassificationResponse {
|
|
13133
|
-
|
|
13134
|
-
|
|
13135
|
-
}
|
|
13136
|
-
interface SwaggerGetClassificationResultResponse {
|
|
13137
|
-
status?: 'Succeeded' | 'Failed' | 'Running' | 'NotStarted';
|
|
13138
|
-
createdAt?: string;
|
|
13139
|
-
lastUpdatedAt?: string;
|
|
13140
|
-
error?: ErrorResponse;
|
|
13141
|
-
result?: ClassificationResponse;
|
|
14592
|
+
OperationId?: string;
|
|
14593
|
+
ResultUrl?: string | null;
|
|
13142
14594
|
}
|
|
13143
14595
|
|
|
13144
14596
|
interface DataDeletionRequest {
|
|
13145
|
-
|
|
14597
|
+
RemoveValidationDataFromStorage?: boolean;
|
|
14598
|
+
}
|
|
14599
|
+
|
|
14600
|
+
declare enum ErrorSeverity {
|
|
14601
|
+
Info = "Info",
|
|
14602
|
+
Warning = "Warning",
|
|
14603
|
+
Error = "Error"
|
|
14604
|
+
}
|
|
14605
|
+
interface ErrorResponse {
|
|
14606
|
+
Message?: string | null;
|
|
14607
|
+
Severity?: ErrorSeverity;
|
|
14608
|
+
Code?: string | null;
|
|
14609
|
+
Parameters?: string[] | null;
|
|
13146
14610
|
}
|
|
13147
14611
|
|
|
13148
14612
|
interface StartDigitizationFromAttachmentModel {
|
|
13149
|
-
|
|
13150
|
-
|
|
13151
|
-
|
|
13152
|
-
|
|
14613
|
+
AttachmentId?: string;
|
|
14614
|
+
FolderId?: string | null;
|
|
14615
|
+
FileName?: string | null;
|
|
14616
|
+
MimeType?: string | null;
|
|
13153
14617
|
}
|
|
13154
14618
|
interface StartDigitizationResponse {
|
|
13155
|
-
|
|
13156
|
-
|
|
14619
|
+
DocumentId?: string;
|
|
14620
|
+
ResultUrl?: string | null;
|
|
13157
14621
|
}
|
|
13158
14622
|
interface SwaggerGetDigitizeJobResponse {
|
|
13159
|
-
|
|
13160
|
-
|
|
13161
|
-
|
|
13162
|
-
|
|
13163
|
-
|
|
14623
|
+
Status?: JobStatus;
|
|
14624
|
+
Error?: ErrorResponse;
|
|
14625
|
+
Result?: SwaggerGetDigitizeJobResult;
|
|
14626
|
+
CreatedAt?: string;
|
|
14627
|
+
LastUpdatedAt?: string;
|
|
13164
14628
|
}
|
|
13165
14629
|
interface SwaggerGetDigitizeJobResult {
|
|
13166
|
-
|
|
13167
|
-
|
|
14630
|
+
DocumentObjectModel?: DocumentEntity;
|
|
14631
|
+
DocumentText?: string | null;
|
|
13168
14632
|
}
|
|
13169
14633
|
|
|
13170
14634
|
declare enum ProjectProperties {
|
|
@@ -13198,213 +14662,206 @@ declare enum ResourceType {
|
|
|
13198
14662
|
Unknown = "Unknown"
|
|
13199
14663
|
}
|
|
13200
14664
|
interface Classifier {
|
|
13201
|
-
|
|
13202
|
-
|
|
13203
|
-
|
|
13204
|
-
|
|
13205
|
-
|
|
13206
|
-
|
|
13207
|
-
|
|
13208
|
-
|
|
13209
|
-
|
|
13210
|
-
|
|
13211
|
-
|
|
14665
|
+
Id?: string | null;
|
|
14666
|
+
Name?: string | null;
|
|
14667
|
+
ResourceType?: ResourceType;
|
|
14668
|
+
Status?: ResourceStatus;
|
|
14669
|
+
DocumentTypeIds?: string[] | null;
|
|
14670
|
+
DetailsUrl?: string | null;
|
|
14671
|
+
SyncUrl?: string | null;
|
|
14672
|
+
AsyncUrl?: string | null;
|
|
14673
|
+
ProjectVersion?: number | null;
|
|
14674
|
+
ProjectVersionName?: string | null;
|
|
14675
|
+
Properties?: ProjectProperties[] | null;
|
|
13212
14676
|
}
|
|
13213
14677
|
interface DiscoveredDocumentType {
|
|
13214
|
-
|
|
13215
|
-
|
|
13216
|
-
|
|
13217
|
-
|
|
14678
|
+
Id?: string | null;
|
|
14679
|
+
Name?: string | null;
|
|
14680
|
+
ResourceType?: ResourceType;
|
|
14681
|
+
DetailsUrl?: string | null;
|
|
13218
14682
|
}
|
|
13219
14683
|
interface DiscoveredExtractorResourceSummaryResponse {
|
|
13220
|
-
|
|
13221
|
-
|
|
13222
|
-
|
|
13223
|
-
|
|
13224
|
-
|
|
13225
|
-
|
|
13226
|
-
|
|
13227
|
-
|
|
13228
|
-
|
|
13229
|
-
|
|
14684
|
+
Id?: string | null;
|
|
14685
|
+
Name?: string | null;
|
|
14686
|
+
ResourceType?: ResourceType;
|
|
14687
|
+
DetailsUrl?: string | null;
|
|
14688
|
+
DocumentTypeId?: string | null;
|
|
14689
|
+
DocumentTypeName?: string | null;
|
|
14690
|
+
ProjectVersion?: number | null;
|
|
14691
|
+
ProjectVersionName?: string | null;
|
|
14692
|
+
CreatedOn?: string | null;
|
|
14693
|
+
Description?: string | null;
|
|
13230
14694
|
}
|
|
13231
14695
|
interface DiscoveredProjectVersionResponseV2_0 {
|
|
13232
|
-
|
|
13233
|
-
|
|
13234
|
-
|
|
13235
|
-
|
|
13236
|
-
|
|
14696
|
+
Version?: number;
|
|
14697
|
+
VersionName?: string | null;
|
|
14698
|
+
Tags?: string[] | null;
|
|
14699
|
+
Date?: string;
|
|
14700
|
+
Deployed?: boolean;
|
|
13237
14701
|
}
|
|
13238
14702
|
interface DiscoveredResourceSummaryResponse {
|
|
13239
|
-
|
|
13240
|
-
|
|
13241
|
-
|
|
13242
|
-
|
|
13243
|
-
|
|
13244
|
-
|
|
13245
|
-
|
|
13246
|
-
|
|
14703
|
+
Id?: string | null;
|
|
14704
|
+
Name?: string | null;
|
|
14705
|
+
ResourceType?: ResourceType;
|
|
14706
|
+
DetailsUrl?: string | null;
|
|
14707
|
+
ProjectVersion?: number | null;
|
|
14708
|
+
ProjectVersionName?: string | null;
|
|
14709
|
+
CreatedOn?: string | null;
|
|
14710
|
+
Description?: string | null;
|
|
13247
14711
|
}
|
|
13248
14712
|
interface Extractor {
|
|
13249
|
-
|
|
13250
|
-
|
|
13251
|
-
|
|
13252
|
-
|
|
13253
|
-
|
|
13254
|
-
|
|
13255
|
-
|
|
13256
|
-
|
|
13257
|
-
|
|
13258
|
-
|
|
13259
|
-
|
|
14713
|
+
Id?: string | null;
|
|
14714
|
+
Name?: string | null;
|
|
14715
|
+
DocumentTypeId?: string | null;
|
|
14716
|
+
ResourceType?: ResourceType;
|
|
14717
|
+
Status?: ResourceStatus;
|
|
14718
|
+
DetailsUrl?: string | null;
|
|
14719
|
+
SyncUrl?: string | null;
|
|
14720
|
+
AsyncUrl?: string | null;
|
|
14721
|
+
ProjectVersion?: number | null;
|
|
14722
|
+
ProjectVersionName?: string | null;
|
|
14723
|
+
Description?: string | null;
|
|
13260
14724
|
}
|
|
13261
14725
|
interface GetClassifierDetailsDocumentTypeResponse {
|
|
13262
|
-
|
|
13263
|
-
|
|
13264
|
-
|
|
13265
|
-
|
|
13266
|
-
|
|
14726
|
+
Id?: string | null;
|
|
14727
|
+
Name?: string | null;
|
|
14728
|
+
ResourceType?: ResourceType;
|
|
14729
|
+
Type?: ClassifierDocumentTypeType;
|
|
14730
|
+
CreatedOn?: string | null;
|
|
13267
14731
|
}
|
|
13268
14732
|
interface GetClassifierDetailsResponse {
|
|
13269
|
-
|
|
13270
|
-
|
|
13271
|
-
|
|
13272
|
-
|
|
13273
|
-
|
|
13274
|
-
|
|
13275
|
-
|
|
13276
|
-
|
|
13277
|
-
|
|
13278
|
-
|
|
13279
|
-
|
|
14733
|
+
Id?: string | null;
|
|
14734
|
+
Name?: string | null;
|
|
14735
|
+
ResourceType?: ResourceType;
|
|
14736
|
+
Status?: ResourceStatus;
|
|
14737
|
+
DocumentTypes?: GetClassifierDetailsDocumentTypeResponse[] | null;
|
|
14738
|
+
CreatedOn?: string | null;
|
|
14739
|
+
SyncUrl?: string | null;
|
|
14740
|
+
AsyncUrl?: string | null;
|
|
14741
|
+
ProjectVersion?: number | null;
|
|
14742
|
+
ProjectVersionName?: string | null;
|
|
14743
|
+
Properties?: ProjectProperties[] | null;
|
|
13280
14744
|
}
|
|
13281
14745
|
interface GetClassifiersResponse {
|
|
13282
|
-
|
|
14746
|
+
Classifiers?: Classifier[] | null;
|
|
13283
14747
|
}
|
|
13284
14748
|
interface GetDocumentTypeDetailsByTagResponseV2_0 {
|
|
13285
|
-
|
|
13286
|
-
|
|
13287
|
-
|
|
13288
|
-
|
|
13289
|
-
|
|
14749
|
+
Id?: string | null;
|
|
14750
|
+
Name?: string | null;
|
|
14751
|
+
ResourceType?: ResourceType;
|
|
14752
|
+
CreatedOn?: string | null;
|
|
14753
|
+
DocumentTaxonomy?: DocumentTaxonomy;
|
|
13290
14754
|
}
|
|
13291
14755
|
interface GetDocumentTypeDetailsResponseV2_0 {
|
|
13292
|
-
|
|
13293
|
-
|
|
13294
|
-
|
|
13295
|
-
|
|
13296
|
-
|
|
13297
|
-
|
|
14756
|
+
Id?: string | null;
|
|
14757
|
+
Name?: string | null;
|
|
14758
|
+
ResourceType?: ResourceType;
|
|
14759
|
+
CreatedOn?: string | null;
|
|
14760
|
+
Classifiers?: DiscoveredResourceSummaryResponse[] | null;
|
|
14761
|
+
Extractors?: DiscoveredResourceSummaryResponse[] | null;
|
|
13298
14762
|
}
|
|
13299
14763
|
interface GetDocumentTypesResponse {
|
|
13300
|
-
|
|
14764
|
+
DocumentTypes?: DiscoveredDocumentType[] | null;
|
|
13301
14765
|
}
|
|
13302
14766
|
interface GetExtractorDetailsResponseV2_0 {
|
|
13303
|
-
|
|
13304
|
-
|
|
13305
|
-
|
|
13306
|
-
|
|
13307
|
-
|
|
13308
|
-
|
|
13309
|
-
|
|
13310
|
-
|
|
13311
|
-
|
|
13312
|
-
|
|
13313
|
-
|
|
13314
|
-
|
|
13315
|
-
|
|
13316
|
-
|
|
14767
|
+
Id?: string | null;
|
|
14768
|
+
Name?: string | null;
|
|
14769
|
+
ResourceType?: ResourceType;
|
|
14770
|
+
Status?: ResourceStatus;
|
|
14771
|
+
ProjectId?: string;
|
|
14772
|
+
ProjectVersion?: number | null;
|
|
14773
|
+
ProjectVersionName?: string | null;
|
|
14774
|
+
DocumentTypeName?: string | null;
|
|
14775
|
+
DocumentTypeId?: string | null;
|
|
14776
|
+
CreatedOn?: string | null;
|
|
14777
|
+
SyncUrl?: string | null;
|
|
14778
|
+
AsyncUrl?: string | null;
|
|
14779
|
+
Description?: string | null;
|
|
14780
|
+
DocumentTaxonomy?: DocumentTaxonomy;
|
|
13317
14781
|
}
|
|
13318
14782
|
interface GetExtractorsResponse {
|
|
13319
|
-
|
|
14783
|
+
Extractors?: Extractor[] | null;
|
|
13320
14784
|
}
|
|
13321
14785
|
interface GetProjectDetailsResponseV2_0 {
|
|
13322
|
-
|
|
13323
|
-
|
|
13324
|
-
|
|
13325
|
-
|
|
13326
|
-
|
|
13327
|
-
|
|
13328
|
-
|
|
13329
|
-
|
|
13330
|
-
|
|
13331
|
-
|
|
14786
|
+
Id?: string;
|
|
14787
|
+
Name?: string | null;
|
|
14788
|
+
Description?: string | null;
|
|
14789
|
+
Type?: ProjectType;
|
|
14790
|
+
Properties?: ProjectProperties[] | null;
|
|
14791
|
+
DocumentTypes?: DiscoveredResourceSummaryResponse[] | null;
|
|
14792
|
+
Classifiers?: DiscoveredResourceSummaryResponse[] | null;
|
|
14793
|
+
Extractors?: DiscoveredExtractorResourceSummaryResponse[] | null;
|
|
14794
|
+
ProjectVersions?: DiscoveredProjectVersionResponseV2_0[] | null;
|
|
14795
|
+
CreatedOn?: string | null;
|
|
13332
14796
|
}
|
|
13333
14797
|
interface GetProjectsResponse {
|
|
13334
|
-
|
|
14798
|
+
Projects?: Project[] | null;
|
|
13335
14799
|
}
|
|
13336
14800
|
interface GetProjectTaxonomyResponse {
|
|
13337
|
-
|
|
14801
|
+
DocumentTaxonomy?: DocumentTaxonomy;
|
|
13338
14802
|
}
|
|
13339
14803
|
interface GetTagsResponse {
|
|
13340
|
-
|
|
14804
|
+
Tags?: TagEntity[] | null;
|
|
13341
14805
|
}
|
|
13342
14806
|
interface Project {
|
|
13343
|
-
|
|
13344
|
-
|
|
13345
|
-
|
|
13346
|
-
|
|
13347
|
-
|
|
13348
|
-
|
|
13349
|
-
|
|
13350
|
-
|
|
13351
|
-
|
|
13352
|
-
|
|
14807
|
+
Id?: string;
|
|
14808
|
+
Name?: string | null;
|
|
14809
|
+
Type?: ProjectType;
|
|
14810
|
+
Description?: string | null;
|
|
14811
|
+
CreatedOn?: string | null;
|
|
14812
|
+
DetailsUrl?: string | null;
|
|
14813
|
+
DigitizationStartUrl?: string | null;
|
|
14814
|
+
ClassifiersDiscoveryUrl?: string | null;
|
|
14815
|
+
ExtractorsDiscoveryUrl?: string | null;
|
|
14816
|
+
Properties?: ProjectProperties[] | null;
|
|
13353
14817
|
}
|
|
13354
14818
|
interface TagEntity {
|
|
13355
|
-
|
|
13356
|
-
|
|
13357
|
-
|
|
13358
|
-
|
|
13359
|
-
|
|
14819
|
+
Name?: string | null;
|
|
14820
|
+
ProjectVersion?: number | null;
|
|
14821
|
+
ProjectVersionName?: string | null;
|
|
14822
|
+
Extractors?: TaggedExtractor[] | null;
|
|
14823
|
+
Classifiers?: TaggedClassifier[] | null;
|
|
13360
14824
|
}
|
|
13361
14825
|
interface TaggedClassifier {
|
|
13362
|
-
|
|
13363
|
-
|
|
13364
|
-
|
|
13365
|
-
|
|
14826
|
+
Name?: string | null;
|
|
14827
|
+
DocumentTypes?: DiscoveredDocumentType[] | null;
|
|
14828
|
+
SyncUrl?: string | null;
|
|
14829
|
+
AsyncUrl?: string | null;
|
|
13366
14830
|
}
|
|
13367
14831
|
interface TaggedExtractor {
|
|
13368
|
-
|
|
13369
|
-
|
|
13370
|
-
|
|
13371
|
-
|
|
14832
|
+
Name?: string | null;
|
|
14833
|
+
DocumentType?: DiscoveredDocumentType;
|
|
14834
|
+
SyncUrl?: string | null;
|
|
14835
|
+
AsyncUrl?: string | null;
|
|
13372
14836
|
}
|
|
13373
14837
|
|
|
13374
14838
|
interface ExtractionPromptRequestBody {
|
|
13375
|
-
|
|
13376
|
-
|
|
13377
|
-
|
|
13378
|
-
|
|
14839
|
+
Id?: string | null;
|
|
14840
|
+
Question?: string | null;
|
|
14841
|
+
FieldType?: GptFieldType;
|
|
14842
|
+
MultiValued?: boolean | null;
|
|
13379
14843
|
}
|
|
13380
14844
|
interface ExtractRequestBodyConfiguration {
|
|
13381
|
-
|
|
14845
|
+
AutoValidationConfidenceThreshold?: number | null;
|
|
13382
14846
|
}
|
|
13383
14847
|
interface ExtractRequestBodyV2_0 {
|
|
13384
|
-
|
|
13385
|
-
|
|
13386
|
-
|
|
13387
|
-
|
|
13388
|
-
|
|
14848
|
+
DocumentId?: string;
|
|
14849
|
+
PageRange?: string | null;
|
|
14850
|
+
Prompts?: ExtractionPromptRequestBody[] | null;
|
|
14851
|
+
Configuration?: ExtractRequestBodyConfiguration;
|
|
14852
|
+
DocumentTaxonomy?: DocumentTaxonomy;
|
|
13389
14853
|
}
|
|
13390
14854
|
interface ExtractSyncResult {
|
|
13391
|
-
|
|
14855
|
+
ExtractionResult?: ExtractionResult;
|
|
13392
14856
|
}
|
|
13393
14857
|
interface StartExtractionResponse {
|
|
13394
|
-
|
|
13395
|
-
|
|
13396
|
-
}
|
|
13397
|
-
interface SwaggerGetExtractionResultResponse {
|
|
13398
|
-
status?: 'Succeeded' | 'Failed' | 'Running' | 'NotStarted';
|
|
13399
|
-
createdAt?: string;
|
|
13400
|
-
lastUpdatedAt?: string;
|
|
13401
|
-
error?: ErrorResponse;
|
|
13402
|
-
result?: ExtractSyncResult;
|
|
14858
|
+
OperationId?: string;
|
|
14859
|
+
ResultUrl?: string | null;
|
|
13403
14860
|
}
|
|
13404
14861
|
|
|
13405
14862
|
declare enum ModelKind {
|
|
13406
|
-
|
|
13407
|
-
|
|
14863
|
+
Extractor = "Extractor",
|
|
14864
|
+
Classifier = "Classifier"
|
|
13408
14865
|
}
|
|
13409
14866
|
declare enum ModelType {
|
|
13410
14867
|
IXP = "IXP",
|
|
@@ -13412,40 +14869,42 @@ declare enum ModelType {
|
|
|
13412
14869
|
Predefined = "Predefined"
|
|
13413
14870
|
}
|
|
13414
14871
|
interface FolderBasedStartExtractionRequest {
|
|
13415
|
-
|
|
13416
|
-
|
|
13417
|
-
|
|
14872
|
+
DocumentId?: string;
|
|
14873
|
+
DocumentTaxonomy?: DocumentTaxonomy;
|
|
14874
|
+
PageRange?: string | null;
|
|
13418
14875
|
}
|
|
13419
14876
|
interface FolderBasedStartExtractionResponse {
|
|
13420
|
-
|
|
13421
|
-
|
|
14877
|
+
OperationId?: string;
|
|
14878
|
+
ResultUrl?: string | null;
|
|
13422
14879
|
}
|
|
13423
14880
|
interface FolderModelsResponse {
|
|
13424
|
-
|
|
13425
|
-
|
|
13426
|
-
|
|
14881
|
+
FolderKey?: string | null;
|
|
14882
|
+
FullyQualifiedName?: string | null;
|
|
14883
|
+
Models?: ModelSummaryResponse[] | null;
|
|
13427
14884
|
}
|
|
13428
14885
|
interface GetModelDetailsResponse {
|
|
13429
|
-
|
|
13430
|
-
|
|
13431
|
-
|
|
13432
|
-
|
|
13433
|
-
|
|
13434
|
-
|
|
13435
|
-
|
|
14886
|
+
FullyQualifiedName?: string | null;
|
|
14887
|
+
ModelDisplayName?: string | null;
|
|
14888
|
+
Kind?: ModelKind;
|
|
14889
|
+
Type?: ModelType;
|
|
14890
|
+
Description?: string | null;
|
|
14891
|
+
AsyncDigitizationUrl?: string | null;
|
|
14892
|
+
AsyncExtractionUrl?: string | null;
|
|
14893
|
+
DocumentTaxonomy?: DocumentTaxonomy;
|
|
13436
14894
|
}
|
|
13437
14895
|
interface GetModelsResponse {
|
|
13438
|
-
|
|
14896
|
+
Folders?: FolderModelsResponse[] | null;
|
|
13439
14897
|
}
|
|
13440
14898
|
interface ModelSummaryResponse {
|
|
13441
|
-
|
|
13442
|
-
|
|
13443
|
-
|
|
13444
|
-
|
|
13445
|
-
|
|
13446
|
-
|
|
13447
|
-
|
|
13448
|
-
|
|
14899
|
+
ModelName?: string | null;
|
|
14900
|
+
ModelDisplayName?: string | null;
|
|
14901
|
+
Description?: string | null;
|
|
14902
|
+
Kind?: ModelKind;
|
|
14903
|
+
Type?: ModelType;
|
|
14904
|
+
FullyQualifiedName?: string | null;
|
|
14905
|
+
DetailsUrl?: string | null;
|
|
14906
|
+
AsyncDigitizationUrl?: string | null;
|
|
14907
|
+
AsyncExtractionUrl?: string | null;
|
|
13449
14908
|
}
|
|
13450
14909
|
|
|
13451
14910
|
declare enum ActionStatus {
|
|
@@ -13454,174 +14913,198 @@ declare enum ActionStatus {
|
|
|
13454
14913
|
Completed = "Completed"
|
|
13455
14914
|
}
|
|
13456
14915
|
interface ClassificationValidationResult {
|
|
13457
|
-
|
|
13458
|
-
|
|
13459
|
-
|
|
14916
|
+
ActionStatus?: ActionStatus;
|
|
14917
|
+
ActionData?: DocumentClassificationActionDataModel;
|
|
14918
|
+
ValidatedClassificationResults?: ClassificationResult[] | null;
|
|
13460
14919
|
}
|
|
13461
14920
|
interface ExtractionValidationArtifactsResult {
|
|
13462
|
-
|
|
14921
|
+
ValidatedExtractionResults?: ExtractionResult;
|
|
13463
14922
|
}
|
|
13464
14923
|
interface ExtractionValidationResult {
|
|
13465
|
-
|
|
13466
|
-
|
|
13467
|
-
|
|
13468
|
-
|
|
14924
|
+
ActionStatus?: ActionStatus;
|
|
14925
|
+
ActionData?: DocumentExtractionActionDataModel;
|
|
14926
|
+
ValidatedExtractionResults?: ExtractionResult;
|
|
14927
|
+
DataProjection?: FieldGroupValueProjection[] | null;
|
|
13469
14928
|
}
|
|
13470
14929
|
interface GetClassificationValidationTaskResponse {
|
|
13471
|
-
|
|
13472
|
-
|
|
13473
|
-
|
|
13474
|
-
|
|
13475
|
-
|
|
14930
|
+
Status?: JobStatus;
|
|
14931
|
+
Error?: ErrorResponse;
|
|
14932
|
+
CreatedAt?: string;
|
|
14933
|
+
LastUpdatedAt?: string;
|
|
14934
|
+
Result?: ClassificationValidationResult;
|
|
13476
14935
|
}
|
|
13477
14936
|
interface GetExtractionValidationArtifactsResultTaskResponse {
|
|
13478
|
-
|
|
14937
|
+
Result?: ExtractionValidationArtifactsResult;
|
|
13479
14938
|
}
|
|
13480
14939
|
interface GetExtractionValidationArtifactsTaskResponse {
|
|
13481
|
-
|
|
13482
|
-
|
|
13483
|
-
|
|
13484
|
-
|
|
13485
|
-
|
|
14940
|
+
Status?: JobStatus;
|
|
14941
|
+
Error?: ErrorResponse;
|
|
14942
|
+
CreatedAt?: string;
|
|
14943
|
+
LastUpdatedAt?: string;
|
|
14944
|
+
ContentValidationData?: ContentValidationData;
|
|
13486
14945
|
}
|
|
13487
14946
|
interface GetExtractionValidationTaskResponse {
|
|
13488
|
-
|
|
13489
|
-
|
|
13490
|
-
|
|
13491
|
-
|
|
13492
|
-
|
|
14947
|
+
Status?: JobStatus;
|
|
14948
|
+
Error?: ErrorResponse;
|
|
14949
|
+
CreatedAt?: string;
|
|
14950
|
+
LastUpdatedAt?: string;
|
|
14951
|
+
Result?: ExtractionValidationResult;
|
|
13493
14952
|
}
|
|
13494
14953
|
interface StartClassificationValidationTaskRequest {
|
|
13495
|
-
|
|
13496
|
-
|
|
13497
|
-
|
|
13498
|
-
|
|
13499
|
-
|
|
13500
|
-
|
|
13501
|
-
|
|
13502
|
-
|
|
13503
|
-
|
|
13504
|
-
|
|
14954
|
+
DocumentId?: string | null;
|
|
14955
|
+
ActionTitle?: string | null;
|
|
14956
|
+
ActionPriority?: CreateTaskPriority;
|
|
14957
|
+
ActionCatalog?: string | null;
|
|
14958
|
+
ActionFolder?: string | null;
|
|
14959
|
+
StorageBucketName?: string | null;
|
|
14960
|
+
StorageBucketDirectoryPath?: string | null;
|
|
14961
|
+
Prompts?: ClassificationPrompt[] | null;
|
|
14962
|
+
Configuration?: ClassificationValidationConfiguration;
|
|
14963
|
+
ClassificationResults?: ClassificationResult[] | null;
|
|
13505
14964
|
}
|
|
13506
14965
|
interface StartExtractionValidationArtifactsRequest {
|
|
13507
|
-
|
|
13508
|
-
|
|
13509
|
-
|
|
13510
|
-
|
|
13511
|
-
|
|
13512
|
-
|
|
14966
|
+
DocumentId?: string;
|
|
14967
|
+
ExtractionResult?: ExtractionResult;
|
|
14968
|
+
DocumentTaxonomy?: DocumentTaxonomy;
|
|
14969
|
+
FolderName?: string | null;
|
|
14970
|
+
StorageBucketName?: string | null;
|
|
14971
|
+
StorageBucketDirectoryPath?: string | null;
|
|
13513
14972
|
}
|
|
13514
14973
|
interface StartExtractionValidationTaskRequestV2_0 {
|
|
13515
|
-
|
|
13516
|
-
|
|
13517
|
-
|
|
13518
|
-
|
|
13519
|
-
|
|
13520
|
-
|
|
13521
|
-
|
|
13522
|
-
|
|
13523
|
-
|
|
13524
|
-
|
|
13525
|
-
|
|
13526
|
-
configuration?: ExtractionValidationConfigurationV2;
|
|
13527
|
-
documentTaxonomy?: DocumentTaxonomy;
|
|
14974
|
+
DocumentId?: string | null;
|
|
14975
|
+
ActionTitle?: string | null;
|
|
14976
|
+
ActionPriority?: CreateTaskPriority;
|
|
14977
|
+
ActionCatalog?: string | null;
|
|
14978
|
+
ActionFolder?: string | null;
|
|
14979
|
+
StorageBucketName?: string | null;
|
|
14980
|
+
StorageBucketDirectoryPath?: string | null;
|
|
14981
|
+
Prompts?: ExtractionPrompt[] | null;
|
|
14982
|
+
ExtractionResult?: ExtractionResult;
|
|
14983
|
+
Configuration?: ExtractionValidationConfigurationV2;
|
|
14984
|
+
DocumentTaxonomy?: DocumentTaxonomy;
|
|
13528
14985
|
}
|
|
13529
14986
|
interface StartValidationArtifactsTaskResponse {
|
|
13530
|
-
|
|
13531
|
-
|
|
13532
|
-
|
|
14987
|
+
OperationId?: string;
|
|
14988
|
+
ArtifactsUrl?: string | null;
|
|
14989
|
+
ResultUrl?: string | null;
|
|
13533
14990
|
}
|
|
13534
14991
|
interface StartValidationTaskResponse {
|
|
13535
|
-
|
|
13536
|
-
|
|
14992
|
+
OperationId?: string;
|
|
14993
|
+
ResultUrl?: string | null;
|
|
13537
14994
|
}
|
|
13538
14995
|
|
|
13539
14996
|
interface ClassificationValidationFinishedTaskInfo {
|
|
13540
|
-
|
|
13541
|
-
|
|
13542
|
-
|
|
13543
|
-
|
|
13544
|
-
|
|
13545
|
-
|
|
13546
|
-
|
|
13547
|
-
|
|
13548
|
-
|
|
13549
|
-
|
|
13550
|
-
|
|
13551
|
-
|
|
13552
|
-
|
|
13553
|
-
|
|
13554
|
-
|
|
14997
|
+
Id?: number;
|
|
14998
|
+
Title?: string | null;
|
|
14999
|
+
Priority?: DocumentActionPriority;
|
|
15000
|
+
Status?: ActionStatus;
|
|
15001
|
+
CreationTime?: string;
|
|
15002
|
+
CompletionTime?: string | null;
|
|
15003
|
+
LastAssignedTime?: string;
|
|
15004
|
+
Url?: string | null;
|
|
15005
|
+
AssignedToUser?: string | null;
|
|
15006
|
+
CompletedByUser?: string | null;
|
|
15007
|
+
LastModifierUser?: string | null;
|
|
15008
|
+
DocumentRejectionReason?: string | null;
|
|
15009
|
+
CatalogName?: string | null;
|
|
15010
|
+
FolderName?: string | null;
|
|
15011
|
+
ProcessingTime?: number | null;
|
|
13555
15012
|
}
|
|
13556
15013
|
interface FinishExtractionValidationTaskInfo {
|
|
13557
|
-
|
|
13558
|
-
|
|
13559
|
-
|
|
13560
|
-
|
|
13561
|
-
|
|
13562
|
-
|
|
13563
|
-
|
|
13564
|
-
|
|
13565
|
-
|
|
13566
|
-
|
|
13567
|
-
|
|
13568
|
-
|
|
13569
|
-
|
|
13570
|
-
|
|
13571
|
-
|
|
15014
|
+
Id?: number;
|
|
15015
|
+
Title?: string | null;
|
|
15016
|
+
Priority?: DocumentActionPriority;
|
|
15017
|
+
Status?: ActionStatus;
|
|
15018
|
+
CreationTime?: string;
|
|
15019
|
+
CompletionTime?: string | null;
|
|
15020
|
+
LastAssignedTime?: string;
|
|
15021
|
+
Url?: string | null;
|
|
15022
|
+
AssignedToUser?: string | null;
|
|
15023
|
+
CompletedByUser?: string | null;
|
|
15024
|
+
LastModifierUser?: string | null;
|
|
15025
|
+
DocumentRejectionReason?: string | null;
|
|
15026
|
+
CatalogName?: string | null;
|
|
15027
|
+
FolderName?: string | null;
|
|
15028
|
+
ProcessingTime?: number | null;
|
|
13572
15029
|
}
|
|
13573
15030
|
interface StartClassificationValidationTaskInfo {
|
|
13574
|
-
|
|
13575
|
-
|
|
13576
|
-
|
|
13577
|
-
|
|
13578
|
-
|
|
13579
|
-
|
|
13580
|
-
|
|
13581
|
-
|
|
15031
|
+
Id?: number;
|
|
15032
|
+
Title?: string | null;
|
|
15033
|
+
FolderName?: string | null;
|
|
15034
|
+
StorageBucketName?: string | null;
|
|
15035
|
+
StorageBucketDirectoryPath?: string | null;
|
|
15036
|
+
CatalogName?: string | null;
|
|
15037
|
+
Priority?: DocumentActionPriority;
|
|
15038
|
+
Status?: ActionStatus;
|
|
13582
15039
|
}
|
|
13583
15040
|
interface StartExtractionValidationTaskInfo {
|
|
13584
|
-
|
|
13585
|
-
|
|
13586
|
-
|
|
13587
|
-
|
|
13588
|
-
|
|
13589
|
-
|
|
13590
|
-
|
|
13591
|
-
|
|
15041
|
+
Id?: number;
|
|
15042
|
+
Title?: string | null;
|
|
15043
|
+
FolderName?: string | null;
|
|
15044
|
+
StorageBucketName?: string | null;
|
|
15045
|
+
StorageBucketDirectoryPath?: string | null;
|
|
15046
|
+
CatalogName?: string | null;
|
|
15047
|
+
Priority?: DocumentActionPriority;
|
|
15048
|
+
Status?: ActionStatus;
|
|
13592
15049
|
}
|
|
13593
15050
|
interface TrackFinishClassificationValidationRequest {
|
|
13594
|
-
|
|
13595
|
-
|
|
13596
|
-
|
|
13597
|
-
|
|
13598
|
-
|
|
15051
|
+
ClassifierId?: string | null;
|
|
15052
|
+
Tag?: string | null;
|
|
15053
|
+
DocumentId?: string;
|
|
15054
|
+
Task?: ClassificationValidationFinishedTaskInfo;
|
|
15055
|
+
ClassificationResult?: ClassificationResult[] | null;
|
|
13599
15056
|
}
|
|
13600
15057
|
interface TrackFinishExtractionValidationRequest {
|
|
13601
|
-
|
|
13602
|
-
|
|
13603
|
-
|
|
13604
|
-
|
|
13605
|
-
|
|
13606
|
-
|
|
13607
|
-
|
|
15058
|
+
ExtractorId?: string | null;
|
|
15059
|
+
Tag?: string | null;
|
|
15060
|
+
DocumentTypeId?: string | null;
|
|
15061
|
+
DocumentId?: string;
|
|
15062
|
+
Task?: FinishExtractionValidationTaskInfo;
|
|
15063
|
+
ExtractionResult?: ExtractionResult;
|
|
15064
|
+
ValidatedExtractionResult?: ExtractionResult;
|
|
13608
15065
|
}
|
|
13609
15066
|
interface TrackStartClassificationValidationRequest {
|
|
13610
|
-
|
|
13611
|
-
|
|
13612
|
-
|
|
13613
|
-
|
|
13614
|
-
|
|
13615
|
-
|
|
15067
|
+
ClassifierId?: string | null;
|
|
15068
|
+
Tag?: string | null;
|
|
15069
|
+
DocumentId?: string;
|
|
15070
|
+
Duration?: number;
|
|
15071
|
+
Task?: StartClassificationValidationTaskInfo;
|
|
15072
|
+
ClassificationResult?: ClassificationResult[] | null;
|
|
13616
15073
|
}
|
|
13617
15074
|
interface TrackStartExtractionValidationRequest {
|
|
13618
|
-
|
|
13619
|
-
|
|
13620
|
-
|
|
13621
|
-
|
|
13622
|
-
|
|
13623
|
-
|
|
13624
|
-
|
|
15075
|
+
ExtractorId?: string | null;
|
|
15076
|
+
Tag?: string | null;
|
|
15077
|
+
DocumentTypeId?: string | null;
|
|
15078
|
+
DocumentId?: string;
|
|
15079
|
+
Duration?: number;
|
|
15080
|
+
Task?: StartExtractionValidationTaskInfo;
|
|
15081
|
+
ExtractionResult?: ExtractionResult;
|
|
15082
|
+
}
|
|
15083
|
+
|
|
15084
|
+
interface GetClassificationResultResponse {
|
|
15085
|
+
Status?: JobStatus;
|
|
15086
|
+
CreatedAt?: string;
|
|
15087
|
+
LastUpdatedAt?: string;
|
|
15088
|
+
Error?: ErrorResponse;
|
|
15089
|
+
Result?: ClassificationResponse;
|
|
15090
|
+
}
|
|
15091
|
+
interface GetDigitizeJobResponse {
|
|
15092
|
+
Status?: JobStatus;
|
|
15093
|
+
Error?: ErrorResponse;
|
|
15094
|
+
Result?: GetDigitizeJobResult;
|
|
15095
|
+
CreatedAt?: string;
|
|
15096
|
+
LastUpdatedAt?: string;
|
|
15097
|
+
}
|
|
15098
|
+
interface GetDigitizeJobResult {
|
|
15099
|
+
DocumentObjectModel?: DocumentEntity;
|
|
15100
|
+
DocumentText?: string | null;
|
|
15101
|
+
}
|
|
15102
|
+
interface GetExtractionResultResponse {
|
|
15103
|
+
Status?: JobStatus;
|
|
15104
|
+
CreatedAt?: string;
|
|
15105
|
+
LastUpdatedAt?: string;
|
|
15106
|
+
Error?: ErrorResponse;
|
|
15107
|
+
Result?: ExtractSyncResult;
|
|
13625
15108
|
}
|
|
13626
15109
|
|
|
13627
15110
|
type index_ActionStatus = ActionStatus;
|
|
@@ -13662,6 +15145,8 @@ type index_DocumentGroup = DocumentGroup;
|
|
|
13662
15145
|
type index_DocumentTaxonomy = DocumentTaxonomy;
|
|
13663
15146
|
type index_DocumentTypeEntity = DocumentTypeEntity;
|
|
13664
15147
|
type index_ErrorResponse = ErrorResponse;
|
|
15148
|
+
type index_ErrorSeverity = ErrorSeverity;
|
|
15149
|
+
declare const index_ErrorSeverity: typeof ErrorSeverity;
|
|
13665
15150
|
type index_ExceptionReasonOption = ExceptionReasonOption;
|
|
13666
15151
|
type index_ExtractRequestBodyConfiguration = ExtractRequestBodyConfiguration;
|
|
13667
15152
|
type index_ExtractRequestBodyV2_0 = ExtractRequestBodyV2_0;
|
|
@@ -13685,13 +15170,17 @@ type index_FinishExtractionValidationTaskInfo = FinishExtractionValidationTaskIn
|
|
|
13685
15170
|
type index_FolderBasedStartExtractionRequest = FolderBasedStartExtractionRequest;
|
|
13686
15171
|
type index_FolderBasedStartExtractionResponse = FolderBasedStartExtractionResponse;
|
|
13687
15172
|
type index_FolderModelsResponse = FolderModelsResponse;
|
|
15173
|
+
type index_GetClassificationResultResponse = GetClassificationResultResponse;
|
|
13688
15174
|
type index_GetClassificationValidationTaskResponse = GetClassificationValidationTaskResponse;
|
|
13689
15175
|
type index_GetClassifierDetailsDocumentTypeResponse = GetClassifierDetailsDocumentTypeResponse;
|
|
13690
15176
|
type index_GetClassifierDetailsResponse = GetClassifierDetailsResponse;
|
|
13691
15177
|
type index_GetClassifiersResponse = GetClassifiersResponse;
|
|
15178
|
+
type index_GetDigitizeJobResponse = GetDigitizeJobResponse;
|
|
15179
|
+
type index_GetDigitizeJobResult = GetDigitizeJobResult;
|
|
13692
15180
|
type index_GetDocumentTypeDetailsByTagResponseV2_0 = GetDocumentTypeDetailsByTagResponseV2_0;
|
|
13693
15181
|
type index_GetDocumentTypeDetailsResponseV2_0 = GetDocumentTypeDetailsResponseV2_0;
|
|
13694
15182
|
type index_GetDocumentTypesResponse = GetDocumentTypesResponse;
|
|
15183
|
+
type index_GetExtractionResultResponse = GetExtractionResultResponse;
|
|
13695
15184
|
type index_GetExtractionValidationArtifactsResultTaskResponse = GetExtractionValidationArtifactsResultTaskResponse;
|
|
13696
15185
|
type index_GetExtractionValidationArtifactsTaskResponse = GetExtractionValidationArtifactsTaskResponse;
|
|
13697
15186
|
type index_GetExtractionValidationTaskResponse = GetExtractionValidationTaskResponse;
|
|
@@ -13705,6 +15194,8 @@ type index_GetProjectsResponse = GetProjectsResponse;
|
|
|
13705
15194
|
type index_GetTagsResponse = GetTagsResponse;
|
|
13706
15195
|
type index_GptFieldType = GptFieldType;
|
|
13707
15196
|
declare const index_GptFieldType: typeof GptFieldType;
|
|
15197
|
+
type index_JobStatus = JobStatus;
|
|
15198
|
+
declare const index_JobStatus: typeof JobStatus;
|
|
13708
15199
|
type index_LanguageInfo = LanguageInfo;
|
|
13709
15200
|
type index_LogicalOperator = LogicalOperator;
|
|
13710
15201
|
declare const index_LogicalOperator: typeof LogicalOperator;
|
|
@@ -13766,10 +15257,8 @@ type index_StartExtractionValidationTaskInfo = StartExtractionValidationTaskInfo
|
|
|
13766
15257
|
type index_StartExtractionValidationTaskRequestV2_0 = StartExtractionValidationTaskRequestV2_0;
|
|
13767
15258
|
type index_StartValidationArtifactsTaskResponse = StartValidationArtifactsTaskResponse;
|
|
13768
15259
|
type index_StartValidationTaskResponse = StartValidationTaskResponse;
|
|
13769
|
-
type index_SwaggerGetClassificationResultResponse = SwaggerGetClassificationResultResponse;
|
|
13770
15260
|
type index_SwaggerGetDigitizeJobResponse = SwaggerGetDigitizeJobResponse;
|
|
13771
15261
|
type index_SwaggerGetDigitizeJobResult = SwaggerGetDigitizeJobResult;
|
|
13772
|
-
type index_SwaggerGetExtractionResultResponse = SwaggerGetExtractionResultResponse;
|
|
13773
15262
|
type index_TagEntity = TagEntity;
|
|
13774
15263
|
type index_TaggedClassifier = TaggedClassifier;
|
|
13775
15264
|
type index_TaggedExtractor = TaggedExtractor;
|
|
@@ -13788,8 +15277,8 @@ type index_WordGroup = WordGroup;
|
|
|
13788
15277
|
type index_WordGroupType = WordGroupType;
|
|
13789
15278
|
declare const index_WordGroupType: typeof WordGroupType;
|
|
13790
15279
|
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,
|
|
15280
|
+
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 };
|
|
15281
|
+
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
15282
|
}
|
|
13794
15283
|
|
|
13795
15284
|
/**
|
|
@@ -14054,103 +15543,11 @@ declare enum UiPathMetaTags {
|
|
|
14054
15543
|
FOLDER_KEY = "uipath:folder-key"
|
|
14055
15544
|
}
|
|
14056
15545
|
|
|
14057
|
-
|
|
14058
|
-
|
|
14059
|
-
|
|
14060
|
-
|
|
14061
|
-
|
|
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 = "";
|
|
15546
|
+
declare const track: _uipath_core_telemetry.Track;
|
|
15547
|
+
declare const trackEvent: (eventName: string, name?: string, attributes?: _uipath_core_telemetry.TelemetryAttributes) => void;
|
|
15548
|
+
declare const telemetryClient: {
|
|
15549
|
+
initialize(context?: TelemetryContext): void;
|
|
15550
|
+
};
|
|
14154
15551
|
|
|
14155
|
-
export {
|
|
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 };
|
|
15552
|
+
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 };
|
|
15553
|
+
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, BucketDeleteFileOptions, BucketFile, BucketGetAllOptions, BucketGetByIdOptions, BucketGetByNameOptions, BucketGetFileMetaDataOptions, BucketGetFileMetaDataResponse, BucketGetFileMetaDataWithPaginationOptions, BucketGetFilesOptions, 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, ChoiceSetCreateOptions, ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, ChoiceSetUpdateOptions, ChoiceSetValueInsertOptions, ChoiceSetValueInsertResponse, ChoiceSetValueUpdateResponse, 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, ProcessStartOptions, 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 };
|