@uipath/uipath-typescript 1.3.11 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/dist/agent-memory/index.cjs +1765 -0
  2. package/dist/agent-memory/index.d.ts +588 -0
  3. package/dist/agent-memory/index.mjs +1763 -0
  4. package/dist/agents/index.cjs +1726 -0
  5. package/dist/agents/index.d.ts +502 -0
  6. package/dist/agents/index.mjs +1724 -0
  7. package/dist/assets/index.cjs +155 -30
  8. package/dist/assets/index.d.ts +84 -5
  9. package/dist/assets/index.mjs +155 -30
  10. package/dist/attachments/index.cjs +37 -6
  11. package/dist/attachments/index.d.ts +1 -0
  12. package/dist/attachments/index.mjs +37 -6
  13. package/dist/buckets/index.cjs +37 -6
  14. package/dist/buckets/index.d.ts +1 -0
  15. package/dist/buckets/index.mjs +37 -6
  16. package/dist/cases/index.cjs +141 -10
  17. package/dist/cases/index.d.ts +118 -7
  18. package/dist/cases/index.mjs +141 -11
  19. package/dist/conversational-agent/index.cjs +124 -57
  20. package/dist/conversational-agent/index.d.ts +190 -122
  21. package/dist/conversational-agent/index.mjs +124 -57
  22. package/dist/core/index.cjs +413 -105
  23. package/dist/core/index.d.ts +15 -0
  24. package/dist/core/index.mjs +413 -105
  25. package/dist/entities/index.cjs +122 -43
  26. package/dist/entities/index.d.ts +140 -35
  27. package/dist/entities/index.mjs +122 -43
  28. package/dist/feedback/index.cjs +37 -6
  29. package/dist/feedback/index.d.ts +1 -0
  30. package/dist/feedback/index.mjs +37 -6
  31. package/dist/governance/index.cjs +1782 -0
  32. package/dist/governance/index.d.ts +598 -0
  33. package/dist/governance/index.mjs +1780 -0
  34. package/dist/index.cjs +956 -283
  35. package/dist/index.d.ts +1138 -121
  36. package/dist/index.mjs +956 -284
  37. package/dist/index.umd.js +3113 -2423
  38. package/dist/jobs/index.cjs +37 -6
  39. package/dist/jobs/index.d.ts +1 -0
  40. package/dist/jobs/index.mjs +37 -6
  41. package/dist/maestro-processes/index.cjs +173 -18
  42. package/dist/maestro-processes/index.d.ts +131 -9
  43. package/dist/maestro-processes/index.mjs +173 -18
  44. package/dist/processes/index.cjs +37 -6
  45. package/dist/processes/index.d.ts +1 -0
  46. package/dist/processes/index.mjs +37 -6
  47. package/dist/queues/index.cjs +37 -6
  48. package/dist/queues/index.d.ts +1 -0
  49. package/dist/queues/index.mjs +37 -6
  50. package/dist/tasks/index.cjs +37 -6
  51. package/dist/tasks/index.d.ts +1 -0
  52. package/dist/tasks/index.mjs +37 -6
  53. package/dist/traces/index.cjs +37 -6
  54. package/dist/traces/index.d.ts +1 -0
  55. package/dist/traces/index.mjs +37 -6
  56. package/package.json +32 -2
package/dist/index.d.ts CHANGED
@@ -76,6 +76,11 @@ interface IUiPath {
76
76
  * Get the current authentication token
77
77
  */
78
78
  getToken(): string | undefined;
79
+ /**
80
+ * Releases resources held by this SDK instance.
81
+ * Cancels any in-flight token-refresh request. Call this when the coded app is unmounted.
82
+ */
83
+ destroy(): void;
79
84
  /**
80
85
  * Logout from the SDK, clearing all authentication state.
81
86
  * After calling this method, the user will need to re-initialize to authenticate again.
@@ -159,6 +164,11 @@ declare class UiPath$1 implements IUiPath {
159
164
  * Get the current authentication token
160
165
  */
161
166
  getToken(): string | undefined;
167
+ /**
168
+ * Releases resources held by this SDK instance.
169
+ * Cancels any in-flight token-refresh request. Call this when the coded app is unmounted.
170
+ */
171
+ destroy(): void;
162
172
  /**
163
173
  * Logout from the SDK, clearing all authentication state.
164
174
  * After calling this method, the user will need to re-initialize to authenticate again.
@@ -280,6 +290,7 @@ interface RequestWithPaginationOptions extends RequestSpec {
280
290
  tokenParam?: string;
281
291
  countParam?: string;
282
292
  convertToSkip?: boolean;
293
+ zeroBased?: boolean;
283
294
  };
284
295
  };
285
296
  }
@@ -514,7 +525,7 @@ interface EntityRecord {
514
525
  type EntityGetRecordsByIdOptions = {
515
526
  /** Level of entity expansion (default: 0) */
516
527
  expansionLevel?: number;
517
- } & PaginationOptions;
528
+ } & PaginationOptions & EntityFolderScopedOptions;
518
529
  /**
519
530
  * Options for getting all records of an entity
520
531
  */
@@ -522,14 +533,14 @@ type EntityGetAllRecordsOptions = EntityGetRecordsByIdOptions;
522
533
  /**
523
534
  * Options for getting a single entity record by entity ID and record ID
524
535
  */
525
- interface EntityGetRecordByIdOptions {
536
+ interface EntityGetRecordByIdOptions extends EntityFolderScopedOptions {
526
537
  /** Level of entity expansion (default: 0) */
527
538
  expansionLevel?: number;
528
539
  }
529
540
  /**
530
541
  * Common options for entity operations that modify multiple records
531
542
  */
532
- interface EntityOperationOptions {
543
+ interface EntityOperationOptions extends EntityFolderScopedOptions {
533
544
  /** Level of entity expansion (default: 0) */
534
545
  expansionLevel?: number;
535
546
  /** Whether to fail on first error (default: false) */
@@ -539,7 +550,7 @@ interface EntityOperationOptions {
539
550
  * Options for inserting a single record into an entity
540
551
  * @deprecated Use {@link EntityInsertRecordOptions} instead for better clarity on inserting a single record into an entity. This type will be removed in future versions.
541
552
  */
542
- interface EntityInsertOptions {
553
+ interface EntityInsertOptions extends EntityFolderScopedOptions {
543
554
  /** Level of entity expansion (default: 0) */
544
555
  expansionLevel?: number;
545
556
  }
@@ -579,7 +590,7 @@ interface EntityUpdateRecordsOptions extends EntityOperationOptions {
579
590
  * Options for deleting data from an entity
580
591
  * @deprecated Use {@link EntityDeleteRecordsOptions} instead for better clarity on deleting records from an entity. This type will be removed in future versions.
581
592
  */
582
- interface EntityDeleteOptions {
593
+ interface EntityDeleteOptions extends EntityFolderScopedOptions {
583
594
  /** Whether to fail on first error (default: false) */
584
595
  failOnFirst?: boolean;
585
596
  }
@@ -588,6 +599,16 @@ interface EntityDeleteOptions {
588
599
  */
589
600
  interface EntityDeleteRecordsOptions extends EntityDeleteOptions {
590
601
  }
602
+ /**
603
+ * Options for {@link EntityServiceModel.deleteRecordById}
604
+ */
605
+ interface EntityDeleteRecordByIdOptions extends EntityFolderScopedOptions {
606
+ }
607
+ /**
608
+ * Options for {@link EntityServiceModel.importRecordsById}
609
+ */
610
+ interface EntityImportRecordsByIdOptions extends EntityFolderScopedOptions {
611
+ }
591
612
  /**
592
613
  * Logical operator for combining query filter groups
593
614
  */
@@ -696,7 +717,7 @@ type EntityQueryRecordsOptions = {
696
717
  aggregates?: EntityAggregate[];
697
718
  /** Field names to group aggregate results by. */
698
719
  groupBy?: string[];
699
- } & PaginationOptions;
720
+ } & PaginationOptions & EntityFolderScopedOptions;
700
721
  /**
701
722
  * Response from querying entity records
702
723
  */
@@ -753,16 +774,32 @@ interface EntityCreateFieldOptions extends EntityFieldBase {
753
774
  /** UUID of the referenced field on the target entity (required when `type` is `RELATIONSHIP` or `FILE`) */
754
775
  referenceFieldId?: string;
755
776
  }
777
+ /**
778
+ * Common shape for every folder-scoped Data Fabric entity operation.
779
+ * Forwarded on the wire as the `X-UIPATH-FolderKey` header.
780
+ */
781
+ interface EntityFolderScopedOptions {
782
+ /** Key identifying the folder the entity belongs to. Omit for tenant-level entities. */
783
+ folderKey?: string;
784
+ }
785
+ /**
786
+ * Options for {@link EntityServiceModel.getById}
787
+ */
788
+ interface EntityGetByIdOptions extends EntityFolderScopedOptions {
789
+ }
790
+ /**
791
+ * Options for {@link EntityServiceModel.deleteById}
792
+ */
793
+ interface EntityDeleteByIdOptions extends EntityFolderScopedOptions {
794
+ }
756
795
  /**
757
796
  * Options for creating a new Data Fabric entity
758
797
  */
759
- interface EntityCreateOptions {
798
+ interface EntityCreateOptions extends EntityFolderScopedOptions {
760
799
  /** Human-readable display name shown in the UI (defaults to `name` if omitted) */
761
800
  displayName?: string;
762
801
  /** Optional entity description */
763
802
  description?: string;
764
- /** UUID of the folder to place the entity in (defaults to the tenant-level folder) */
765
- folderKey?: string;
766
803
  /** Whether role-based access control is enabled for this entity (default: false) */
767
804
  isRbacEnabled?: boolean;
768
805
  /** Whether Analytics integration is enabled for this entity (default: false) */
@@ -791,7 +828,7 @@ interface EntityRemoveFieldOptions {
791
828
  * (`displayName`, `description`, `isRbacEnabled`) can be combined; each is applied
792
829
  * only when the corresponding fields are provided.
793
830
  */
794
- interface EntityUpdateByIdOptions {
831
+ interface EntityUpdateByIdOptions extends EntityFolderScopedOptions {
795
832
  /** New fields to add */
796
833
  addFields?: EntityCreateFieldOptions[];
797
834
  /** Fields to remove, each identified by field name */
@@ -823,10 +860,20 @@ type EntityFileType = Blob | File | Uint8Array;
823
860
  /**
824
861
  * Optional options for uploading an attachment to an entity record
825
862
  */
826
- interface EntityUploadAttachmentOptions {
863
+ interface EntityUploadAttachmentOptions extends EntityFolderScopedOptions {
827
864
  /** Optional expansion level (default: 0) */
828
865
  expansionLevel?: number;
829
866
  }
867
+ /**
868
+ * Optional options for downloading an attachment from an entity record
869
+ */
870
+ interface EntityDownloadAttachmentOptions extends EntityFolderScopedOptions {
871
+ }
872
+ /**
873
+ * Optional options for deleting an attachment from an entity record
874
+ */
875
+ interface EntityDeleteAttachmentOptions extends EntityFolderScopedOptions {
876
+ }
830
877
  /**
831
878
  * Response from uploading an attachment to an entity record
832
879
  */
@@ -1126,6 +1173,7 @@ interface EntityServiceModel {
1126
1173
  * Gets entity metadata by entity ID with attached operation methods
1127
1174
  *
1128
1175
  * @param id - UUID of the entity
1176
+ * @param options - Optional {@link EntityGetByIdOptions} (e.g. `folderKey` for folder-scoped entities)
1129
1177
  * @returns Promise resolving to entity metadata with operation methods
1130
1178
  * {@link EntityGetResponse}
1131
1179
  * @example
@@ -1138,6 +1186,9 @@ interface EntityServiceModel {
1138
1186
  * // Get entity metadata with methods
1139
1187
  * const entity = await entities.getById("<entityId>");
1140
1188
  *
1189
+ * // Folder-scoped: pass the entity's folder key
1190
+ * const folderEntity = await entities.getById("<entityId>", { folderKey: "<folderKey>" });
1191
+ *
1141
1192
  * // Call operations directly on the entity
1142
1193
  * const records = await entity.getAllRecords();
1143
1194
  *
@@ -1157,7 +1208,7 @@ interface EntityServiceModel {
1157
1208
  * ]);
1158
1209
  * ```
1159
1210
  */
1160
- getById(id: string): Promise<EntityGetResponse>;
1211
+ getById(id: string, options?: EntityGetByIdOptions): Promise<EntityGetResponse>;
1161
1212
  /**
1162
1213
  * Gets entity records by entity ID
1163
1214
  *
@@ -1361,6 +1412,7 @@ interface EntityServiceModel {
1361
1412
  *
1362
1413
  * @param entityId - UUID of the entity
1363
1414
  * @param recordId - UUID of the record to delete
1415
+ * @param options - Optional {@link EntityDeleteRecordByIdOptions} (e.g. `folderKey` for folder-scoped entities)
1364
1416
  * @returns Promise resolving to void on success
1365
1417
  * @example
1366
1418
  * ```typescript
@@ -1369,9 +1421,12 @@ interface EntityServiceModel {
1369
1421
  * const entities = new Entities(sdk);
1370
1422
  *
1371
1423
  * await entities.deleteRecordById("<entityId>", "<recordId>");
1424
+ *
1425
+ * // Folder-scoped: pass the entity's folder key
1426
+ * await entities.deleteRecordById("<entityId>", "<recordId>", { folderKey: "<folderKey>" });
1372
1427
  * ```
1373
1428
  */
1374
- deleteRecordById(entityId: string, recordId: string): Promise<void>;
1429
+ deleteRecordById(entityId: string, recordId: string, options?: EntityDeleteRecordByIdOptions): Promise<void>;
1375
1430
  /**
1376
1431
  * Queries entity records with filters, sorting, aggregates, and SDK-managed pagination
1377
1432
  *
@@ -1425,6 +1480,7 @@ interface EntityServiceModel {
1425
1480
  *
1426
1481
  * @param id - UUID of the entity
1427
1482
  * @param file - CSV file to import as a Blob or File or Uint8Array
1483
+ * @param options - Optional {@link EntityImportRecordsByIdOptions} (e.g. `folderKey` for folder-scoped entities)
1428
1484
  * @returns Promise resolving to {@link EntityImportRecordsResponse} with record counts
1429
1485
  * @example
1430
1486
  * ```typescript
@@ -1432,16 +1488,19 @@ interface EntityServiceModel {
1432
1488
  * const fileInput = document.getElementById('csv-input') as HTMLInputElement;
1433
1489
  * const result = await entities.importRecordsById(<id>, fileInput.files[0]);
1434
1490
  * console.log(`Inserted ${result.insertedRecords} of ${result.totalRecords} records`);
1491
+ *
1492
+ * // Folder-scoped entity: pass the entity's folder key
1493
+ * await entities.importRecordsById(<id>, fileInput.files[0], { folderKey: "<folderKey>" });
1435
1494
  * ```
1436
- * @internal
1437
1495
  */
1438
- importRecordsById(id: string, file: EntityFileType): Promise<EntityImportRecordsResponse>;
1496
+ importRecordsById(id: string, file: EntityFileType, options?: EntityImportRecordsByIdOptions): Promise<EntityImportRecordsResponse>;
1439
1497
  /**
1440
1498
  * Downloads an attachment stored in a File-type field of an entity record.
1441
1499
  *
1442
1500
  * @param entityId - UUID of the entity
1443
1501
  * @param recordId - UUID of the record containing the attachment
1444
1502
  * @param fieldName - Name of the File-type field containing the attachment
1503
+ * @param options - Optional {@link EntityDownloadAttachmentOptions} (e.g. `folderKey` for folder-scoped entities)
1445
1504
  * @returns Promise resolving to Blob containing the file content
1446
1505
  * @example
1447
1506
  * ```typescript
@@ -1488,7 +1547,7 @@ interface EntityServiceModel {
1488
1547
  * fs.writeFileSync('attachment.pdf', buffer);
1489
1548
  * ```
1490
1549
  */
1491
- downloadAttachment(entityId: string, recordId: string, fieldName: string): Promise<Blob>;
1550
+ downloadAttachment(entityId: string, recordId: string, fieldName: string, options?: EntityDownloadAttachmentOptions): Promise<Blob>;
1492
1551
  /**
1493
1552
  * Uploads an attachment to a File-type field of an entity record.
1494
1553
  *
@@ -1498,7 +1557,7 @@ interface EntityServiceModel {
1498
1557
  * @param recordId - UUID of the record to upload the attachment to
1499
1558
  * @param fieldName - Name of the File-type field
1500
1559
  * @param file - File to upload (Blob, File, or Uint8Array)
1501
- * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel)
1560
+ * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. `expansionLevel`, `folderKey` for folder-scoped entities)
1502
1561
  * @returns Promise resolving to {@link EntityUploadAttachmentResponse}
1503
1562
  * @example
1504
1563
  * ```typescript
@@ -1519,6 +1578,9 @@ interface EntityServiceModel {
1519
1578
  * const file = fileInput.files[0];
1520
1579
  * const response = await entities.uploadAttachment(entityId, recordId, 'Documents', file);
1521
1580
  *
1581
+ * // Folder-scoped entity: pass the entity's folder key
1582
+ * await entities.uploadAttachment(entityId, recordId, 'Documents', file, { folderKey: "<folderKey>" });
1583
+ *
1522
1584
  * // Node.js: Upload a file from disk
1523
1585
  * const fileBuffer = fs.readFileSync('document.pdf');
1524
1586
  * const blob = new Blob([fileBuffer], { type: 'application/pdf' });
@@ -1532,6 +1594,7 @@ interface EntityServiceModel {
1532
1594
  * @param entityId - UUID of the entity
1533
1595
  * @param recordId - UUID of the record containing the attachment
1534
1596
  * @param fieldName - Name of the File-type field containing the attachment
1597
+ * @param options - Optional {@link EntityDeleteAttachmentOptions} (e.g. `folderKey` for folder-scoped entities)
1535
1598
  * @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
1536
1599
  * @example
1537
1600
  * ```typescript
@@ -1555,7 +1618,7 @@ interface EntityServiceModel {
1555
1618
  * await entity.deleteAttachment(recordId, 'Documents');
1556
1619
  * ```
1557
1620
  */
1558
- deleteAttachment(entityId: string, recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
1621
+ deleteAttachment(entityId: string, recordId: string, fieldName: string, options?: EntityDeleteAttachmentOptions): Promise<EntityDeleteAttachmentResponse>;
1559
1622
  /**
1560
1623
  * Creates a new Data Fabric entity with the given schema
1561
1624
  *
@@ -1589,14 +1652,18 @@ interface EntityServiceModel {
1589
1652
  * Deletes a Data Fabric entity and all its records
1590
1653
  *
1591
1654
  * @param id - UUID of the entity to delete
1655
+ * @param options - Optional {@link EntityDeleteByIdOptions} (e.g. `folderKey` for folder-scoped entities)
1592
1656
  * @returns Promise resolving when the entity is deleted
1593
1657
  * @example
1594
1658
  * ```typescript
1595
1659
  * await entities.deleteById(<id>);
1660
+ *
1661
+ * // Folder-scoped: pass the entity's folder key
1662
+ * await entities.deleteById(<id>, { folderKey: "<folderKey>" });
1596
1663
  * ```
1597
1664
  * @internal
1598
1665
  */
1599
- deleteById(id: string): Promise<void>;
1666
+ deleteById(id: string, options?: EntityDeleteByIdOptions): Promise<void>;
1600
1667
  /**
1601
1668
  * Updates an existing Data Fabric entity — schema and/or metadata.
1602
1669
  *
@@ -1605,7 +1672,6 @@ interface EntityServiceModel {
1605
1672
  * only when the corresponding fields are provided.
1606
1673
  *
1607
1674
  * @param id - UUID of the entity to update
1608
- * @param name - name of the entity (required by the API)
1609
1675
  * @param options - Changes to apply ({@link EntityUpdateByIdOptions})
1610
1676
  * @returns Promise resolving when the update is complete
1611
1677
  *
@@ -1639,6 +1705,12 @@ interface EntityServiceModel {
1639
1705
  * { id: <fieldId>, lengthLimit: 1000 },
1640
1706
  * ],
1641
1707
  * });
1708
+ *
1709
+ * // Folder-scoped entity: add a field to an entity that lives in a non-tenant folder
1710
+ * await entities.updateById(<id>, {
1711
+ * folderKey: "<folderKey>",
1712
+ * addFields: [{ fieldName: "notes", type: EntityFieldDataType.MULTILINE_TEXT }],
1713
+ * });
1642
1714
  * ```
1643
1715
  * @internal
1644
1716
  */
@@ -1711,9 +1783,10 @@ interface EntityMethods {
1711
1783
  * Use this method if you need trigger events to fire for the deleted record.
1712
1784
  *
1713
1785
  * @param recordId - UUID of the record to delete
1786
+ * @param options - Optional {@link EntityDeleteRecordByIdOptions} (e.g. `folderKey` for folder-scoped entities)
1714
1787
  * @returns Promise resolving to void on success
1715
1788
  */
1716
- deleteRecord(recordId: string): Promise<void>;
1789
+ deleteRecord(recordId: string, options?: EntityDeleteRecordByIdOptions): Promise<void>;
1717
1790
  /**
1718
1791
  * Get all records from this entity
1719
1792
  *
@@ -1734,16 +1807,17 @@ interface EntityMethods {
1734
1807
  *
1735
1808
  * @param recordId - UUID of the record containing the attachment
1736
1809
  * @param fieldName - Name of the File-type field containing the attachment
1810
+ * @param options - Optional {@link EntityDownloadAttachmentOptions} (e.g. folderKey)
1737
1811
  * @returns Promise resolving to Blob containing the file content
1738
1812
  */
1739
- downloadAttachment(recordId: string, fieldName: string): Promise<Blob>;
1813
+ downloadAttachment(recordId: string, fieldName: string, options?: EntityDownloadAttachmentOptions): Promise<Blob>;
1740
1814
  /**
1741
1815
  * Uploads an attachment to a File-type field of an entity record
1742
1816
  *
1743
1817
  * @param recordId - UUID of the record to upload the attachment to
1744
1818
  * @param fieldName - Name of the File-type field
1745
1819
  * @param file - File to upload (Blob, File, or Uint8Array)
1746
- * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel)
1820
+ * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel, folderKey)
1747
1821
  * @returns Promise resolving to {@link EntityUploadAttachmentResponse}
1748
1822
  */
1749
1823
  uploadAttachment(recordId: string, fieldName: string, file: EntityFileType, options?: EntityUploadAttachmentOptions): Promise<EntityUploadAttachmentResponse>;
@@ -1752,9 +1826,10 @@ interface EntityMethods {
1752
1826
  *
1753
1827
  * @param recordId - UUID of the record containing the attachment
1754
1828
  * @param fieldName - Name of the File-type field containing the attachment
1829
+ * @param options - Optional {@link EntityDeleteAttachmentOptions} (e.g. folderKey)
1755
1830
  * @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
1756
1831
  */
1757
- deleteAttachment(recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
1832
+ deleteAttachment(recordId: string, fieldName: string, options?: EntityDeleteAttachmentOptions): Promise<EntityDeleteAttachmentResponse>;
1758
1833
  /**
1759
1834
  * @deprecated Use {@link insertRecord} instead.
1760
1835
  * @hidden
@@ -1810,6 +1885,7 @@ interface EntityMethods {
1810
1885
  * Imports records from a CSV file into this entity
1811
1886
  *
1812
1887
  * @param file - CSV file to import as a Blob, File, or Uint8Array
1888
+ * @param options - Optional {@link EntityImportRecordsByIdOptions} (e.g. `folderKey` for folder-scoped entities)
1813
1889
  * @returns Promise resolving to {@link EntityImportRecordsResponse} with record counts
1814
1890
  * @example
1815
1891
  * ```typescript
@@ -1817,9 +1893,12 @@ interface EntityMethods {
1817
1893
  * const fileInput = document.getElementById('csv-input') as HTMLInputElement;
1818
1894
  * const result = await entity.importRecords(fileInput.files[0]);
1819
1895
  * console.log(`Inserted ${result.insertedRecords} of ${result.totalRecords} records`);
1896
+ *
1897
+ * // Folder-scoped entity: pass the entity's folder key
1898
+ * await entity.importRecords(fileInput.files[0], { folderKey: "<folderKey>" });
1820
1899
  * ```
1821
1900
  */
1822
- importRecords(file: EntityFileType): Promise<EntityImportRecordsResponse>;
1901
+ importRecords(file: EntityFileType, options?: EntityImportRecordsByIdOptions): Promise<EntityImportRecordsResponse>;
1823
1902
  /**
1824
1903
  * @deprecated Use {@link getAllRecords} instead.
1825
1904
  * @hidden
@@ -1828,15 +1907,19 @@ interface EntityMethods {
1828
1907
  /**
1829
1908
  * Deletes this entity and all its records
1830
1909
  *
1910
+ * @param options - Optional {@link EntityDeleteByIdOptions} (e.g. `folderKey` for folder-scoped entities)
1831
1911
  * @returns Promise resolving when the entity is deleted
1832
1912
  * @example
1833
1913
  * ```typescript
1834
1914
  * const entity = await entities.getById(<id>);
1835
1915
  * await entity.delete();
1916
+ *
1917
+ * // Folder-scoped entity: pass the entity's folder key
1918
+ * await entity.delete({ folderKey: "<folderKey>" });
1836
1919
  * ```
1837
1920
  * @internal
1838
1921
  */
1839
- delete(): Promise<void>;
1922
+ delete(options?: EntityDeleteByIdOptions): Promise<void>;
1840
1923
  /**
1841
1924
  * Updates this entity — schema and/or metadata.
1842
1925
  *
@@ -1883,6 +1966,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
1883
1966
  * Gets entity metadata by entity ID with attached operation methods
1884
1967
  *
1885
1968
  * @param id - UUID of the entity
1969
+ * @param options - Optional {@link EntityGetByIdOptions} (e.g. `folderKey` for folder-scoped entities)
1886
1970
  * @returns Promise resolving to entity metadata with schema information and operation methods
1887
1971
  *
1888
1972
  * @example
@@ -1892,6 +1976,9 @@ declare class EntityService extends BaseService implements EntityServiceModel {
1892
1976
  * const entities = new Entities(sdk);
1893
1977
  * const entity = await entities.getById("<entityId>");
1894
1978
  *
1979
+ * // Folder-scoped: pass the entity's folder key
1980
+ * const folderEntity = await entities.getById("<entityId>", { folderKey: "<folderKey>" });
1981
+ *
1895
1982
  * // Call operations directly on the entity
1896
1983
  * const records = await entity.getAllRecords();
1897
1984
  *
@@ -1905,7 +1992,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
1905
1992
  * ]);
1906
1993
  * ```
1907
1994
  */
1908
- getById(id: string): Promise<EntityGetResponse>;
1995
+ getById(id: string, options?: EntityGetByIdOptions): Promise<EntityGetResponse>;
1909
1996
  /**
1910
1997
  * Gets entity records by entity ID
1911
1998
  *
@@ -2104,6 +2191,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2104
2191
  *
2105
2192
  * @param entityId - UUID of the entity
2106
2193
  * @param recordId - UUID of the record to delete
2194
+ * @param options - Optional {@link EntityDeleteRecordByIdOptions} (e.g. `folderKey` for folder-scoped entities)
2107
2195
  * @returns Promise resolving to void on success
2108
2196
  * @example
2109
2197
  * ```typescript
@@ -2112,9 +2200,12 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2112
2200
  * const entities = new Entities(sdk);
2113
2201
  *
2114
2202
  * await entities.deleteRecordById("<entityId>", "<recordId>");
2203
+ *
2204
+ * // Folder-scoped: pass the entity's folder key
2205
+ * await entities.deleteRecordById("<entityId>", "<recordId>", { folderKey: "<folderKey>" });
2115
2206
  * ```
2116
2207
  */
2117
- deleteRecordById(entityId: string, recordId: string): Promise<void>;
2208
+ deleteRecordById(entityId: string, recordId: string, options?: EntityDeleteRecordByIdOptions): Promise<void>;
2118
2209
  /**
2119
2210
  * Gets all entities in the system
2120
2211
  *
@@ -2193,6 +2284,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2193
2284
  *
2194
2285
  * @param id - UUID of the entity
2195
2286
  * @param file - CSV file to import (Blob, File, or Uint8Array)
2287
+ * @param options - Optional {@link EntityImportRecordsByIdOptions} (e.g. `folderKey` for folder-scoped entities)
2196
2288
  * @returns Promise resolving to import result with record counts
2197
2289
  *
2198
2290
  * @example
@@ -2213,16 +2305,19 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2213
2305
  * if (result.errorFileLink) {
2214
2306
  * console.log(`Error file link: ${result.errorFileLink}`);
2215
2307
  * }
2308
+ *
2309
+ * // Folder-scoped entity: pass the entity's folder key
2310
+ * await entities.importRecordsById("<entityId>", fileInput.files[0], { folderKey: "<folderKey>" });
2216
2311
  * ```
2217
- * @internal
2218
2312
  */
2219
- importRecordsById(id: string, file: EntityFileType): Promise<EntityImportRecordsResponse>;
2313
+ importRecordsById(id: string, file: EntityFileType, options?: EntityImportRecordsByIdOptions): Promise<EntityImportRecordsResponse>;
2220
2314
  /**
2221
2315
  * Downloads an attachment from an entity record field
2222
2316
  *
2223
2317
  * @param entityId - UUID of the entity
2224
2318
  * @param recordId - UUID of the record containing the attachment
2225
2319
  * @param fieldName - Name of the File-type field containing the attachment
2320
+ * @param options - Optional {@link EntityDownloadAttachmentOptions} (e.g. `folderKey` for folder-scoped entities)
2226
2321
  * @returns Promise resolving to Blob containing the file content
2227
2322
  *
2228
2323
  * @example
@@ -2241,9 +2336,12 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2241
2336
  *
2242
2337
  * // Download attachment for a specific record and field
2243
2338
  * const blob = await entities.downloadAttachment(entityId, recordId, 'Documents');
2339
+ *
2340
+ * // Folder-scoped: pass the entity's folder key
2341
+ * const blob = await entities.downloadAttachment(entityId, recordId, 'Documents', { folderKey: "<folderKey>" });
2244
2342
  * ```
2245
2343
  */
2246
- downloadAttachment(entityId: string, recordId: string, fieldName: string): Promise<Blob>;
2344
+ downloadAttachment(entityId: string, recordId: string, fieldName: string, options?: EntityDownloadAttachmentOptions): Promise<Blob>;
2247
2345
  /**
2248
2346
  * Uploads an attachment to a File-type field of an entity record
2249
2347
  *
@@ -2251,7 +2349,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2251
2349
  * @param recordId - UUID of the record to upload the attachment to
2252
2350
  * @param fieldName - Name of the File-type field
2253
2351
  * @param file - File to upload (Blob, File, or Uint8Array)
2254
- * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel)
2352
+ * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. `expansionLevel`, `folderKey` for folder-scoped entities)
2255
2353
  * @returns Promise resolving to {@link EntityUploadAttachmentResponse}
2256
2354
  *
2257
2355
  * @example
@@ -2270,6 +2368,9 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2270
2368
  *
2271
2369
  * // Upload a file attachment
2272
2370
  * const response = await entities.uploadAttachment(entityId, recordId, 'Documents', file);
2371
+ *
2372
+ * // Folder-scoped entity: pass the entity's folder key
2373
+ * await entities.uploadAttachment(entityId, recordId, 'Documents', file, { folderKey: "<folderKey>" });
2273
2374
  * ```
2274
2375
  */
2275
2376
  uploadAttachment(entityId: string, recordId: string, fieldName: string, file: EntityFileType, options?: EntityUploadAttachmentOptions): Promise<EntityUploadAttachmentResponse>;
@@ -2279,6 +2380,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2279
2380
  * @param entityId - UUID of the entity
2280
2381
  * @param recordId - UUID of the record containing the attachment
2281
2382
  * @param fieldName - Name of the File-type field containing the attachment
2383
+ * @param options - Optional {@link EntityDeleteAttachmentOptions} (e.g. `folderKey` for folder-scoped entities)
2282
2384
  * @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
2283
2385
  *
2284
2386
  * @example
@@ -2297,9 +2399,12 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2297
2399
  *
2298
2400
  * // Delete attachment for a specific record and field
2299
2401
  * await entities.deleteAttachment(entityId, recordId, 'Documents');
2402
+ *
2403
+ * // Folder-scoped: pass the entity's folder key
2404
+ * await entities.deleteAttachment(entityId, recordId, 'Documents', { folderKey: "<folderKey>" });
2300
2405
  * ```
2301
2406
  */
2302
- deleteAttachment(entityId: string, recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
2407
+ deleteAttachment(entityId: string, recordId: string, fieldName: string, options?: EntityDeleteAttachmentOptions): Promise<EntityDeleteAttachmentResponse>;
2303
2408
  /**
2304
2409
  * @hidden
2305
2410
  * @deprecated Use {@link getAllRecords} instead.
@@ -2345,15 +2450,19 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2345
2450
  * Deletes a Data Fabric entity and all its records
2346
2451
  *
2347
2452
  * @param id - UUID of the entity to delete
2453
+ * @param options - Optional {@link EntityDeleteByIdOptions} (e.g. `folderKey` for folder-scoped entities)
2348
2454
  * @returns Promise resolving when the entity is deleted
2349
2455
  *
2350
2456
  * @example
2351
2457
  * ```typescript
2352
2458
  * await entities.deleteById("<entityId>");
2459
+ *
2460
+ * // Folder-scoped: pass the entity's folder key
2461
+ * await entities.deleteById("<entityId>", { folderKey: "<folderKey>" });
2353
2462
  * ```
2354
2463
  * @internal
2355
2464
  */
2356
- deleteById(id: string): Promise<void>;
2465
+ deleteById(id: string, options?: EntityDeleteByIdOptions): Promise<void>;
2357
2466
  /**
2358
2467
  * Updates an existing Data Fabric entity — schema and/or metadata.
2359
2468
  *
@@ -2399,6 +2508,12 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2399
2508
  * { id: "<fieldId>", lengthLimit: 1000 },
2400
2509
  * ],
2401
2510
  * });
2511
+ *
2512
+ * // Folder-scoped entity: add a field to an entity that lives in a non-tenant folder
2513
+ * await entities.updateById("<entityId>", {
2514
+ * folderKey: "<folderKey>",
2515
+ * addFields: [{ fieldName: "notes", type: EntityFieldDataType.MULTILINE_TEXT }],
2516
+ * });
2402
2517
  * ```
2403
2518
  * @internal
2404
2519
  */
@@ -3079,6 +3194,35 @@ interface GetTopDurationResponse extends GetTopBaseResponse {
3079
3194
  /** Total execution duration in milliseconds */
3080
3195
  duration: number;
3081
3196
  }
3197
+ /**
3198
+ * Element count by status for a BPMN element within a process or case
3199
+ */
3200
+ interface ElementStats {
3201
+ /** BPMN element identifier */
3202
+ elementId: string;
3203
+ /** Number of successful executions */
3204
+ successCount: number;
3205
+ /** Number of failed executions */
3206
+ failCount: number;
3207
+ /** Number of terminated executions */
3208
+ terminatedCount: number;
3209
+ /** Number of paused executions */
3210
+ pausedCount: number;
3211
+ /** Number of in-progress executions */
3212
+ inProgressCount: number;
3213
+ /** Minimum duration in milliseconds */
3214
+ minDurationMs: number;
3215
+ /** Maximum duration in milliseconds */
3216
+ maxDurationMs: number;
3217
+ /** Average duration in milliseconds */
3218
+ avgDurationMs: number;
3219
+ /** 50th percentile (median) duration in milliseconds */
3220
+ p50DurationMs: number;
3221
+ /** 95th percentile duration in milliseconds */
3222
+ p95DurationMs: number;
3223
+ /** 99th percentile duration in milliseconds */
3224
+ p99DurationMs: number;
3225
+ }
3082
3226
 
3083
3227
  /**
3084
3228
  * Maestro Process Types
@@ -3465,6 +3609,38 @@ interface MaestroProcessesServiceModel {
3465
3609
  * ```
3466
3610
  */
3467
3611
  getTopExecutionDuration(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopDurationResponse[]>;
3612
+ /**
3613
+ * Get element stats for process instances
3614
+ *
3615
+ * Returns per-element execution counts (success, fail, terminated, paused, in-progress) and
3616
+ * duration percentile metrics (min, max, avg, p50, p95, p99) for BPMN elements within a process.
3617
+ *
3618
+ * @param processKey - Process key to filter by
3619
+ * @param packageId - Package identifier
3620
+ * @param startTime - Start of the time range to query
3621
+ * @param endTime - End of the time range to query
3622
+ * @param packageVersion - Package version to filter by
3623
+ * @returns Promise resolving to an array of {@link ElementStats}
3624
+ * @example
3625
+ * ```typescript
3626
+ * // Get element metrics for a process
3627
+ * const elements = await maestroProcesses.getElementStats(
3628
+ * '<processKey>',
3629
+ * '<packageId>',
3630
+ * new Date('2026-04-01'),
3631
+ * new Date(),
3632
+ * '1.0.1'
3633
+ * );
3634
+ *
3635
+ * // Analyze element performance
3636
+ * for (const element of elements) {
3637
+ * console.log(`Element: ${element.elementId}`);
3638
+ * console.log(` Success: ${element.successCount}, Failed: ${element.failCount}`);
3639
+ * console.log(` Avg duration: ${element.avgDurationMs}ms, P95: ${element.p95DurationMs}ms`);
3640
+ * }
3641
+ * ```
3642
+ */
3643
+ getElementStats(processKey: string, packageId: string, startTime: Date, endTime: Date, packageVersion: string): Promise<ElementStats[]>;
3468
3644
  }
3469
3645
  interface ProcessMethods {
3470
3646
  /**
@@ -3473,6 +3649,15 @@ interface ProcessMethods {
3473
3649
  * @returns Promise resolving to array of process incidents
3474
3650
  */
3475
3651
  getIncidents(): Promise<ProcessIncidentGetResponse[]>;
3652
+ /**
3653
+ * Get element stats for this process
3654
+ *
3655
+ * @param startTime - Start of the time range to query
3656
+ * @param endTime - End of the time range to query
3657
+ * @param packageVersion - Package version to filter by
3658
+ * @returns Promise resolving to an array of {@link ElementStats}
3659
+ */
3660
+ getElementStats(startTime: Date, endTime: Date, packageVersion: string): Promise<ElementStats[]>;
3476
3661
  }
3477
3662
  type MaestroProcessGetAllResponse = RawMaestroProcessGetAllResponse & ProcessMethods;
3478
3663
  /**
@@ -3565,8 +3750,7 @@ interface ProcessInstanceExecutionHistoryResponse {
3565
3750
  startedTime: string;
3566
3751
  endTime: string | null;
3567
3752
  attributes: string | null;
3568
- createdTime: string;
3569
- updatedTime?: string;
3753
+ updatedTime: string;
3570
3754
  expiredTime: string | null;
3571
3755
  }
3572
3756
  /**
@@ -3755,24 +3939,26 @@ interface ProcessInstancesServiceModel {
3755
3939
  /**
3756
3940
  * Get execution history (spans) for a process instance
3757
3941
  * @param instanceId The ID of the instance to get history for
3942
+ * @param folderKey The folder key for authorization
3758
3943
  * @returns Promise resolving to execution history
3759
3944
  * {@link ProcessInstanceExecutionHistoryResponse}
3760
3945
  * @example
3761
3946
  * ```typescript
3762
3947
  * // Get execution history for a process instance
3763
3948
  * const history = await processInstances.getExecutionHistory(
3764
- * <instanceId>
3949
+ * <instanceId>,
3950
+ * <folderKey>
3765
3951
  * );
3766
3952
  *
3767
3953
  * // Analyze execution timeline
3768
3954
  * history.forEach(span => {
3769
3955
  * console.log(`Activity: ${span.name}`);
3770
- * console.log(`Start: ${span.startTime}`);
3771
- * console.log(`Duration: ${span.duration}ms`);
3956
+ * console.log(`Start: ${span.startedTime}`);
3957
+ * console.log(`End: ${span.endTime}`);
3772
3958
  * });
3773
3959
  * ```
3774
3960
  */
3775
- getExecutionHistory(instanceId: string): Promise<ProcessInstanceExecutionHistoryResponse[]>;
3961
+ getExecutionHistory(instanceId: string, folderKey: string): Promise<ProcessInstanceExecutionHistoryResponse[]>;
3776
3962
  /**
3777
3963
  * Get BPMN XML file for a process instance
3778
3964
  * @param instanceId The ID of the instance to get BPMN for
@@ -4088,8 +4274,7 @@ interface CaseGetTopDurationResponse extends GetTopDurationResponse {
4088
4274
  */
4089
4275
  interface CasesServiceModel {
4090
4276
  /**
4091
- * @returns Promise resolving to array of Case objects
4092
- * {@link CaseGetAllResponse}
4277
+ * @returns Promise resolving to an array of {@link CaseGetAllWithMethodsResponse}
4093
4278
  * @example
4094
4279
  * ```typescript
4095
4280
  * // Get all case management processes
@@ -4103,7 +4288,7 @@ interface CasesServiceModel {
4103
4288
  * }
4104
4289
  * ```
4105
4290
  */
4106
- getAll(): Promise<CaseGetAllResponse[]>;
4291
+ getAll(): Promise<CaseGetAllWithMethodsResponse[]>;
4107
4292
  /**
4108
4293
  * Get the top 5 case processes ranked by run count within a time range.
4109
4294
  *
@@ -4297,7 +4482,58 @@ interface CasesServiceModel {
4297
4482
  * ```
4298
4483
  */
4299
4484
  getTopExecutionDuration(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopDurationResponse[]>;
4485
+ /**
4486
+ * Get element stats for case instances
4487
+ *
4488
+ * Returns per-element execution counts (success, fail, terminated, paused, in-progress) and
4489
+ * duration percentile metrics (min, max, avg, p50, p95, p99) for BPMN elements within a case.
4490
+ *
4491
+ * @param processKey - Process key to filter by
4492
+ * @param packageId - Package identifier
4493
+ * @param startTime - Start of the time range to query
4494
+ * @param endTime - End of the time range to query
4495
+ * @param packageVersion - Package version to filter by
4496
+ * @returns Promise resolving to an array of {@link ElementStats}
4497
+ * @example
4498
+ * ```typescript
4499
+ * // Get element metrics for a case
4500
+ * const elements = await cases.getElementStats(
4501
+ * '<processKey>',
4502
+ * '<packageId>',
4503
+ * new Date('2026-04-01'),
4504
+ * new Date(),
4505
+ * '1.0.1'
4506
+ * );
4507
+ *
4508
+ * // Find elements with failures
4509
+ * const failedElements = elements.filter(e => e.failCount > 0);
4510
+ * for (const element of failedElements) {
4511
+ * console.log(`Failed element: ${element.elementId}, failures: ${element.failCount}`);
4512
+ * }
4513
+ * ```
4514
+ */
4515
+ getElementStats(processKey: string, packageId: string, startTime: Date, endTime: Date, packageVersion: string): Promise<ElementStats[]>;
4516
+ }
4517
+ interface CaseMethods {
4518
+ /**
4519
+ * Get element stats for this case
4520
+ *
4521
+ * @param startTime - Start of the time range to query
4522
+ * @param endTime - End of the time range to query
4523
+ * @param packageVersion - Package version to filter by
4524
+ * @returns Promise resolving to an array of {@link ElementStats}
4525
+ */
4526
+ getElementStats(startTime: Date, endTime: Date, packageVersion: string): Promise<ElementStats[]>;
4300
4527
  }
4528
+ type CaseGetAllWithMethodsResponse = CaseGetAllResponse & CaseMethods;
4529
+ /**
4530
+ * Creates an actionable case by combining API case data with operational methods.
4531
+ *
4532
+ * @param caseData - The case data from API
4533
+ * @param service - The cases service instance
4534
+ * @returns A case object with added methods
4535
+ */
4536
+ declare function createCaseWithMethods(caseData: CaseGetAllResponse, service: CasesServiceModel): CaseGetAllWithMethodsResponse;
4301
4537
 
4302
4538
  /**
4303
4539
  * Case Instance Types
@@ -5819,6 +6055,38 @@ declare class MaestroProcessesService extends BaseService implements MaestroProc
5819
6055
  * ```
5820
6056
  */
5821
6057
  getTopExecutionDuration(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopDurationResponse[]>;
6058
+ /**
6059
+ * Get element stats for process instances
6060
+ *
6061
+ * Returns per-element execution counts (success, fail, terminated, paused, in-progress) and
6062
+ * duration percentile metrics (min, max, avg, p50, p95, p99) for BPMN elements within a process.
6063
+ *
6064
+ * @param processKey - Process key to filter by
6065
+ * @param packageId - Package identifier
6066
+ * @param startTime - Start of the time range to query
6067
+ * @param endTime - End of the time range to query
6068
+ * @param packageVersion - Package version to filter by
6069
+ * @returns Promise resolving to an array of {@link ElementStats}
6070
+ * @example
6071
+ * ```typescript
6072
+ * // Get element metrics for a process
6073
+ * const elements = await maestroProcesses.getElementStats(
6074
+ * '<processKey>',
6075
+ * '<packageId>',
6076
+ * new Date('2026-04-01'),
6077
+ * new Date(),
6078
+ * '1.0.1'
6079
+ * );
6080
+ *
6081
+ * // Analyze element performance
6082
+ * for (const element of elements) {
6083
+ * console.log(`Element: ${element.elementId}`);
6084
+ * console.log(` Success: ${element.successCount}, Failed: ${element.failCount}`);
6085
+ * console.log(` Avg duration: ${element.avgDurationMs}ms, P95: ${element.p95DurationMs}ms`);
6086
+ * }
6087
+ * ```
6088
+ */
6089
+ getElementStats(processKey: string, packageId: string, startTime: Date, endTime: Date, packageVersion: string): Promise<ElementStats[]>;
5822
6090
  }
5823
6091
 
5824
6092
  declare class ProcessInstancesService extends BaseService implements ProcessInstancesServiceModel {
@@ -5873,9 +6141,27 @@ declare class ProcessInstancesService extends BaseService implements ProcessInst
5873
6141
  /**
5874
6142
  * Get execution history (spans) for a process instance
5875
6143
  * @param instanceId The ID of the instance to get history for
5876
- * @returns Promise<ProcessInstanceExecutionHistoryResponse[]>
6144
+ * @param folderKey The folder key for authorization
6145
+ * @returns Promise resolving to execution history
6146
+ * {@link ProcessInstanceExecutionHistoryResponse}
6147
+ * @example
6148
+ * ```typescript
6149
+ * // Get execution history for a process instance
6150
+ * const history = await processInstances.getExecutionHistory(
6151
+ * <instanceId>,
6152
+ * <folderKey>
6153
+ * );
6154
+ *
6155
+ * // Analyze execution timeline
6156
+ * history.forEach(span => {
6157
+ * console.log(`Activity: ${span.name}`);
6158
+ * console.log(`Start: ${span.startedTime}`);
6159
+ * console.log(`End: ${span.endTime}`);
6160
+ * });
6161
+ * ```
5877
6162
  */
5878
- getExecutionHistory(instanceId: string): Promise<ProcessInstanceExecutionHistoryResponse[]>;
6163
+ getExecutionHistory(instanceId: string, folderKey: string): Promise<ProcessInstanceExecutionHistoryResponse[]>;
6164
+ private mapSpanToHistory;
5879
6165
  /**
5880
6166
  * Get BPMN XML file for a process instance
5881
6167
  * @param instanceId The ID of the instance to get BPMN for
@@ -5980,7 +6266,7 @@ declare class ProcessIncidentsService extends BaseService implements ProcessInci
5980
6266
  declare class CasesService extends BaseService implements CasesServiceModel {
5981
6267
  /**
5982
6268
  * Get all case management processes with their instance statistics
5983
- * @returns Promise resolving to array of Case objects
6269
+ * @returns Promise resolving to an array of {@link CaseGetAllWithMethodsResponse}
5984
6270
  *
5985
6271
  * @example
5986
6272
  * ```typescript
@@ -5997,7 +6283,7 @@ declare class CasesService extends BaseService implements CasesServiceModel {
5997
6283
  * }
5998
6284
  * ```
5999
6285
  */
6000
- getAll(): Promise<CaseGetAllResponse[]>;
6286
+ getAll(): Promise<CaseGetAllWithMethodsResponse[]>;
6001
6287
  /**
6002
6288
  * Get the top 5 case processes ranked by run count within a time range.
6003
6289
  *
@@ -6191,6 +6477,37 @@ declare class CasesService extends BaseService implements CasesServiceModel {
6191
6477
  * ```
6192
6478
  */
6193
6479
  getTopExecutionDuration(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopDurationResponse[]>;
6480
+ /**
6481
+ * Get element stats for case instances
6482
+ *
6483
+ * Returns per-element execution counts (success, fail, terminated, paused, in-progress) and
6484
+ * duration percentile metrics (min, max, avg, p50, p95, p99) for BPMN elements within a case.
6485
+ *
6486
+ * @param processKey - Process key to filter by
6487
+ * @param packageId - Package identifier
6488
+ * @param startTime - Start of the time range to query
6489
+ * @param endTime - End of the time range to query
6490
+ * @param packageVersion - Package version to filter by
6491
+ * @returns Promise resolving to an array of {@link ElementStats}
6492
+ * @example
6493
+ * ```typescript
6494
+ * // Get element metrics for a case
6495
+ * const elements = await cases.getElementStats(
6496
+ * '<processKey>',
6497
+ * '<packageId>',
6498
+ * new Date('2026-04-01'),
6499
+ * new Date(),
6500
+ * '1.0.1'
6501
+ * );
6502
+ *
6503
+ * // Find elements with failures
6504
+ * const failedElements = elements.filter(e => e.failCount > 0);
6505
+ * for (const element of failedElements) {
6506
+ * console.log(`Failed element: ${element.elementId}, failures: ${element.failCount}`);
6507
+ * }
6508
+ * ```
6509
+ */
6510
+ getElementStats(processKey: string, packageId: string, startTime: Date, endTime: Date, packageVersion: string): Promise<ElementStats[]>;
6194
6511
  /**
6195
6512
  * Extract a readable case name from the packageId
6196
6513
  * @param packageId - The full package identifier
@@ -6505,14 +6822,10 @@ declare enum AssetValueScope {
6505
6822
  * Enum for Asset Value Type
6506
6823
  */
6507
6824
  declare enum AssetValueType {
6508
- DBConnectionString = "DBConnectionString",
6509
- HttpConnectionString = "HttpConnectionString",
6510
6825
  Text = "Text",
6511
6826
  Bool = "Bool",
6512
6827
  Integer = "Integer",
6513
6828
  Credential = "Credential",
6514
- WindowsCredential = "WindowsCredential",
6515
- KeyValueList = "KeyValueList",
6516
6829
  Secret = "Secret"
6517
6830
  }
6518
6831
  /**
@@ -6562,6 +6875,20 @@ interface AssetGetByIdOptions extends BaseOptions {
6562
6875
  */
6563
6876
  interface AssetGetByNameOptions extends FolderScopedOptions {
6564
6877
  }
6878
+ /**
6879
+ * New value accepted by {@link AssetServiceModel.updateValueById}.
6880
+ *
6881
+ * The runtime type must match the asset's `valueType`:
6882
+ * - `Text` → `string`
6883
+ * - `Integer` → `number`
6884
+ * - `Bool` → `boolean`
6885
+ */
6886
+ type AssetNewValue = string | number | boolean;
6887
+ /**
6888
+ * Options for updating an asset value by ID
6889
+ */
6890
+ interface AssetUpdateValueByIdOptions extends FolderScopedOptions {
6891
+ }
6565
6892
 
6566
6893
  /**
6567
6894
  * Service for managing UiPath Assets.
@@ -6646,6 +6973,38 @@ interface AssetServiceModel {
6646
6973
  * ```
6647
6974
  */
6648
6975
  getByName(name: string, options?: AssetGetByNameOptions): Promise<AssetGetResponse>;
6976
+ /**
6977
+ * Updates the value of an existing asset by ID.
6978
+ *
6979
+ * Fetches the asset internally to determine its type, then updates only the value while
6980
+ * preserving the asset's name, scope, and description.
6981
+ *
6982
+ * **Supported value types:** `Text`, `Integer`, and `Bool` only. Other types
6983
+ * (`Credential`, `Secret`) throw a `ValidationError`.
6984
+ *
6985
+ * The `newValue` runtime type must match the asset's `valueType`:
6986
+ * - `Text` → `string`
6987
+ * - `Integer` → `number` (integer)
6988
+ * - `Bool` → `boolean`
6989
+ *
6990
+ * @param id - Asset ID
6991
+ * @param newValue - New value to apply (string for `Text`, number for `Integer`, boolean for `Bool`)
6992
+ * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`)
6993
+ * @returns Promise resolving when the asset has been updated
6994
+ *
6995
+ * @example
6996
+ * ```typescript
6997
+ * // Update a Text asset by folder ID
6998
+ * await assets.updateValueById(<assetId>, 'new-value', { folderId: <folderId> });
6999
+ *
7000
+ * // Update an Integer asset by folder key (GUID)
7001
+ * await assets.updateValueById(<assetId>, 42, { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
7002
+ *
7003
+ * // Update a Bool asset by folder path
7004
+ * await assets.updateValueById(<assetId>, true, { folderPath: 'Shared/Finance' });
7005
+ * ```
7006
+ */
7007
+ updateValueById(id: number, newValue: AssetNewValue, options?: AssetUpdateValueByIdOptions): Promise<void>;
6649
7008
  }
6650
7009
 
6651
7010
  /**
@@ -6733,6 +7092,42 @@ declare class AssetService extends FolderScopedService implements AssetServiceMo
6733
7092
  * ```
6734
7093
  */
6735
7094
  getByName(name: string, options?: AssetGetByNameOptions): Promise<AssetGetResponse>;
7095
+ /**
7096
+ * Updates the value of an existing asset by ID.
7097
+ *
7098
+ * Fetches the asset internally to determine its type, then updates only the value while
7099
+ * preserving the asset's name, scope, and description.
7100
+ *
7101
+ * **Supported value types:** `Text`, `Integer`, and `Bool` only. Other types
7102
+ * (`Credential`, `Secret`) throw a `ValidationError`.
7103
+ *
7104
+ * The `newValue` runtime type must match the asset's `valueType`:
7105
+ * - `Text` → `string`
7106
+ * - `Integer` → `number` (integer)
7107
+ * - `Bool` → `boolean`
7108
+ *
7109
+ * @param id - Asset ID
7110
+ * @param newValue - New value to apply (string for `Text`, number for `Integer`, boolean for `Bool`)
7111
+ * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`)
7112
+ * @returns Promise resolving when the asset has been updated
7113
+ *
7114
+ * @example
7115
+ * ```typescript
7116
+ * import { Assets } from '@uipath/uipath-typescript/assets';
7117
+ *
7118
+ * const assets = new Assets(sdk);
7119
+ *
7120
+ * // Update a Text asset by folder ID
7121
+ * await assets.updateValueById(<assetId>, 'new-value', { folderId: <folderId> });
7122
+ *
7123
+ * // Update an Integer asset by folder key (GUID)
7124
+ * await assets.updateValueById(<assetId>, 42, { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
7125
+ *
7126
+ * // Update a Bool asset by folder path
7127
+ * await assets.updateValueById(<assetId>, true, { folderPath: 'Shared/Finance' });
7128
+ * ```
7129
+ */
7130
+ updateValueById(id: number, newValue: AssetNewValue, options?: AssetUpdateValueByIdOptions): Promise<void>;
6736
7131
  }
6737
7132
 
6738
7133
  declare enum BucketOptions {
@@ -9618,11 +10013,12 @@ interface Exchange {
9618
10013
  }
9619
10014
  /**
9620
10015
  * Optional configuration options for when the service automatically starts agent job(s) to serve the conversation.
9621
- * When not provided, service uses default configuration with RunAsMe set to false.
10016
+ * When not provided, service uses recommended default configurations.
9622
10017
  */
9623
10018
  interface ConversationJobStartOverrides {
9624
10019
  /**
9625
- * Whether the job(s) should run with the user's identity (RunAsMe). Defaults to false when not provided.
10020
+ * Whether the job(s) should run with the user's identity (RunAsMe). When not provided, service
10021
+ * uses recommended default based on authentication-state and process-runtime.
9626
10022
  */
9627
10023
  runAsMe?: boolean;
9628
10024
  }
@@ -9727,30 +10123,11 @@ interface ContentPartInterrupted {
9727
10123
  */
9728
10124
  interface SessionCapabilities {
9729
10125
  /**
9730
- * Indicates the sender may produce a cross exchange input stream events if the receiver indicates they can be handled.
10126
+ * Indicates that a client is prepared to handle events for exchanges initiated by service-role messages.
10127
+ * When set to true, the client will receive events for the service-role message and any assistant-role messages
10128
+ * sent in response to it within the exchange.
9731
10129
  */
9732
- asyncInputStreamEmitter?: boolean;
9733
- /**
9734
- * Indicates the sender can handle cross exchange input stream events.
9735
- */
9736
- asyncInputStreamHandler?: boolean;
9737
- /**
9738
- * Indicates the sender may produce cross exchange tool calls if the receiver indicates they can be handled.
9739
- */
9740
- asyncToolCallEmitter?: boolean;
9741
- /**
9742
- * Indicates the sender can handle cross exchange tool calls.
9743
- */
9744
- asyncToolCallHandler?: boolean;
9745
- /**
9746
- * Indicates the mime types which the sender can send in input streams and as message content, provided the receiver
9747
- * indicates they can handle the mime type.
9748
- */
9749
- mimeTypesEmitted?: string[];
9750
- /**
9751
- * Indicates the mime types the sender can handle. Wildcards such as "*\/*" and "text/*" are allowed.
9752
- */
9753
- mimeTypesHandled?: string[];
10130
+ serviceMessageClient?: boolean;
9754
10131
  /** Allow custom properties */
9755
10132
  [key: string]: unknown;
9756
10133
  }
@@ -12540,28 +12917,49 @@ interface FeedbackCreateResponse {
12540
12917
  */
12541
12918
  interface ExchangeServiceModel {
12542
12919
  /**
12543
- * Gets all exchanges for a conversation with optional filtering and pagination
12920
+ * Gets exchanges for a conversation with pagination and optional sort parameters
12921
+ *
12922
+ * Returns a paginated response. When called without `pageSize`/`cursor`, the
12923
+ * backend applies its default page size — inspect `hasNextPage`/`nextCursor`
12924
+ * to navigate further pages.
12544
12925
  *
12545
12926
  * @param conversationId - The conversation ID to get exchanges for
12546
12927
  * @param options - Options for querying exchanges including optional pagination parameters
12547
- * @returns Promise resolving to either an array of exchanges {@link NonPaginatedResponse}<{@link ExchangeGetResponse}> or a {@link PaginatedResponse}<{@link ExchangeGetResponse}> when pagination options are used
12548
- * @example
12549
- * ```typescript
12550
- * // Get all exchanges (non-paginated)
12551
- * const conversationExchanges = await exchanges.getAll(conversationId);
12928
+ * @returns Promise resolving to a {@link PaginatedResponse}<{@link ExchangeGetResponse}>
12552
12929
  *
12553
- * // First page with pagination
12554
- * const firstPageOfExchanges = await exchanges.getAll(conversationId, { pageSize: 10 });
12930
+ * @example Basic usage - default page size and sort order
12931
+ * ```typescript
12932
+ * // First page
12933
+ * const firstPage = await exchanges.getAll(conversationId);
12555
12934
  *
12556
12935
  * // Navigate using cursor
12557
- * if (firstPageOfExchanges.hasNextPage) {
12558
- * const nextPageOfExchanges = await exchanges.getAll(conversationId, {
12559
- * cursor: firstPageOfExchanges.nextCursor
12936
+ * if (firstPage.hasNextPage) {
12937
+ * const nextPage = await exchanges.getAll(conversationId, { cursor: firstPage.nextCursor });
12938
+ * }
12939
+ * ```
12940
+ *
12941
+ * @example With explicit page size and exchange/message sort orders
12942
+ * ```typescript
12943
+ * import { SortOrder } from '@uipath/uipath-typescript/conversational-agent';
12944
+ *
12945
+ * const firstPage = await exchanges.getAll(conversationId, {
12946
+ * pageSize: 10,
12947
+ * exchangeSort: SortOrder.Descending,
12948
+ * messageSort: SortOrder.Ascending
12949
+ * });
12950
+ *
12951
+ * // Navigate using cursor and same parameters
12952
+ * if (firstPage.hasNextPage) {
12953
+ * const nextPage = await exchanges.getAll(conversationId, {
12954
+ * pageSize: 10,
12955
+ * exchangeSort: SortOrder.Descending,
12956
+ * messageSort: SortOrder.Ascending,
12957
+ * cursor: firstPage.nextCursor
12560
12958
  * });
12561
12959
  * }
12562
12960
  * ```
12563
12961
  */
12564
- getAll<T extends ExchangeGetAllOptions = ExchangeGetAllOptions>(conversationId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ExchangeGetResponse> : NonPaginatedResponse<ExchangeGetResponse>>;
12962
+ getAll(conversationId: string, options?: ExchangeGetAllOptions): Promise<PaginatedResponse<ExchangeGetResponse>>;
12565
12963
  /**
12566
12964
  * Gets an exchange by ID with its messages
12567
12965
  *
@@ -12605,26 +13003,53 @@ interface ExchangeServiceModel {
12605
13003
  */
12606
13004
  interface ConversationExchangeServiceModel {
12607
13005
  /**
12608
- * Gets all exchanges for this conversation with optional filtering and pagination
13006
+ * Gets exchanges for this conversation with pagination and optional sort parameters
13007
+ *
13008
+ * Returns a paginated response. When called without `pageSize`/`cursor`, the
13009
+ * backend applies its default page size — inspect `hasNextPage`/`nextCursor`
13010
+ * to navigate further pages.
12609
13011
  *
12610
13012
  * @param options - Options for querying exchanges including optional pagination parameters
12611
- * @returns Promise resolving to either an array of exchanges or a paginated response
13013
+ * @returns Promise resolving to a {@link PaginatedResponse}<{@link ExchangeGetResponse}>
12612
13014
  *
12613
- * @example
13015
+ * @example Basic usage - default page size and sort order
12614
13016
  * ```typescript
12615
13017
  * const conversation = await conversationalAgent.conversations.getById(conversationId);
12616
13018
  *
12617
- * // Get all exchanges
12618
- * const allExchanges = await conversation.exchanges.getAll();
13019
+ * // First page
13020
+ * const firstPage = await conversation.exchanges.getAll();
12619
13021
  *
12620
- * // With pagination
12621
- * const firstPage = await conversation.exchanges.getAll({ pageSize: 10 });
13022
+ * // Navigate using cursor
12622
13023
  * if (firstPage.hasNextPage) {
12623
13024
  * const nextPage = await conversation.exchanges.getAll({ cursor: firstPage.nextCursor });
12624
13025
  * }
12625
13026
  * ```
13027
+ *
13028
+ * @example With explicit page size and exchange/message sort orders
13029
+ * ```typescript
13030
+ * import { SortOrder } from '@uipath/uipath-typescript/conversational-agent';
13031
+ *
13032
+ * const conversation = await conversationalAgent.conversations.getById(conversationId);
13033
+ *
13034
+ * // First page
13035
+ * const firstPage = await conversation.exchanges.getAll({
13036
+ * pageSize: 10,
13037
+ * exchangeSort: SortOrder.Descending,
13038
+ * messageSort: SortOrder.Ascending
13039
+ * });
13040
+ *
13041
+ * // Navigate using cursor and same parameters
13042
+ * if (firstPage.hasNextPage) {
13043
+ * const nextPage = await conversation.exchanges.getAll({
13044
+ * pageSize: 10,
13045
+ * exchangeSort: SortOrder.Descending,
13046
+ * messageSort: SortOrder.Ascending,
13047
+ * cursor: firstPage.nextCursor
13048
+ * });
13049
+ * }
13050
+ * ```
12626
13051
  */
12627
- getAll<T extends ExchangeGetAllOptions = ExchangeGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ExchangeGetResponse> : NonPaginatedResponse<ExchangeGetResponse>>;
13052
+ getAll(options?: ExchangeGetAllOptions): Promise<PaginatedResponse<ExchangeGetResponse>>;
12628
13053
  /**
12629
13054
  * Gets an exchange by ID with its messages
12630
13055
  *
@@ -12780,28 +13205,23 @@ interface ConversationServiceModel {
12780
13205
  */
12781
13206
  create(agentId: number, folderId: number, options?: ConversationCreateOptions): Promise<ConversationCreateResponse>;
12782
13207
  /**
12783
- * Gets all conversations with optional filtering and pagination
13208
+ * Gets conversations with pagination and optional sort/filter parameters
12784
13209
  *
12785
- * The method returns either:
12786
- * - A NonPaginatedResponse with items array (when no pagination parameters are provided)
12787
- * - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
13210
+ * Returns a paginated response. When called without `pageSize`/`cursor`, a
13211
+ * default page size is applied - inspect `hasNextPage`/`nextCursor`
13212
+ * to navigate further pages.
12788
13213
  *
12789
- * @param options - Options for querying conversations including optional pagination parameters
12790
- * @returns Promise resolving to either an array of conversations {@link NonPaginatedResponse}<{@link ConversationGetResponse}> or a {@link PaginatedResponse}<{@link ConversationGetResponse}> when pagination options are used
13214
+ * @param options - Options for querying conversations
13215
+ * @returns Promise resolving to a {@link PaginatedResponse}<{@link ConversationGetResponse}>
12791
13216
  *
12792
- * @example Basic usage - get all conversations
13217
+ * @example Basic usage - default sort, pagination, and without filtering
12793
13218
  * ```typescript
12794
- * const allConversations = await conversationalAgent.conversations.getAll();
13219
+ * // First page
13220
+ * const firstPage = await conversationalAgent.conversations.getAll();
12795
13221
  *
12796
- * for (const conversation of allConversations.items) {
13222
+ * for (const conversation of firstPage.items) {
12797
13223
  * console.log(`${conversation.label} - created: ${conversation.createdTime}`);
12798
13224
  * }
12799
- * ```
12800
- *
12801
- * @example With pagination
12802
- * ```typescript
12803
- * // First page
12804
- * const firstPage = await conversationalAgent.conversations.getAll({ pageSize: 10 });
12805
13225
  *
12806
13226
  * // Navigate using cursor
12807
13227
  * if (firstPage.hasNextPage) {
@@ -12811,23 +13231,44 @@ interface ConversationServiceModel {
12811
13231
  * }
12812
13232
  * ```
12813
13233
  *
12814
- * @example Sorted with limit
13234
+ * @example With explicit page size and sort order (by last-activity timestamp)
12815
13235
  * ```typescript
12816
- * const result = await conversationalAgent.conversations.getAll({
12817
- * sort: SortOrder.Descending,
12818
- * pageSize: 20
13236
+ * import { SortOrder } from '@uipath/uipath-typescript/conversational-agent';
13237
+ *
13238
+ * // First page
13239
+ * const firstPage = await conversationalAgent.conversations.getAll({
13240
+ * pageSize: 10,
13241
+ * sort: SortOrder.Descending
12819
13242
  * });
13243
+ *
13244
+ * // Navigate using cursor and same parameters
13245
+ * if (firstPage.hasNextPage) {
13246
+ * const nextPage = await conversationalAgent.conversations.getAll({
13247
+ * pageSize: 10,
13248
+ * sort: SortOrder.Descending,
13249
+ * cursor: firstPage.nextCursor
13250
+ * });
13251
+ * }
12820
13252
  * ```
12821
13253
  *
12822
- * @example Filter by agent and search by label
13254
+ * @example With agent-filter and label-search
12823
13255
  * ```typescript
12824
- * const filtered = await conversationalAgent.conversations.getAll({
13256
+ * const firstPage = await conversationalAgent.conversations.getAll({
12825
13257
  * agentId: <agentId>,
12826
13258
  * label: 'budget'
12827
13259
  * });
13260
+ *
13261
+ * // Navigate using cursor and same parameters
13262
+ * if (firstPage.hasNextPage) {
13263
+ * const nextPage = await conversationalAgent.conversations.getAll({
13264
+ * agentId: <agentId>,
13265
+ * label: 'budget',
13266
+ * cursor: firstPage.nextCursor
13267
+ * });
13268
+ * }
12828
13269
  * ```
12829
13270
  */
12830
- getAll<T extends ConversationGetAllOptions = ConversationGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ConversationGetResponse> : NonPaginatedResponse<ConversationGetResponse>>;
13271
+ getAll(options?: ConversationGetAllOptions): Promise<PaginatedResponse<ConversationGetResponse>>;
12831
13272
  /**
12832
13273
  * Gets a conversation by ID
12833
13274
  *
@@ -13181,6 +13622,11 @@ interface ConversationSessionOptions {
13181
13622
  * ```
13182
13623
  */
13183
13624
  logLevel?: LogLevel;
13625
+ /**
13626
+ * Optional capabilities of this client to advertise to the service when starting the session.
13627
+ * Generally not needed unless the client is accessing more advanced features.
13628
+ */
13629
+ capabilities?: SessionCapabilities;
13184
13630
  }
13185
13631
  /** Response for creating a conversation (includes methods) */
13186
13632
  interface ConversationCreateResponse extends ConversationGetResponse {
@@ -13216,7 +13662,7 @@ interface ConversationUpdateOptions {
13216
13662
  agentInput?: AgentInput;
13217
13663
  }
13218
13664
  type ConversationGetAllOptions = PaginationOptions & {
13219
- /** Sort order for conversations */
13665
+ /** Sort order for conversations (by the last activity timestamp) */
13220
13666
  sort?: SortOrder;
13221
13667
  /** GUID key of the agent to filter conversations by. */
13222
13668
  agentKey?: string;
@@ -14233,6 +14679,355 @@ interface FeedbackServiceModel {
14233
14679
  deleteCategory(id: string, options?: FeedbackDeleteCategoryOptions): Promise<void>;
14234
14680
  }
14235
14681
 
14682
+ /**
14683
+ * Filter fields shared by agent endpoints that accept a
14684
+ * folder/agent/project scope (`/Agents/agents`, `/Agents/errors`, etc.).
14685
+ */
14686
+ interface AgentFilterOptions {
14687
+ /** Optional folder keys to scope the lookup. Intersected with the user's accessible folders. */
14688
+ folderKeys?: string[];
14689
+ /** Filter to specific agent names. */
14690
+ agentNames?: string[];
14691
+ /** Filter to specific project keys. */
14692
+ projectKeys?: string[];
14693
+ /** Filter to a single agent by ID. */
14694
+ agentId?: string;
14695
+ /** Filter to a specific process version. */
14696
+ processVersion?: string;
14697
+ }
14698
+ /**
14699
+ * Columns available for ordering results.
14700
+ */
14701
+ declare enum AgentListSortColumn {
14702
+ AgentName = "AgentName",
14703
+ ParentProcess = "ParentProcess",
14704
+ LastRun = "LastRun",
14705
+ HealthScore = "HealthScore",
14706
+ LastIncident = "LastIncident",
14707
+ FolderName = "FolderName",
14708
+ /** Quantity of AGU (Agent Units) consumed */
14709
+ QuantityAGU = "QuantityAGU",
14710
+ /** Quantity of PLTU (Platform Units) consumed */
14711
+ QuantityPLTU = "QuantityPLTU",
14712
+ FolderPath = "FolderPath"
14713
+ }
14714
+ /**
14715
+ * Ordering directive for the agents list.
14716
+ */
14717
+ interface AgentListOrderBy {
14718
+ /** Column to sort by */
14719
+ column: AgentListSortColumn;
14720
+ /** Sort descending. Defaults to false. */
14721
+ desc?: boolean;
14722
+ }
14723
+ /**
14724
+ * One row in the agents list - agent identity plus consumption and health metadata aggregated over the
14725
+ * requested time window.
14726
+ */
14727
+ interface AgentListItem {
14728
+ /** Agent ID */
14729
+ agentId: string;
14730
+ /** Agent display name */
14731
+ agentName: string;
14732
+ /** Parent process name. May be `null` or `""` for jobs not bound to a parent process. */
14733
+ parentProcess: string | null;
14734
+ /** Folder key of the folder the agent runs in. May be `null` or `""`. */
14735
+ folderKey: string | null;
14736
+ /** Folder display name. May be `null` or `""`. */
14737
+ folderName: string | null;
14738
+ /** Fully qualified folder path. May be `null` or `""`. */
14739
+ folderPath: string | null;
14740
+ /** Last run timestamp */
14741
+ lastRun: string;
14742
+ /** Process key. May be `null` or `""` for ad-hoc jobs. */
14743
+ processKey: string | null;
14744
+ /** Process version. May be `null` or `""`. */
14745
+ processVersion: string | null;
14746
+ /** Health score (0-100) */
14747
+ healthScore: number;
14748
+ /** Last incident type label. May be `null` or `""`. */
14749
+ lastIncidentType: string | null;
14750
+ /** Total units consumed by this agent in the window */
14751
+ unitsQuantity: number;
14752
+ /** Display name of the units (if any). May be `null` or `""`. */
14753
+ unitsName: string | null;
14754
+ /** Quantity of AGU (Agent Units) consumed by this agent */
14755
+ quantityAGU: number;
14756
+ /** Quantity of PLTU (Platform Units) consumed by this agent */
14757
+ quantityPLTU: number;
14758
+ }
14759
+ /**
14760
+ * Options for {@link AgentServiceModel.getAll}.
14761
+ *
14762
+ * Composes filter, pagination, and sort options.
14763
+ */
14764
+ type AgentListOptions = AgentFilterOptions & PaginationOptions & {
14765
+ /** Sort order for the result set. */
14766
+ orderBy?: AgentListOrderBy;
14767
+ };
14768
+
14769
+ /**
14770
+ * Service for retrieving runtime data for UiPath Agents.
14771
+ *
14772
+ * See [About Agents](https://docs.uipath.com/agents/automation-cloud/latest/user-guide/about-agents)
14773
+ * for an overview of UiPath Agents.
14774
+ */
14775
+ interface AgentServiceModel {
14776
+ /**
14777
+ * Retrieves the list of agents on the tenant with consumption and health
14778
+ * metadata over the requested window.
14779
+ *
14780
+ * Returns a {@link PaginatedResponse} when pagination options (`pageSize`,
14781
+ * `cursor`, or `jumpToPage`) are provided, otherwise a
14782
+ * {@link NonPaginatedResponse}.
14783
+ *
14784
+ * @param startTime - Inclusive lower bound for the query window
14785
+ * @param endTime - Exclusive upper bound for the query window
14786
+ * @param options - Optional pagination, sort, and filters
14787
+ * @returns Promise resolving to a paginated or non-paginated list of {@link AgentListItem}
14788
+ * @example
14789
+ * ```typescript
14790
+ * import { Agents, AgentListSortColumn } from '@uipath/uipath-typescript/agents';
14791
+ *
14792
+ * const agents = new Agents(sdk);
14793
+ *
14794
+ * // Non-paginated — returns the server default page
14795
+ * const result = await agents.getAll(
14796
+ * new Date('2025-05-01T00:00:00Z'),
14797
+ * new Date('2026-05-14T00:00:00Z'),
14798
+ * );
14799
+ * result.items.forEach((agent) => {
14800
+ * console.log(`${agent.agentName} — ${agent.unitsQuantity} units, health=${agent.healthScore}`);
14801
+ * });
14802
+ *
14803
+ * // Paginated — sorted by health score descending
14804
+ * const page = await agents.getAll(
14805
+ * new Date('2025-05-01T00:00:00Z'),
14806
+ * new Date('2026-05-14T00:00:00Z'),
14807
+ * {
14808
+ * pageSize: 25,
14809
+ * orderBy: { column: AgentListSortColumn.HealthScore, desc: true },
14810
+ * folderKeys: ['<folderKey1>'],
14811
+ * },
14812
+ * );
14813
+ *
14814
+ * if (page.hasNextPage && page.nextCursor) {
14815
+ * const next = await agents.getAll(
14816
+ * new Date('2025-05-01T00:00:00Z'),
14817
+ * new Date('2026-05-14T00:00:00Z'),
14818
+ * { cursor: page.nextCursor },
14819
+ * );
14820
+ * }
14821
+ * ```
14822
+ */
14823
+ getAll<T extends AgentListOptions = AgentListOptions>(startTime: Date, endTime: Date, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<AgentListItem> : NonPaginatedResponse<AgentListItem>>;
14824
+ }
14825
+
14826
+ /**
14827
+ * Types for the Agent Memory metrics service.
14828
+ */
14829
+ /**
14830
+ * Execution kind to filter Agent Memory queries by. Omit to include both
14831
+ * Debug and Runtime executions.
14832
+ */
14833
+ declare enum AgentMemoryExecutionType {
14834
+ /** Executions produced during agent debugging sessions. */
14835
+ Debug = "Debug",
14836
+ /** Executions produced during production runtime. */
14837
+ Runtime = "Runtime"
14838
+ }
14839
+ /**
14840
+ * Common time-window and scope filters shared by Agent Memory queries.
14841
+ *
14842
+ * All fields are optional. When `startTime`/`endTime` are omitted, the query
14843
+ * defaults to the last 24 hours, with `endTime` defaulting to now.
14844
+ */
14845
+ interface AgentMemoryFilterOptions {
14846
+ /** Inclusive lower bound for the query window. Defaults to 24 hours before `endTime` when omitted. */
14847
+ startTime?: Date;
14848
+ /** Exclusive upper bound for the query window. Defaults to now when omitted. */
14849
+ endTime?: Date;
14850
+ /** Filter to a single agent by ID. Obtain an `agentId` from the Agents service. */
14851
+ agentId?: string;
14852
+ /** Filter to a specific agent version. */
14853
+ agentVersion?: string;
14854
+ /** Folder keys to scope the query. Results are limited to folders you can access. */
14855
+ folderKeys?: string[];
14856
+ /** Filter to a specific execution kind. Omit to include both Debug and Runtime. */
14857
+ executionType?: AgentMemoryExecutionType;
14858
+ }
14859
+ /**
14860
+ * Options for retrieving the agent-memory state timeline.
14861
+ */
14862
+ interface AgentMemoryGetTimelineOptions extends AgentMemoryFilterOptions {
14863
+ }
14864
+ /**
14865
+ * Options for retrieving the memory-calls timeline.
14866
+ */
14867
+ interface AgentMemoryGetCallsTimelineOptions extends AgentMemoryFilterOptions {
14868
+ }
14869
+ /**
14870
+ * Options for retrieving the top memory spaces.
14871
+ */
14872
+ interface AgentMemoryGetTopSpacesOptions extends AgentMemoryFilterOptions {
14873
+ /** Maximum number of memory spaces to return, ranked by memory count. Defaults to 5 when omitted. */
14874
+ limit?: number;
14875
+ }
14876
+ /**
14877
+ * One point on the agent-memory state timeline — memory-state counts for a
14878
+ * single time bucket.
14879
+ */
14880
+ interface AgentMemoryGetTimelineResponse {
14881
+ /** Bucket timestamp. */
14882
+ timeSlice: string;
14883
+ /** Count of memory entries that were in-memory in this bucket. */
14884
+ inMemoryCount: number;
14885
+ /** Count of memory entries that were not in-memory in this bucket. */
14886
+ notInMemoryCount: number;
14887
+ /** Total memory entries in this bucket. */
14888
+ totalCount: number;
14889
+ /** Count of enabled memory entries in this bucket. */
14890
+ enabledMemoryCount: number;
14891
+ /** Count of disabled memory entries in this bucket. */
14892
+ disabledMemoryCount: number;
14893
+ }
14894
+ /**
14895
+ * One point on the memory-calls timeline — the count of memory calls for a
14896
+ * single time bucket.
14897
+ */
14898
+ interface AgentMemoryGetCallsTimelineResponse {
14899
+ /** Bucket timestamp. */
14900
+ timeSlice: string;
14901
+ /** Number of memory calls in this bucket. */
14902
+ memoryCallsCount: number;
14903
+ }
14904
+ /**
14905
+ * A single memory space with its enabled/disabled memory-entry breakdown.
14906
+ */
14907
+ interface AgentMemoryGetTopSpacesResponse {
14908
+ /** Memory space identifier. */
14909
+ memorySpaceId: string;
14910
+ /** Memory space display name. */
14911
+ memorySpaceName: string;
14912
+ /** Total memory entries in this space over the requested window. */
14913
+ memoryCount: number;
14914
+ /** Count of enabled memory entries in this space. */
14915
+ enabledMemoryCount: number;
14916
+ /** Count of disabled memory entries in this space. */
14917
+ disabledMemoryCount: number;
14918
+ }
14919
+
14920
+ /**
14921
+ * Service for managing UiPath Agent Memory.
14922
+ *
14923
+ * Agent Memory is a persistent store of information an agent
14924
+ * retains across runs to improve runtime reliability.
14925
+ *
14926
+ * @example
14927
+ * ```typescript
14928
+ * import { UiPath } from '@uipath/uipath-typescript/core';
14929
+ * import { AgentMemory } from '@uipath/uipath-typescript/agent-memory';
14930
+ *
14931
+ * const sdk = new UiPath(config);
14932
+ * await sdk.initialize();
14933
+ *
14934
+ * const memory = new AgentMemory(sdk);
14935
+ * const timeline = await memory.getTimeline();
14936
+ * ```
14937
+ */
14938
+ interface AgentMemoryServiceModel {
14939
+ /**
14940
+ * Gets agent memory state over time, with optional filters.
14941
+ *
14942
+ * @param options - Optional time window and scope filters
14943
+ * @returns Promise resolving to an array of {@link AgentMemoryGetTimelineResponse}, one per time bucket.
14944
+ * @example
14945
+ * ```typescript
14946
+ * import { AgentMemory } from '@uipath/uipath-typescript/agent-memory';
14947
+ *
14948
+ * const memory = new AgentMemory(sdk);
14949
+ *
14950
+ * // Last 24 hours (default window)
14951
+ * const timeline = await memory.getTimeline();
14952
+ * console.log(timeline[0]?.inMemoryCount);
14953
+ * ```
14954
+ * @example
14955
+ * ```typescript
14956
+ * import { AgentMemoryExecutionType } from '@uipath/uipath-typescript/agent-memory';
14957
+ *
14958
+ * // Scoped to one agent in one folder, runtime executions only
14959
+ * const scoped = await memory.getTimeline({
14960
+ * startTime: new Date('2026-05-01T00:00:00Z'),
14961
+ * endTime: new Date('2026-06-01T00:00:00Z'),
14962
+ * agentId: '<agentId>',
14963
+ * folderKeys: ['<folderKey>'],
14964
+ * executionType: AgentMemoryExecutionType.Runtime,
14965
+ * });
14966
+ * ```
14967
+ */
14968
+ getTimeline(options?: AgentMemoryGetTimelineOptions): Promise<AgentMemoryGetTimelineResponse[]>;
14969
+ /**
14970
+ * Gets the number of agent memory calls (accesses to the memory store) over time, with optional filters.
14971
+ *
14972
+ * @param options - Optional time window and scope filters
14973
+ * @returns Promise resolving to an array of {@link AgentMemoryGetCallsTimelineResponse}, one per time bucket.
14974
+ * @example
14975
+ * ```typescript
14976
+ * import { AgentMemory } from '@uipath/uipath-typescript/agent-memory';
14977
+ *
14978
+ * const memory = new AgentMemory(sdk);
14979
+ *
14980
+ * // Last 24 hours (default window)
14981
+ * const timeline = await memory.getCallsTimeline();
14982
+ * console.log(timeline[0]?.memoryCallsCount);
14983
+ * ```
14984
+ * @example
14985
+ * ```typescript
14986
+ * import { AgentMemoryExecutionType } from '@uipath/uipath-typescript/agent-memory';
14987
+ *
14988
+ * // Scoped to one agent in one folder, runtime executions only
14989
+ * const scoped = await memory.getCallsTimeline({
14990
+ * startTime: new Date('2026-05-01T00:00:00Z'),
14991
+ * endTime: new Date('2026-06-01T00:00:00Z'),
14992
+ * agentId: '<agentId>',
14993
+ * folderKeys: ['<folderKey>'],
14994
+ * executionType: AgentMemoryExecutionType.Runtime,
14995
+ * });
14996
+ * ```
14997
+ */
14998
+ getCallsTimeline(options?: AgentMemoryGetCallsTimelineOptions): Promise<AgentMemoryGetCallsTimelineResponse[]>;
14999
+ /**
15000
+ * Gets the top memory spaces by memory count, with optional filters
15001
+ *
15002
+ * @param options - Optional limit, time window, and scope filters
15003
+ * @returns Promise resolving to an array of {@link AgentMemoryGetTopSpacesResponse}, ranked by memory count.
15004
+ * @example
15005
+ * ```typescript
15006
+ * import { AgentMemory } from '@uipath/uipath-typescript/agent-memory';
15007
+ *
15008
+ * const memory = new AgentMemory(sdk);
15009
+ *
15010
+ * // Top 5 memory spaces (default limit and window)
15011
+ * const top = await memory.getTopSpaces();
15012
+ * console.log(top[0]?.memorySpaceName, top[0]?.memoryCount);
15013
+ * ```
15014
+ * @example
15015
+ * ```typescript
15016
+ * import { AgentMemoryExecutionType } from '@uipath/uipath-typescript/agent-memory';
15017
+ *
15018
+ * // Top 10 spaces for one folder over an explicit window, runtime executions only
15019
+ * const topScoped = await memory.getTopSpaces({
15020
+ * startTime: new Date('2026-05-01T00:00:00Z'),
15021
+ * endTime: new Date('2026-06-01T00:00:00Z'),
15022
+ * folderKeys: ['<folderKey>'],
15023
+ * executionType: AgentMemoryExecutionType.Runtime,
15024
+ * limit: 10,
15025
+ * });
15026
+ * ```
15027
+ */
15028
+ getTopSpaces(options?: AgentMemoryGetTopSpacesOptions): Promise<AgentMemoryGetTopSpacesResponse[]>;
15029
+ }
15030
+
14236
15031
  declare enum DocumentActionPriority {
14237
15032
  Low = "Low",
14238
15033
  Medium = "Medium",
@@ -15443,6 +16238,223 @@ declare namespace index {
15443
16238
  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 };
15444
16239
  }
15445
16240
 
16241
+ /**
16242
+ * Governance Service Types
16243
+ *
16244
+ * Public types exposed via `@uipath/uipath-typescript/governance`.
16245
+ */
16246
+
16247
+ declare enum PolicyEvaluationResult {
16248
+ /** Active policy permitted the action. */
16249
+ Allow = "Allow",
16250
+ /** Active policy blocked the action. */
16251
+ Deny = "Deny",
16252
+ /** Simulated (NoOp) policy would have permitted the action. */
16253
+ SimulatedAllow = "SimulatedAllow",
16254
+ /** Simulated (NoOp) policy would have blocked the action. */
16255
+ SimulatedDeny = "SimulatedDeny"
16256
+ }
16257
+ /**
16258
+ * Each trace row represents one policy's verdict within a governance
16259
+ * enforcement event. One enforcement event can produce multiple trace rows
16260
+ * when multiple policies contributed to the final verdict.
16261
+ */
16262
+ interface GovernancePolicyTrace {
16263
+ /** Tenant the trace was recorded in. Present even when `fullOrganization` is `true`. */
16264
+ tenantId?: string;
16265
+ /** The start time of governance enforcement event. */
16266
+ startTime: string;
16267
+ /** Final enforcement verdict for the parent governance event. */
16268
+ finalEnforcement?: string;
16269
+ /** ID of the policy this trace row evaluates. */
16270
+ policyId?: string;
16271
+ /** This individual policy's enforcement contribution to the parent verdict. */
16272
+ policyEnforcement?: string;
16273
+ /** The outcome of one policy evaluation — whether it allowed or denied the action, and whether that decision was actively enforced or just simulated (NoOp). */
16274
+ policyEvaluationResult?: string;
16275
+ /** Display name of the policy. */
16276
+ policyName?: string;
16277
+ /** Enforcement mode of the policy at the time of evaluation. */
16278
+ policyStatus?: string;
16279
+ /** Opaque details payload describing the evaluation result. */
16280
+ policyEvaluationDetails?: string;
16281
+ /** Process or executable that triggered the evaluation. */
16282
+ actorProcessId?: string;
16283
+ /** Type of the actor process (e.g. coded agent, RPA process). */
16284
+ actorProcessType?: string;
16285
+ /** Identity (user/principal) that triggered the evaluation. */
16286
+ actorIdentityId?: string;
16287
+ /** Resource being acted on. */
16288
+ resourceId?: string;
16289
+ /** Type of the resource being acted on. */
16290
+ resourceType?: string;
16291
+ /** Orchestrator folder key associated with the evaluation, if any. */
16292
+ folderKey?: string;
16293
+ /** Distributed-tracing ID covering the governance enforcement event. */
16294
+ traceId?: string;
16295
+ /** Process key associated with the evaluation, if any. */
16296
+ processKey?: string;
16297
+ /** Job key associated with the evaluation, if any. */
16298
+ jobKey?: string;
16299
+ }
16300
+ /**
16301
+ * Common filter options shared across Governance APIs.
16302
+ *
16303
+ * Holds filters that are not specific to any single governance resource, so
16304
+ * other governance endpoints can reuse them.
16305
+ */
16306
+ interface GovernanceFilterOptions {
16307
+ /**
16308
+ * Inclusive upper bound on trace start time. When omitted, the upper bound
16309
+ * is open.
16310
+ */
16311
+ endTime?: Date;
16312
+ /**
16313
+ * Whether to query the whole organization instead of just the current tenant.
16314
+ *
16315
+ * Defaults to tenant-scoped:
16316
+ * - omitted → tenant-scoped (default)
16317
+ * - `false` → tenant-scoped (explicit, same result)
16318
+ * - `true` → org-wide across all tenants; requires an organization admin,
16319
+ * otherwise the request returns 403
16320
+ *
16321
+ * @default false
16322
+ */
16323
+ fullOrganization?: boolean;
16324
+ }
16325
+ /**
16326
+ * Filter and pagination options for fetching policy traces.
16327
+ *
16328
+ * All filters combine with AND semantics. Array filters match any value in
16329
+ * the array (OR within a single filter).
16330
+ */
16331
+ type GovernancePolicyTraceGetAllOptions = PaginationOptions & GovernanceFilterOptions & {
16332
+ /** Filter by one or more policy evaluation results. */
16333
+ evaluationResult?: PolicyEvaluationResult[];
16334
+ /** Filter by one or more policy IDs. */
16335
+ policyId?: string[];
16336
+ /** Filter by one or more actor process IDs. */
16337
+ actorProcessId?: string[];
16338
+ /** Filter by one or more actor process types (e.g. coded agent, RPA process). */
16339
+ actorProcessType?: string[];
16340
+ /** Filter by one or more actor identity IDs. */
16341
+ actorIdentityId?: string[];
16342
+ /** Filter by one or more resource IDs. */
16343
+ resourceId?: string[];
16344
+ /** Filter by one or more resource types. */
16345
+ resourceType?: string[];
16346
+ /** Filter by one or more distributed-trace IDs. */
16347
+ traceId?: string[];
16348
+ };
16349
+ /**
16350
+ * Aggregate governance enforcement counts returned by
16351
+ * {@link GovernanceServiceModel.getOperationSummary}, covering the requested
16352
+ * time range.
16353
+ */
16354
+ interface GovernanceOperationSummary {
16355
+ /** Total number of governance enforcement evaluations in range. */
16356
+ totalEvaluations: number;
16357
+ /** Number of evaluations that resolved to `Allow`. */
16358
+ allowedCount: number;
16359
+ /** Number of evaluations that resolved to `Deny`. */
16360
+ deniedCount: number;
16361
+ /** Number of evaluations that resolved to `NoOp` (simulated). */
16362
+ noOpCount: number;
16363
+ }
16364
+
16365
+ /**
16366
+ * Service for inspecting governance policy enforcement on the UiPath platform.
16367
+ *
16368
+ * See [Define governance policies](https://docs.uipath.com/automation-ops/automation-cloud/latest/user-guide/define-governance-policies)
16369
+ * for how governance policies are configured in Automation Ops.
16370
+ *
16371
+ * All methods require the caller to be an organization administrator.
16372
+ *
16373
+ * ### Usage
16374
+ *
16375
+ * Prerequisites: Initialize the SDK first - see [Getting Started](/uipath-typescript/getting-started/#import-initialize)
16376
+ *
16377
+ * ```typescript
16378
+ * import { Governance } from '@uipath/uipath-typescript/governance';
16379
+ *
16380
+ * const governance = new Governance(sdk);
16381
+ * const traces = await governance.getPolicyTraces(new Date('2024-01-01'));
16382
+ * ```
16383
+ */
16384
+ interface GovernanceServiceModel {
16385
+ /**
16386
+ * Gets per-policy enforcement decisions across the requested time range.
16387
+ *
16388
+ * Each result row represents one policy's verdict within a single governance enforcement event.
16389
+ * A single user action can produce multiple rows when multiple policies were consulted.
16390
+ * Results are ordered by event start time, descending.
16391
+ *
16392
+ * @param startTime - Inclusive lower bound on the trace start time.
16393
+ * @param options - Optional filters and pagination options
16394
+ * @returns Promise resolving to {@link NonPaginatedResponse} of {@link GovernancePolicyTrace}
16395
+ * without pagination options, or {@link PaginatedResponse} of
16396
+ * {@link GovernancePolicyTrace} when pagination options are used.
16397
+ *
16398
+ * @example
16399
+ * ```typescript
16400
+ * import { Governance, PolicyEvaluationResult } from '@uipath/uipath-typescript/governance';
16401
+ *
16402
+ * const governance = new Governance(sdk);
16403
+ *
16404
+ * // Get all policy traces from the specified start time
16405
+ * const recent = await governance.getPolicyTraces(new Date('2024-01-01'));
16406
+ * console.log(recent.items.length);
16407
+ *
16408
+ * // Get all denied decisions across the whole organization
16409
+ * const page1 = await governance.getPolicyTraces(
16410
+ * new Date('2024-01-01'),
16411
+ * {
16412
+ * endTime: new Date(),
16413
+ * evaluationResult: [PolicyEvaluationResult.Deny, PolicyEvaluationResult.SimulatedDeny],
16414
+ * fullOrganization: true,
16415
+ * pageSize: 25,
16416
+ * },
16417
+ * );
16418
+ *
16419
+ * if (page1.hasNextPage) {
16420
+ * const page2 = await governance.getPolicyTraces(
16421
+ * new Date('2024-01-01'),
16422
+ * { cursor: page1.nextCursor },
16423
+ * );
16424
+ * }
16425
+ * ```
16426
+ */
16427
+ getPolicyTraces<T extends GovernancePolicyTraceGetAllOptions = GovernancePolicyTraceGetAllOptions>(startTime: Date, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<GovernancePolicyTrace> : NonPaginatedResponse<GovernancePolicyTrace>>;
16428
+ /**
16429
+ * Gets aggregate governance enforcement counts across the requested time range.
16430
+ *
16431
+ * Returns the total number of evaluations along with how many resolved to
16432
+ * `Allow`, `Deny`, or `NoOp`.
16433
+ *
16434
+ * @param startTime - Inclusive lower bound on the evaluation time.
16435
+ * @param options - Optional `endTime` upper bound and `fullOrganization` flag
16436
+ * @returns Promise resolving to {@link GovernanceOperationSummary}
16437
+ *
16438
+ * @example
16439
+ * ```typescript
16440
+ * import { Governance } from '@uipath/uipath-typescript/governance';
16441
+ *
16442
+ * const governance = new Governance(sdk);
16443
+ *
16444
+ * // Get operation summary from the specified start time to right now
16445
+ * const summary = await governance.getOperationSummary(new Date('2024-01-01'));
16446
+ * console.log(summary.totalEvaluations, summary.allowedCount, summary.deniedCount, summary.noOpCount);
16447
+ *
16448
+ * // Bounded range across the whole organization
16449
+ * const ranged = await governance.getOperationSummary(
16450
+ * new Date('2024-01-01'),
16451
+ * { endTime: new Date(), fullOrganization: true },
16452
+ * );
16453
+ * ```
16454
+ */
16455
+ getOperationSummary(startTime: Date, options?: GovernanceFilterOptions): Promise<GovernanceOperationSummary>;
16456
+ }
16457
+
15446
16458
  /**
15447
16459
  * Error thrown when authorization fails (403 errors)
15448
16460
  * Common scenarios:
@@ -15709,7 +16721,12 @@ declare const track: _uipath_core_telemetry.Track;
15709
16721
  declare const trackEvent: (eventName: string, name?: string, attributes?: _uipath_core_telemetry.TelemetryAttributes) => void;
15710
16722
  declare const telemetryClient: {
15711
16723
  initialize(context?: TelemetryContext): void;
16724
+ /**
16725
+ * Sets the authenticated user's id so every subsequently emitted event
16726
+ * carries it as `CloudUserId`.
16727
+ */
16728
+ setUserId(userId: string): void;
15712
16729
  };
15713
16730
 
15714
- 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 };
15715
- 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, ElementGetTopFailedCountResponse, 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 };
16731
+ export { AgentListSortColumn, AgentMap, AgentMemoryExecutionType, 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, PolicyEvaluationResult, 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, createCaseWithMethods, createConversationWithMethods, createEntityWithMethods, createJobWithMethods, createProcessInstanceWithMethods, createProcessWithMethods, createTaskWithMethods, getAppBase, getAsset, getErrorDetails, getLimitedPageSize, isAuthenticationError, isAuthorizationError, isNetworkError, isNotFoundError, isRateLimitError, isServerError, isUiPathError, isValidationError, loadFromMetaTags, telemetryClient, track, trackEvent };
16732
+ export type { AgentAppearance, AgentConversationServiceModel, AgentCreateConversationOptions, AgentFilterOptions, AgentGetByIdResponse, AgentGetResponse, AgentInput, AgentListItem, AgentListOptions, AgentListOrderBy, AgentMemoryFilterOptions, AgentMemoryGetCallsTimelineOptions, AgentMemoryGetCallsTimelineResponse, AgentMemoryGetTimelineOptions, AgentMemoryGetTimelineResponse, AgentMemoryGetTopSpacesOptions, AgentMemoryGetTopSpacesResponse, AgentMemoryServiceModel, AgentMethods, AgentServiceModel, AgentStartingPrompt, ArgumentMetadata, AssetGetAllOptions, AssetGetByIdOptions, AssetGetByNameOptions, AssetGetResponse, AssetNewValue, AssetServiceModel, AssetUpdateValueByIdOptions, 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, CaseGetAllWithMethodsResponse, CaseGetStageResponse, CaseGetTopDurationResponse, CaseGetTopFaultedCountResponse, CaseGetTopRunCountResponse, CaseInstanceExecutionHistoryResponse, CaseInstanceGetAllOptions, CaseInstanceGetAllWithPaginationOptions, CaseInstanceGetResponse, CaseInstanceMethods, CaseInstanceOperationOptions, CaseInstanceOperationResponse, CaseInstanceReopenOptions, CaseInstanceRun, CaseInstanceSlaSummaryOptions, CaseInstanceStageSLAOptions, CaseInstanceStageSLAResponse, CaseInstanceStageSLAStage, CaseInstancesServiceModel, CaseMethods, 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, ElementGetTopFailedCountResponse, ElementMetaData, ElementRunMetadata, ElementStats, EntityAggregate, EntityBatchInsertOptions, EntityBatchInsertResponse, EntityCreateFieldOptions, EntityCreateOptions, EntityDeleteAttachmentOptions, EntityDeleteAttachmentResponse, EntityDeleteByIdOptions, EntityDeleteOptions, EntityDeleteRecordByIdOptions, EntityDeleteRecordsOptions, EntityDeleteResponse, EntityDownloadAttachmentOptions, EntityFieldBase, EntityFieldUpdateOptions, EntityFileType, EntityFolderScopedOptions, EntityGetAllRecordsOptions, EntityGetByIdOptions, EntityGetRecordByIdOptions, EntityGetRecordsByIdOptions, EntityGetResponse, EntityImportRecordsByIdOptions, 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, GovernanceFilterOptions, GovernanceOperationSummary, GovernancePolicyTrace, GovernancePolicyTraceGetAllOptions, GovernanceServiceModel, 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 };