@uipath/uipath-typescript 1.3.10 → 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 +192 -10
  17. package/dist/cases/index.d.ts +208 -7
  18. package/dist/cases/index.mjs +192 -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 +135 -70
  26. package/dist/entities/index.d.ts +146 -45
  27. package/dist/entities/index.mjs +135 -70
  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 +1050 -291
  35. package/dist/index.d.ts +1313 -134
  36. package/dist/index.mjs +1050 -292
  37. package/dist/index.umd.js +4546 -3770
  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 +224 -18
  42. package/dist/maestro-processes/index.d.ts +221 -9
  43. package/dist/maestro-processes/index.mjs +224 -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 +1933 -0
  54. package/dist/traces/index.d.ts +566 -0
  55. package/dist/traces/index.mjs +1931 -0
  56. package/package.json +42 -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
  */
@@ -722,6 +743,8 @@ interface EntityFieldBase {
722
743
  isRbacEnabled?: boolean;
723
744
  /** Whether the field value is encrypted at rest (default: false) */
724
745
  isEncrypted?: boolean;
746
+ /** Whether the field is hidden from the UI (default: false) */
747
+ isHiddenField?: boolean;
725
748
  /** Default value for the field */
726
749
  defaultValue?: string;
727
750
  /** Maximum character length for STRING fields (default: 200, range: 1–4000) and MULTILINE_TEXT fields (default: 200, range: 1–10000). */
@@ -746,21 +769,37 @@ interface EntityCreateFieldOptions extends EntityFieldBase {
746
769
  type?: EntityFieldDataType;
747
770
  /** Choice set ID for choice-set fields */
748
771
  choiceSetId?: string;
749
- /** Name of the referenced entity for relationship fields */
750
- referenceEntityName?: string;
751
- /** Name of the field in the referenced entity */
752
- referenceFieldName?: string;
772
+ /** UUID of the referenced entity (required when `type` is `RELATIONSHIP` or `FILE`) */
773
+ referenceEntityId?: string;
774
+ /** UUID of the referenced field on the target entity (required when `type` is `RELATIONSHIP` or `FILE`) */
775
+ referenceFieldId?: string;
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 {
753
794
  }
754
795
  /**
755
796
  * Options for creating a new Data Fabric entity
756
797
  */
757
- interface EntityCreateOptions {
798
+ interface EntityCreateOptions extends EntityFolderScopedOptions {
758
799
  /** Human-readable display name shown in the UI (defaults to `name` if omitted) */
759
800
  displayName?: string;
760
801
  /** Optional entity description */
761
802
  description?: string;
762
- /** UUID of the folder to place the entity in (defaults to the tenant-level folder) */
763
- folderKey?: string;
764
803
  /** Whether role-based access control is enabled for this entity (default: false) */
765
804
  isRbacEnabled?: boolean;
766
805
  /** Whether Analytics integration is enabled for this entity (default: false) */
@@ -789,7 +828,7 @@ interface EntityRemoveFieldOptions {
789
828
  * (`displayName`, `description`, `isRbacEnabled`) can be combined; each is applied
790
829
  * only when the corresponding fields are provided.
791
830
  */
792
- interface EntityUpdateByIdOptions {
831
+ interface EntityUpdateByIdOptions extends EntityFolderScopedOptions {
793
832
  /** New fields to add */
794
833
  addFields?: EntityCreateFieldOptions[];
795
834
  /** Fields to remove, each identified by field name */
@@ -821,10 +860,20 @@ type EntityFileType = Blob | File | Uint8Array;
821
860
  /**
822
861
  * Optional options for uploading an attachment to an entity record
823
862
  */
824
- interface EntityUploadAttachmentOptions {
863
+ interface EntityUploadAttachmentOptions extends EntityFolderScopedOptions {
825
864
  /** Optional expansion level (default: 0) */
826
865
  expansionLevel?: number;
827
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
+ }
828
877
  /**
829
878
  * Response from uploading an attachment to an entity record
830
879
  */
@@ -979,10 +1028,6 @@ interface FieldMetaData {
979
1028
  referenceType?: ReferenceType;
980
1029
  choiceSetId?: string;
981
1030
  defaultValue?: string;
982
- /** Name of the referenced entity (used on write payloads for relationship fields) */
983
- referenceEntityName?: string;
984
- /** Name of the field in the referenced entity (used on write payloads for relationship fields) */
985
- referenceFieldName?: string;
986
1031
  }
987
1032
  /**
988
1033
  * External object details
@@ -1128,6 +1173,7 @@ interface EntityServiceModel {
1128
1173
  * Gets entity metadata by entity ID with attached operation methods
1129
1174
  *
1130
1175
  * @param id - UUID of the entity
1176
+ * @param options - Optional {@link EntityGetByIdOptions} (e.g. `folderKey` for folder-scoped entities)
1131
1177
  * @returns Promise resolving to entity metadata with operation methods
1132
1178
  * {@link EntityGetResponse}
1133
1179
  * @example
@@ -1140,6 +1186,9 @@ interface EntityServiceModel {
1140
1186
  * // Get entity metadata with methods
1141
1187
  * const entity = await entities.getById("<entityId>");
1142
1188
  *
1189
+ * // Folder-scoped: pass the entity's folder key
1190
+ * const folderEntity = await entities.getById("<entityId>", { folderKey: "<folderKey>" });
1191
+ *
1143
1192
  * // Call operations directly on the entity
1144
1193
  * const records = await entity.getAllRecords();
1145
1194
  *
@@ -1159,7 +1208,7 @@ interface EntityServiceModel {
1159
1208
  * ]);
1160
1209
  * ```
1161
1210
  */
1162
- getById(id: string): Promise<EntityGetResponse>;
1211
+ getById(id: string, options?: EntityGetByIdOptions): Promise<EntityGetResponse>;
1163
1212
  /**
1164
1213
  * Gets entity records by entity ID
1165
1214
  *
@@ -1363,6 +1412,7 @@ interface EntityServiceModel {
1363
1412
  *
1364
1413
  * @param entityId - UUID of the entity
1365
1414
  * @param recordId - UUID of the record to delete
1415
+ * @param options - Optional {@link EntityDeleteRecordByIdOptions} (e.g. `folderKey` for folder-scoped entities)
1366
1416
  * @returns Promise resolving to void on success
1367
1417
  * @example
1368
1418
  * ```typescript
@@ -1371,9 +1421,12 @@ interface EntityServiceModel {
1371
1421
  * const entities = new Entities(sdk);
1372
1422
  *
1373
1423
  * await entities.deleteRecordById("<entityId>", "<recordId>");
1424
+ *
1425
+ * // Folder-scoped: pass the entity's folder key
1426
+ * await entities.deleteRecordById("<entityId>", "<recordId>", { folderKey: "<folderKey>" });
1374
1427
  * ```
1375
1428
  */
1376
- deleteRecordById(entityId: string, recordId: string): Promise<void>;
1429
+ deleteRecordById(entityId: string, recordId: string, options?: EntityDeleteRecordByIdOptions): Promise<void>;
1377
1430
  /**
1378
1431
  * Queries entity records with filters, sorting, aggregates, and SDK-managed pagination
1379
1432
  *
@@ -1427,6 +1480,7 @@ interface EntityServiceModel {
1427
1480
  *
1428
1481
  * @param id - UUID of the entity
1429
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)
1430
1484
  * @returns Promise resolving to {@link EntityImportRecordsResponse} with record counts
1431
1485
  * @example
1432
1486
  * ```typescript
@@ -1434,16 +1488,19 @@ interface EntityServiceModel {
1434
1488
  * const fileInput = document.getElementById('csv-input') as HTMLInputElement;
1435
1489
  * const result = await entities.importRecordsById(<id>, fileInput.files[0]);
1436
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>" });
1437
1494
  * ```
1438
- * @internal
1439
1495
  */
1440
- importRecordsById(id: string, file: EntityFileType): Promise<EntityImportRecordsResponse>;
1496
+ importRecordsById(id: string, file: EntityFileType, options?: EntityImportRecordsByIdOptions): Promise<EntityImportRecordsResponse>;
1441
1497
  /**
1442
1498
  * Downloads an attachment stored in a File-type field of an entity record.
1443
1499
  *
1444
1500
  * @param entityId - UUID of the entity
1445
1501
  * @param recordId - UUID of the record containing the attachment
1446
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)
1447
1504
  * @returns Promise resolving to Blob containing the file content
1448
1505
  * @example
1449
1506
  * ```typescript
@@ -1490,7 +1547,7 @@ interface EntityServiceModel {
1490
1547
  * fs.writeFileSync('attachment.pdf', buffer);
1491
1548
  * ```
1492
1549
  */
1493
- downloadAttachment(entityId: string, recordId: string, fieldName: string): Promise<Blob>;
1550
+ downloadAttachment(entityId: string, recordId: string, fieldName: string, options?: EntityDownloadAttachmentOptions): Promise<Blob>;
1494
1551
  /**
1495
1552
  * Uploads an attachment to a File-type field of an entity record.
1496
1553
  *
@@ -1500,7 +1557,7 @@ interface EntityServiceModel {
1500
1557
  * @param recordId - UUID of the record to upload the attachment to
1501
1558
  * @param fieldName - Name of the File-type field
1502
1559
  * @param file - File to upload (Blob, File, or Uint8Array)
1503
- * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel)
1560
+ * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. `expansionLevel`, `folderKey` for folder-scoped entities)
1504
1561
  * @returns Promise resolving to {@link EntityUploadAttachmentResponse}
1505
1562
  * @example
1506
1563
  * ```typescript
@@ -1521,6 +1578,9 @@ interface EntityServiceModel {
1521
1578
  * const file = fileInput.files[0];
1522
1579
  * const response = await entities.uploadAttachment(entityId, recordId, 'Documents', file);
1523
1580
  *
1581
+ * // Folder-scoped entity: pass the entity's folder key
1582
+ * await entities.uploadAttachment(entityId, recordId, 'Documents', file, { folderKey: "<folderKey>" });
1583
+ *
1524
1584
  * // Node.js: Upload a file from disk
1525
1585
  * const fileBuffer = fs.readFileSync('document.pdf');
1526
1586
  * const blob = new Blob([fileBuffer], { type: 'application/pdf' });
@@ -1534,6 +1594,7 @@ interface EntityServiceModel {
1534
1594
  * @param entityId - UUID of the entity
1535
1595
  * @param recordId - UUID of the record containing the attachment
1536
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)
1537
1598
  * @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
1538
1599
  * @example
1539
1600
  * ```typescript
@@ -1557,7 +1618,7 @@ interface EntityServiceModel {
1557
1618
  * await entity.deleteAttachment(recordId, 'Documents');
1558
1619
  * ```
1559
1620
  */
1560
- deleteAttachment(entityId: string, recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
1621
+ deleteAttachment(entityId: string, recordId: string, fieldName: string, options?: EntityDeleteAttachmentOptions): Promise<EntityDeleteAttachmentResponse>;
1561
1622
  /**
1562
1623
  * Creates a new Data Fabric entity with the given schema
1563
1624
  *
@@ -1591,14 +1652,18 @@ interface EntityServiceModel {
1591
1652
  * Deletes a Data Fabric entity and all its records
1592
1653
  *
1593
1654
  * @param id - UUID of the entity to delete
1655
+ * @param options - Optional {@link EntityDeleteByIdOptions} (e.g. `folderKey` for folder-scoped entities)
1594
1656
  * @returns Promise resolving when the entity is deleted
1595
1657
  * @example
1596
1658
  * ```typescript
1597
1659
  * await entities.deleteById(<id>);
1660
+ *
1661
+ * // Folder-scoped: pass the entity's folder key
1662
+ * await entities.deleteById(<id>, { folderKey: "<folderKey>" });
1598
1663
  * ```
1599
1664
  * @internal
1600
1665
  */
1601
- deleteById(id: string): Promise<void>;
1666
+ deleteById(id: string, options?: EntityDeleteByIdOptions): Promise<void>;
1602
1667
  /**
1603
1668
  * Updates an existing Data Fabric entity — schema and/or metadata.
1604
1669
  *
@@ -1607,7 +1672,6 @@ interface EntityServiceModel {
1607
1672
  * only when the corresponding fields are provided.
1608
1673
  *
1609
1674
  * @param id - UUID of the entity to update
1610
- * @param name - name of the entity (required by the API)
1611
1675
  * @param options - Changes to apply ({@link EntityUpdateByIdOptions})
1612
1676
  * @returns Promise resolving when the update is complete
1613
1677
  *
@@ -1641,6 +1705,12 @@ interface EntityServiceModel {
1641
1705
  * { id: <fieldId>, lengthLimit: 1000 },
1642
1706
  * ],
1643
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
+ * });
1644
1714
  * ```
1645
1715
  * @internal
1646
1716
  */
@@ -1713,9 +1783,10 @@ interface EntityMethods {
1713
1783
  * Use this method if you need trigger events to fire for the deleted record.
1714
1784
  *
1715
1785
  * @param recordId - UUID of the record to delete
1786
+ * @param options - Optional {@link EntityDeleteRecordByIdOptions} (e.g. `folderKey` for folder-scoped entities)
1716
1787
  * @returns Promise resolving to void on success
1717
1788
  */
1718
- deleteRecord(recordId: string): Promise<void>;
1789
+ deleteRecord(recordId: string, options?: EntityDeleteRecordByIdOptions): Promise<void>;
1719
1790
  /**
1720
1791
  * Get all records from this entity
1721
1792
  *
@@ -1736,16 +1807,17 @@ interface EntityMethods {
1736
1807
  *
1737
1808
  * @param recordId - UUID of the record containing the attachment
1738
1809
  * @param fieldName - Name of the File-type field containing the attachment
1810
+ * @param options - Optional {@link EntityDownloadAttachmentOptions} (e.g. folderKey)
1739
1811
  * @returns Promise resolving to Blob containing the file content
1740
1812
  */
1741
- downloadAttachment(recordId: string, fieldName: string): Promise<Blob>;
1813
+ downloadAttachment(recordId: string, fieldName: string, options?: EntityDownloadAttachmentOptions): Promise<Blob>;
1742
1814
  /**
1743
1815
  * Uploads an attachment to a File-type field of an entity record
1744
1816
  *
1745
1817
  * @param recordId - UUID of the record to upload the attachment to
1746
1818
  * @param fieldName - Name of the File-type field
1747
1819
  * @param file - File to upload (Blob, File, or Uint8Array)
1748
- * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel)
1820
+ * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel, folderKey)
1749
1821
  * @returns Promise resolving to {@link EntityUploadAttachmentResponse}
1750
1822
  */
1751
1823
  uploadAttachment(recordId: string, fieldName: string, file: EntityFileType, options?: EntityUploadAttachmentOptions): Promise<EntityUploadAttachmentResponse>;
@@ -1754,9 +1826,10 @@ interface EntityMethods {
1754
1826
  *
1755
1827
  * @param recordId - UUID of the record containing the attachment
1756
1828
  * @param fieldName - Name of the File-type field containing the attachment
1829
+ * @param options - Optional {@link EntityDeleteAttachmentOptions} (e.g. folderKey)
1757
1830
  * @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
1758
1831
  */
1759
- deleteAttachment(recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
1832
+ deleteAttachment(recordId: string, fieldName: string, options?: EntityDeleteAttachmentOptions): Promise<EntityDeleteAttachmentResponse>;
1760
1833
  /**
1761
1834
  * @deprecated Use {@link insertRecord} instead.
1762
1835
  * @hidden
@@ -1812,6 +1885,7 @@ interface EntityMethods {
1812
1885
  * Imports records from a CSV file into this entity
1813
1886
  *
1814
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)
1815
1889
  * @returns Promise resolving to {@link EntityImportRecordsResponse} with record counts
1816
1890
  * @example
1817
1891
  * ```typescript
@@ -1819,9 +1893,12 @@ interface EntityMethods {
1819
1893
  * const fileInput = document.getElementById('csv-input') as HTMLInputElement;
1820
1894
  * const result = await entity.importRecords(fileInput.files[0]);
1821
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>" });
1822
1899
  * ```
1823
1900
  */
1824
- importRecords(file: EntityFileType): Promise<EntityImportRecordsResponse>;
1901
+ importRecords(file: EntityFileType, options?: EntityImportRecordsByIdOptions): Promise<EntityImportRecordsResponse>;
1825
1902
  /**
1826
1903
  * @deprecated Use {@link getAllRecords} instead.
1827
1904
  * @hidden
@@ -1830,15 +1907,19 @@ interface EntityMethods {
1830
1907
  /**
1831
1908
  * Deletes this entity and all its records
1832
1909
  *
1910
+ * @param options - Optional {@link EntityDeleteByIdOptions} (e.g. `folderKey` for folder-scoped entities)
1833
1911
  * @returns Promise resolving when the entity is deleted
1834
1912
  * @example
1835
1913
  * ```typescript
1836
1914
  * const entity = await entities.getById(<id>);
1837
1915
  * await entity.delete();
1916
+ *
1917
+ * // Folder-scoped entity: pass the entity's folder key
1918
+ * await entity.delete({ folderKey: "<folderKey>" });
1838
1919
  * ```
1839
1920
  * @internal
1840
1921
  */
1841
- delete(): Promise<void>;
1922
+ delete(options?: EntityDeleteByIdOptions): Promise<void>;
1842
1923
  /**
1843
1924
  * Updates this entity — schema and/or metadata.
1844
1925
  *
@@ -1885,6 +1966,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
1885
1966
  * Gets entity metadata by entity ID with attached operation methods
1886
1967
  *
1887
1968
  * @param id - UUID of the entity
1969
+ * @param options - Optional {@link EntityGetByIdOptions} (e.g. `folderKey` for folder-scoped entities)
1888
1970
  * @returns Promise resolving to entity metadata with schema information and operation methods
1889
1971
  *
1890
1972
  * @example
@@ -1894,6 +1976,9 @@ declare class EntityService extends BaseService implements EntityServiceModel {
1894
1976
  * const entities = new Entities(sdk);
1895
1977
  * const entity = await entities.getById("<entityId>");
1896
1978
  *
1979
+ * // Folder-scoped: pass the entity's folder key
1980
+ * const folderEntity = await entities.getById("<entityId>", { folderKey: "<folderKey>" });
1981
+ *
1897
1982
  * // Call operations directly on the entity
1898
1983
  * const records = await entity.getAllRecords();
1899
1984
  *
@@ -1907,7 +1992,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
1907
1992
  * ]);
1908
1993
  * ```
1909
1994
  */
1910
- getById(id: string): Promise<EntityGetResponse>;
1995
+ getById(id: string, options?: EntityGetByIdOptions): Promise<EntityGetResponse>;
1911
1996
  /**
1912
1997
  * Gets entity records by entity ID
1913
1998
  *
@@ -2106,6 +2191,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2106
2191
  *
2107
2192
  * @param entityId - UUID of the entity
2108
2193
  * @param recordId - UUID of the record to delete
2194
+ * @param options - Optional {@link EntityDeleteRecordByIdOptions} (e.g. `folderKey` for folder-scoped entities)
2109
2195
  * @returns Promise resolving to void on success
2110
2196
  * @example
2111
2197
  * ```typescript
@@ -2114,9 +2200,12 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2114
2200
  * const entities = new Entities(sdk);
2115
2201
  *
2116
2202
  * await entities.deleteRecordById("<entityId>", "<recordId>");
2203
+ *
2204
+ * // Folder-scoped: pass the entity's folder key
2205
+ * await entities.deleteRecordById("<entityId>", "<recordId>", { folderKey: "<folderKey>" });
2117
2206
  * ```
2118
2207
  */
2119
- deleteRecordById(entityId: string, recordId: string): Promise<void>;
2208
+ deleteRecordById(entityId: string, recordId: string, options?: EntityDeleteRecordByIdOptions): Promise<void>;
2120
2209
  /**
2121
2210
  * Gets all entities in the system
2122
2211
  *
@@ -2195,6 +2284,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2195
2284
  *
2196
2285
  * @param id - UUID of the entity
2197
2286
  * @param file - CSV file to import (Blob, File, or Uint8Array)
2287
+ * @param options - Optional {@link EntityImportRecordsByIdOptions} (e.g. `folderKey` for folder-scoped entities)
2198
2288
  * @returns Promise resolving to import result with record counts
2199
2289
  *
2200
2290
  * @example
@@ -2215,16 +2305,19 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2215
2305
  * if (result.errorFileLink) {
2216
2306
  * console.log(`Error file link: ${result.errorFileLink}`);
2217
2307
  * }
2308
+ *
2309
+ * // Folder-scoped entity: pass the entity's folder key
2310
+ * await entities.importRecordsById("<entityId>", fileInput.files[0], { folderKey: "<folderKey>" });
2218
2311
  * ```
2219
- * @internal
2220
2312
  */
2221
- importRecordsById(id: string, file: EntityFileType): Promise<EntityImportRecordsResponse>;
2313
+ importRecordsById(id: string, file: EntityFileType, options?: EntityImportRecordsByIdOptions): Promise<EntityImportRecordsResponse>;
2222
2314
  /**
2223
2315
  * Downloads an attachment from an entity record field
2224
2316
  *
2225
2317
  * @param entityId - UUID of the entity
2226
2318
  * @param recordId - UUID of the record containing the attachment
2227
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)
2228
2321
  * @returns Promise resolving to Blob containing the file content
2229
2322
  *
2230
2323
  * @example
@@ -2243,9 +2336,12 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2243
2336
  *
2244
2337
  * // Download attachment for a specific record and field
2245
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>" });
2246
2342
  * ```
2247
2343
  */
2248
- downloadAttachment(entityId: string, recordId: string, fieldName: string): Promise<Blob>;
2344
+ downloadAttachment(entityId: string, recordId: string, fieldName: string, options?: EntityDownloadAttachmentOptions): Promise<Blob>;
2249
2345
  /**
2250
2346
  * Uploads an attachment to a File-type field of an entity record
2251
2347
  *
@@ -2253,7 +2349,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2253
2349
  * @param recordId - UUID of the record to upload the attachment to
2254
2350
  * @param fieldName - Name of the File-type field
2255
2351
  * @param file - File to upload (Blob, File, or Uint8Array)
2256
- * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel)
2352
+ * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. `expansionLevel`, `folderKey` for folder-scoped entities)
2257
2353
  * @returns Promise resolving to {@link EntityUploadAttachmentResponse}
2258
2354
  *
2259
2355
  * @example
@@ -2272,6 +2368,9 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2272
2368
  *
2273
2369
  * // Upload a file attachment
2274
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>" });
2275
2374
  * ```
2276
2375
  */
2277
2376
  uploadAttachment(entityId: string, recordId: string, fieldName: string, file: EntityFileType, options?: EntityUploadAttachmentOptions): Promise<EntityUploadAttachmentResponse>;
@@ -2281,6 +2380,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2281
2380
  * @param entityId - UUID of the entity
2282
2381
  * @param recordId - UUID of the record containing the attachment
2283
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)
2284
2384
  * @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
2285
2385
  *
2286
2386
  * @example
@@ -2299,9 +2399,12 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2299
2399
  *
2300
2400
  * // Delete attachment for a specific record and field
2301
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>" });
2302
2405
  * ```
2303
2406
  */
2304
- deleteAttachment(entityId: string, recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
2407
+ deleteAttachment(entityId: string, recordId: string, fieldName: string, options?: EntityDeleteAttachmentOptions): Promise<EntityDeleteAttachmentResponse>;
2305
2408
  /**
2306
2409
  * @hidden
2307
2410
  * @deprecated Use {@link getAllRecords} instead.
@@ -2347,15 +2450,19 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2347
2450
  * Deletes a Data Fabric entity and all its records
2348
2451
  *
2349
2452
  * @param id - UUID of the entity to delete
2453
+ * @param options - Optional {@link EntityDeleteByIdOptions} (e.g. `folderKey` for folder-scoped entities)
2350
2454
  * @returns Promise resolving when the entity is deleted
2351
2455
  *
2352
2456
  * @example
2353
2457
  * ```typescript
2354
2458
  * await entities.deleteById("<entityId>");
2459
+ *
2460
+ * // Folder-scoped: pass the entity's folder key
2461
+ * await entities.deleteById("<entityId>", { folderKey: "<folderKey>" });
2355
2462
  * ```
2356
2463
  * @internal
2357
2464
  */
2358
- deleteById(id: string): Promise<void>;
2465
+ deleteById(id: string, options?: EntityDeleteByIdOptions): Promise<void>;
2359
2466
  /**
2360
2467
  * Updates an existing Data Fabric entity — schema and/or metadata.
2361
2468
  *
@@ -2401,6 +2508,12 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2401
2508
  * { id: "<fieldId>", lengthLimit: 1000 },
2402
2509
  * ],
2403
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
+ * });
2404
2517
  * ```
2405
2518
  * @internal
2406
2519
  */
@@ -2469,8 +2582,6 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2469
2582
  * override the defaults where the type accepts overrides.
2470
2583
  */
2471
2584
  private buildSqlTypeConstraints;
2472
- private static readonly RESERVED_FIELD_NAMES;
2473
- private validateName;
2474
2585
  }
2475
2586
 
2476
2587
  /**
@@ -3013,6 +3124,20 @@ interface GetTopFaultedCountResponse extends GetTopBaseResponse {
3013
3124
  /** Number of faulted instances in the given time range */
3014
3125
  faultedCount: number;
3015
3126
  }
3127
+ /**
3128
+ * SDK response for top elements with failure.
3129
+ * Shared by both MaestroProcesses and Cases — no service-specific enrichment.
3130
+ */
3131
+ interface ElementGetTopFailedCountResponse {
3132
+ /** BPMN element name (falls back to element ID if name is empty) */
3133
+ elementName: string;
3134
+ /** BPMN element type (e.g. ServiceTask, ReceiveTask, IntermediateCatchEvent) */
3135
+ elementType: string;
3136
+ /** The unique process key this element belongs to */
3137
+ processKey: string;
3138
+ /** Number of failed executions of this element in the given time range */
3139
+ failedCount: number;
3140
+ }
3016
3141
  /**
3017
3142
  * Time bucketing granularity for insights time-series queries.
3018
3143
  *
@@ -3069,6 +3194,35 @@ interface GetTopDurationResponse extends GetTopBaseResponse {
3069
3194
  /** Total execution duration in milliseconds */
3070
3195
  duration: number;
3071
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
+ }
3072
3226
 
3073
3227
  /**
3074
3228
  * Maestro Process Types
@@ -3338,6 +3492,44 @@ interface MaestroProcessesServiceModel {
3338
3492
  * ```
3339
3493
  */
3340
3494
  getTopFaultedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopFaultedCountResponse[]>;
3495
+ /**
3496
+ * Get the top 10 BPMN elements ranked by failure count within a time range.
3497
+ *
3498
+ * Returns an array of up to 10 elements sorted by how many times they failed,
3499
+ * useful for identifying the most error-prone activities in processes.
3500
+ *
3501
+ * @param startTime - Start of the time range to query
3502
+ * @param endTime - End of the time range to query
3503
+ * @param options - Optional filters (packageId, processKey, version)
3504
+ * @returns Promise resolving to an array of {@link ElementGetTopFailedCountResponse}
3505
+ * @example
3506
+ * ```typescript
3507
+ * import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
3508
+ *
3509
+ * const maestroProcesses = new MaestroProcesses(sdk);
3510
+ *
3511
+ * // Get top failing elements for the last 7 days
3512
+ * const topFailing = await maestroProcesses.getTopElementFailedCount(
3513
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
3514
+ * new Date()
3515
+ * );
3516
+ *
3517
+ * for (const element of topFailing) {
3518
+ * console.log(`${element.elementName} (${element.elementType}): ${element.failedCount} failures`);
3519
+ * }
3520
+ * ```
3521
+ *
3522
+ * @example
3523
+ * ```typescript
3524
+ * // Get top failing elements for a specific process
3525
+ * const filtered = await maestroProcesses.getTopElementFailedCount(
3526
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
3527
+ * new Date(),
3528
+ * { processKey: '<processKey>' }
3529
+ * );
3530
+ * ```
3531
+ */
3532
+ getTopElementFailedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ElementGetTopFailedCountResponse[]>;
3341
3533
  /**
3342
3534
  * Get all instances status counts aggregated by date for maestro processes.
3343
3535
  *
@@ -3417,6 +3609,38 @@ interface MaestroProcessesServiceModel {
3417
3609
  * ```
3418
3610
  */
3419
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[]>;
3420
3644
  }
3421
3645
  interface ProcessMethods {
3422
3646
  /**
@@ -3425,6 +3649,15 @@ interface ProcessMethods {
3425
3649
  * @returns Promise resolving to array of process incidents
3426
3650
  */
3427
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[]>;
3428
3661
  }
3429
3662
  type MaestroProcessGetAllResponse = RawMaestroProcessGetAllResponse & ProcessMethods;
3430
3663
  /**
@@ -3517,8 +3750,7 @@ interface ProcessInstanceExecutionHistoryResponse {
3517
3750
  startedTime: string;
3518
3751
  endTime: string | null;
3519
3752
  attributes: string | null;
3520
- createdTime: string;
3521
- updatedTime?: string;
3753
+ updatedTime: string;
3522
3754
  expiredTime: string | null;
3523
3755
  }
3524
3756
  /**
@@ -3707,24 +3939,26 @@ interface ProcessInstancesServiceModel {
3707
3939
  /**
3708
3940
  * Get execution history (spans) for a process instance
3709
3941
  * @param instanceId The ID of the instance to get history for
3942
+ * @param folderKey The folder key for authorization
3710
3943
  * @returns Promise resolving to execution history
3711
3944
  * {@link ProcessInstanceExecutionHistoryResponse}
3712
3945
  * @example
3713
3946
  * ```typescript
3714
3947
  * // Get execution history for a process instance
3715
3948
  * const history = await processInstances.getExecutionHistory(
3716
- * <instanceId>
3949
+ * <instanceId>,
3950
+ * <folderKey>
3717
3951
  * );
3718
3952
  *
3719
3953
  * // Analyze execution timeline
3720
3954
  * history.forEach(span => {
3721
3955
  * console.log(`Activity: ${span.name}`);
3722
- * console.log(`Start: ${span.startTime}`);
3723
- * console.log(`Duration: ${span.duration}ms`);
3956
+ * console.log(`Start: ${span.startedTime}`);
3957
+ * console.log(`End: ${span.endTime}`);
3724
3958
  * });
3725
3959
  * ```
3726
3960
  */
3727
- getExecutionHistory(instanceId: string): Promise<ProcessInstanceExecutionHistoryResponse[]>;
3961
+ getExecutionHistory(instanceId: string, folderKey: string): Promise<ProcessInstanceExecutionHistoryResponse[]>;
3728
3962
  /**
3729
3963
  * Get BPMN XML file for a process instance
3730
3964
  * @param instanceId The ID of the instance to get BPMN for
@@ -4040,8 +4274,7 @@ interface CaseGetTopDurationResponse extends GetTopDurationResponse {
4040
4274
  */
4041
4275
  interface CasesServiceModel {
4042
4276
  /**
4043
- * @returns Promise resolving to array of Case objects
4044
- * {@link CaseGetAllResponse}
4277
+ * @returns Promise resolving to an array of {@link CaseGetAllWithMethodsResponse}
4045
4278
  * @example
4046
4279
  * ```typescript
4047
4280
  * // Get all case management processes
@@ -4055,7 +4288,7 @@ interface CasesServiceModel {
4055
4288
  * }
4056
4289
  * ```
4057
4290
  */
4058
- getAll(): Promise<CaseGetAllResponse[]>;
4291
+ getAll(): Promise<CaseGetAllWithMethodsResponse[]>;
4059
4292
  /**
4060
4293
  * Get the top 5 case processes ranked by run count within a time range.
4061
4294
  *
@@ -4132,6 +4365,44 @@ interface CasesServiceModel {
4132
4365
  * ```
4133
4366
  */
4134
4367
  getTopFaultedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopFaultedCountResponse[]>;
4368
+ /**
4369
+ * Get the top 10 BPMN elements ranked by failure count within a time range.
4370
+ *
4371
+ * Returns an array of up to 10 elements sorted by how many times they failed,
4372
+ * useful for identifying the most error-prone activities in case processes.
4373
+ *
4374
+ * @param startTime - Start of the time range to query
4375
+ * @param endTime - End of the time range to query
4376
+ * @param options - Optional filters (packageId, processKey, version)
4377
+ * @returns Promise resolving to an array of {@link ElementGetTopFailedCountResponse}
4378
+ * @example
4379
+ * ```typescript
4380
+ * import { Cases } from '@uipath/uipath-typescript/cases';
4381
+ *
4382
+ * const cases = new Cases(sdk);
4383
+ *
4384
+ * // Get top failing elements for the last 7 days
4385
+ * const topFailing = await cases.getTopElementFailedCount(
4386
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
4387
+ * new Date()
4388
+ * );
4389
+ *
4390
+ * for (const element of topFailing) {
4391
+ * console.log(`${element.elementName} (${element.elementType}): ${element.failedCount} failures`);
4392
+ * }
4393
+ * ```
4394
+ *
4395
+ * @example
4396
+ * ```typescript
4397
+ * // Get top failing elements for a specific process
4398
+ * const filtered = await cases.getTopElementFailedCount(
4399
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
4400
+ * new Date(),
4401
+ * { processKey: '<processKey>' }
4402
+ * );
4403
+ * ```
4404
+ */
4405
+ getTopElementFailedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ElementGetTopFailedCountResponse[]>;
4135
4406
  /**
4136
4407
  * Get all instances status counts aggregated by date for case management processes.
4137
4408
  *
@@ -4211,7 +4482,58 @@ interface CasesServiceModel {
4211
4482
  * ```
4212
4483
  */
4213
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[]>;
4214
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;
4215
4537
 
4216
4538
  /**
4217
4539
  * Case Instance Types
@@ -5578,6 +5900,44 @@ declare class MaestroProcessesService extends BaseService implements MaestroProc
5578
5900
  * ```
5579
5901
  */
5580
5902
  getTopRunCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopRunCountResponse[]>;
5903
+ /**
5904
+ * Get the top 10 BPMN elements ranked by failure count within a time range.
5905
+ *
5906
+ * Returns an array of up to 10 elements sorted by how many times they failed,
5907
+ * useful for identifying the most error-prone activities in processes.
5908
+ *
5909
+ * @param startTime - Start of the time range to query
5910
+ * @param endTime - End of the time range to query
5911
+ * @param options - Optional filters (packageId, processKey, version)
5912
+ * @returns Promise resolving to an array of {@link ElementGetTopFailedCountResponse}
5913
+ * @example
5914
+ * ```typescript
5915
+ * import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
5916
+ *
5917
+ * const maestroProcesses = new MaestroProcesses(sdk);
5918
+ *
5919
+ * // Get top failing elements for the last 7 days
5920
+ * const topFailing = await maestroProcesses.getTopElementFailedCount(
5921
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
5922
+ * new Date()
5923
+ * );
5924
+ *
5925
+ * for (const element of topFailing) {
5926
+ * console.log(`${element.elementName} (${element.elementType}): ${element.failedCount} failures`);
5927
+ * }
5928
+ * ```
5929
+ *
5930
+ * @example
5931
+ * ```typescript
5932
+ * // Get top failing elements for a specific process
5933
+ * const filtered = await maestroProcesses.getTopElementFailedCount(
5934
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
5935
+ * new Date(),
5936
+ * { processKey: '<processKey>' }
5937
+ * );
5938
+ * ```
5939
+ */
5940
+ getTopElementFailedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ElementGetTopFailedCountResponse[]>;
5581
5941
  /**
5582
5942
  * Get all instances status counts aggregated by date for maestro processes.
5583
5943
  *
@@ -5695,6 +6055,38 @@ declare class MaestroProcessesService extends BaseService implements MaestroProc
5695
6055
  * ```
5696
6056
  */
5697
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[]>;
5698
6090
  }
5699
6091
 
5700
6092
  declare class ProcessInstancesService extends BaseService implements ProcessInstancesServiceModel {
@@ -5749,9 +6141,27 @@ declare class ProcessInstancesService extends BaseService implements ProcessInst
5749
6141
  /**
5750
6142
  * Get execution history (spans) for a process instance
5751
6143
  * @param instanceId The ID of the instance to get history for
5752
- * @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
+ * ```
5753
6162
  */
5754
- getExecutionHistory(instanceId: string): Promise<ProcessInstanceExecutionHistoryResponse[]>;
6163
+ getExecutionHistory(instanceId: string, folderKey: string): Promise<ProcessInstanceExecutionHistoryResponse[]>;
6164
+ private mapSpanToHistory;
5755
6165
  /**
5756
6166
  * Get BPMN XML file for a process instance
5757
6167
  * @param instanceId The ID of the instance to get BPMN for
@@ -5856,7 +6266,7 @@ declare class ProcessIncidentsService extends BaseService implements ProcessInci
5856
6266
  declare class CasesService extends BaseService implements CasesServiceModel {
5857
6267
  /**
5858
6268
  * Get all case management processes with their instance statistics
5859
- * @returns Promise resolving to array of Case objects
6269
+ * @returns Promise resolving to an array of {@link CaseGetAllWithMethodsResponse}
5860
6270
  *
5861
6271
  * @example
5862
6272
  * ```typescript
@@ -5873,7 +6283,7 @@ declare class CasesService extends BaseService implements CasesServiceModel {
5873
6283
  * }
5874
6284
  * ```
5875
6285
  */
5876
- getAll(): Promise<CaseGetAllResponse[]>;
6286
+ getAll(): Promise<CaseGetAllWithMethodsResponse[]>;
5877
6287
  /**
5878
6288
  * Get the top 5 case processes ranked by run count within a time range.
5879
6289
  *
@@ -5912,6 +6322,44 @@ declare class CasesService extends BaseService implements CasesServiceModel {
5912
6322
  * ```
5913
6323
  */
5914
6324
  getTopRunCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopRunCountResponse[]>;
6325
+ /**
6326
+ * Get the top 10 BPMN elements ranked by failure count within a time range.
6327
+ *
6328
+ * Returns an array of up to 10 elements sorted by how many times they failed,
6329
+ * useful for identifying the most error-prone activities in case processes.
6330
+ *
6331
+ * @param startTime - Start of the time range to query
6332
+ * @param endTime - End of the time range to query
6333
+ * @param options - Optional filters (packageId, processKey, version)
6334
+ * @returns Promise resolving to an array of {@link ElementGetTopFailedCountResponse}
6335
+ * @example
6336
+ * ```typescript
6337
+ * import { Cases } from '@uipath/uipath-typescript/cases';
6338
+ *
6339
+ * const cases = new Cases(sdk);
6340
+ *
6341
+ * // Get top failing elements for the last 7 days
6342
+ * const topFailing = await cases.getTopElementFailedCount(
6343
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
6344
+ * new Date()
6345
+ * );
6346
+ *
6347
+ * for (const element of topFailing) {
6348
+ * console.log(`${element.elementName} (${element.elementType}): ${element.failedCount} failures`);
6349
+ * }
6350
+ * ```
6351
+ *
6352
+ * @example
6353
+ * ```typescript
6354
+ * // Get top failing elements for a specific process
6355
+ * const filtered = await cases.getTopElementFailedCount(
6356
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
6357
+ * new Date(),
6358
+ * { processKey: '<processKey>' }
6359
+ * );
6360
+ * ```
6361
+ */
6362
+ getTopElementFailedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ElementGetTopFailedCountResponse[]>;
5915
6363
  /**
5916
6364
  * Get all instances status counts aggregated by date for case management processes.
5917
6365
  *
@@ -6029,6 +6477,37 @@ declare class CasesService extends BaseService implements CasesServiceModel {
6029
6477
  * ```
6030
6478
  */
6031
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[]>;
6032
6511
  /**
6033
6512
  * Extract a readable case name from the packageId
6034
6513
  * @param packageId - The full package identifier
@@ -6343,14 +6822,10 @@ declare enum AssetValueScope {
6343
6822
  * Enum for Asset Value Type
6344
6823
  */
6345
6824
  declare enum AssetValueType {
6346
- DBConnectionString = "DBConnectionString",
6347
- HttpConnectionString = "HttpConnectionString",
6348
6825
  Text = "Text",
6349
6826
  Bool = "Bool",
6350
6827
  Integer = "Integer",
6351
6828
  Credential = "Credential",
6352
- WindowsCredential = "WindowsCredential",
6353
- KeyValueList = "KeyValueList",
6354
6829
  Secret = "Secret"
6355
6830
  }
6356
6831
  /**
@@ -6400,11 +6875,25 @@ interface AssetGetByIdOptions extends BaseOptions {
6400
6875
  */
6401
6876
  interface AssetGetByNameOptions extends FolderScopedOptions {
6402
6877
  }
6403
-
6404
6878
  /**
6405
- * Service for managing UiPath Assets.
6879
+ * New value accepted by {@link AssetServiceModel.updateValueById}.
6406
6880
  *
6407
- * Assets are key-value pairs that can be used to store configuration data, credentials, and other settings used by automation processes. [UiPath Assets Guide](https://docs.uipath.com/orchestrator/automation-cloud/latest/user-guide/about-assets)
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
+ }
6892
+
6893
+ /**
6894
+ * Service for managing UiPath Assets.
6895
+ *
6896
+ * Assets are key-value pairs that can be used to store configuration data, credentials, and other settings used by automation processes. [UiPath Assets Guide](https://docs.uipath.com/orchestrator/automation-cloud/latest/user-guide/about-assets)
6408
6897
  *
6409
6898
  * ### Usage
6410
6899
  *
@@ -6484,6 +6973,38 @@ interface AssetServiceModel {
6484
6973
  * ```
6485
6974
  */
6486
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>;
6487
7008
  }
6488
7009
 
6489
7010
  /**
@@ -6571,6 +7092,42 @@ declare class AssetService extends FolderScopedService implements AssetServiceMo
6571
7092
  * ```
6572
7093
  */
6573
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>;
6574
7131
  }
6575
7132
 
6576
7133
  declare enum BucketOptions {
@@ -9456,11 +10013,12 @@ interface Exchange {
9456
10013
  }
9457
10014
  /**
9458
10015
  * Optional configuration options for when the service automatically starts agent job(s) to serve the conversation.
9459
- * When not provided, service uses default configuration with RunAsMe set to false.
10016
+ * When not provided, service uses recommended default configurations.
9460
10017
  */
9461
10018
  interface ConversationJobStartOverrides {
9462
10019
  /**
9463
- * 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.
9464
10022
  */
9465
10023
  runAsMe?: boolean;
9466
10024
  }
@@ -9565,30 +10123,11 @@ interface ContentPartInterrupted {
9565
10123
  */
9566
10124
  interface SessionCapabilities {
9567
10125
  /**
9568
- * Indicates the sender may produce a cross exchange input stream events if the receiver indicates they can be handled.
9569
- */
9570
- asyncInputStreamEmitter?: boolean;
9571
- /**
9572
- * Indicates the sender can handle cross exchange input stream events.
9573
- */
9574
- asyncInputStreamHandler?: boolean;
9575
- /**
9576
- * Indicates the sender may produce cross exchange tool calls if the receiver indicates they can be handled.
9577
- */
9578
- asyncToolCallEmitter?: boolean;
9579
- /**
9580
- * Indicates the sender can handle cross exchange tool calls.
9581
- */
9582
- asyncToolCallHandler?: boolean;
9583
- /**
9584
- * Indicates the mime types which the sender can send in input streams and as message content, provided the receiver
9585
- * indicates they can handle the mime type.
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.
9586
10129
  */
9587
- mimeTypesEmitted?: string[];
9588
- /**
9589
- * Indicates the mime types the sender can handle. Wildcards such as "*\/*" and "text/*" are allowed.
9590
- */
9591
- mimeTypesHandled?: string[];
10130
+ serviceMessageClient?: boolean;
9592
10131
  /** Allow custom properties */
9593
10132
  [key: string]: unknown;
9594
10133
  }
@@ -12378,28 +12917,49 @@ interface FeedbackCreateResponse {
12378
12917
  */
12379
12918
  interface ExchangeServiceModel {
12380
12919
  /**
12381
- * 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.
12382
12925
  *
12383
12926
  * @param conversationId - The conversation ID to get exchanges for
12384
12927
  * @param options - Options for querying exchanges including optional pagination parameters
12385
- * @returns Promise resolving to either an array of exchanges {@link NonPaginatedResponse}<{@link ExchangeGetResponse}> or a {@link PaginatedResponse}<{@link ExchangeGetResponse}> when pagination options are used
12386
- * @example
12387
- * ```typescript
12388
- * // Get all exchanges (non-paginated)
12389
- * const conversationExchanges = await exchanges.getAll(conversationId);
12928
+ * @returns Promise resolving to a {@link PaginatedResponse}<{@link ExchangeGetResponse}>
12390
12929
  *
12391
- * // First page with pagination
12392
- * 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);
12393
12934
  *
12394
12935
  * // Navigate using cursor
12395
- * if (firstPageOfExchanges.hasNextPage) {
12396
- * const nextPageOfExchanges = await exchanges.getAll(conversationId, {
12397
- * 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
12398
12958
  * });
12399
12959
  * }
12400
12960
  * ```
12401
12961
  */
12402
- 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>>;
12403
12963
  /**
12404
12964
  * Gets an exchange by ID with its messages
12405
12965
  *
@@ -12443,26 +13003,53 @@ interface ExchangeServiceModel {
12443
13003
  */
12444
13004
  interface ConversationExchangeServiceModel {
12445
13005
  /**
12446
- * 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.
12447
13011
  *
12448
13012
  * @param options - Options for querying exchanges including optional pagination parameters
12449
- * @returns Promise resolving to either an array of exchanges or a paginated response
13013
+ * @returns Promise resolving to a {@link PaginatedResponse}<{@link ExchangeGetResponse}>
12450
13014
  *
12451
- * @example
13015
+ * @example Basic usage - default page size and sort order
12452
13016
  * ```typescript
12453
13017
  * const conversation = await conversationalAgent.conversations.getById(conversationId);
12454
13018
  *
12455
- * // Get all exchanges
12456
- * const allExchanges = await conversation.exchanges.getAll();
13019
+ * // First page
13020
+ * const firstPage = await conversation.exchanges.getAll();
12457
13021
  *
12458
- * // With pagination
12459
- * const firstPage = await conversation.exchanges.getAll({ pageSize: 10 });
13022
+ * // Navigate using cursor
12460
13023
  * if (firstPage.hasNextPage) {
12461
13024
  * const nextPage = await conversation.exchanges.getAll({ cursor: firstPage.nextCursor });
12462
13025
  * }
12463
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
+ * ```
12464
13051
  */
12465
- getAll<T extends ExchangeGetAllOptions = ExchangeGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ExchangeGetResponse> : NonPaginatedResponse<ExchangeGetResponse>>;
13052
+ getAll(options?: ExchangeGetAllOptions): Promise<PaginatedResponse<ExchangeGetResponse>>;
12466
13053
  /**
12467
13054
  * Gets an exchange by ID with its messages
12468
13055
  *
@@ -12618,28 +13205,23 @@ interface ConversationServiceModel {
12618
13205
  */
12619
13206
  create(agentId: number, folderId: number, options?: ConversationCreateOptions): Promise<ConversationCreateResponse>;
12620
13207
  /**
12621
- * Gets all conversations with optional filtering and pagination
13208
+ * Gets conversations with pagination and optional sort/filter parameters
12622
13209
  *
12623
- * The method returns either:
12624
- * - A NonPaginatedResponse with items array (when no pagination parameters are provided)
12625
- * - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
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.
12626
13213
  *
12627
- * @param options - Options for querying conversations including optional pagination parameters
12628
- * @returns Promise resolving to either an array of conversations {@link NonPaginatedResponse}<{@link ConversationGetResponse}> or a {@link PaginatedResponse}<{@link ConversationGetResponse}> when pagination options are used
13214
+ * @param options - Options for querying conversations
13215
+ * @returns Promise resolving to a {@link PaginatedResponse}<{@link ConversationGetResponse}>
12629
13216
  *
12630
- * @example Basic usage - get all conversations
13217
+ * @example Basic usage - default sort, pagination, and without filtering
12631
13218
  * ```typescript
12632
- * const allConversations = await conversationalAgent.conversations.getAll();
13219
+ * // First page
13220
+ * const firstPage = await conversationalAgent.conversations.getAll();
12633
13221
  *
12634
- * for (const conversation of allConversations.items) {
13222
+ * for (const conversation of firstPage.items) {
12635
13223
  * console.log(`${conversation.label} - created: ${conversation.createdTime}`);
12636
13224
  * }
12637
- * ```
12638
- *
12639
- * @example With pagination
12640
- * ```typescript
12641
- * // First page
12642
- * const firstPage = await conversationalAgent.conversations.getAll({ pageSize: 10 });
12643
13225
  *
12644
13226
  * // Navigate using cursor
12645
13227
  * if (firstPage.hasNextPage) {
@@ -12649,23 +13231,44 @@ interface ConversationServiceModel {
12649
13231
  * }
12650
13232
  * ```
12651
13233
  *
12652
- * @example Sorted with limit
13234
+ * @example With explicit page size and sort order (by last-activity timestamp)
12653
13235
  * ```typescript
12654
- * const result = await conversationalAgent.conversations.getAll({
12655
- * sort: SortOrder.Descending,
12656
- * 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
12657
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
+ * }
12658
13252
  * ```
12659
13253
  *
12660
- * @example Filter by agent and search by label
13254
+ * @example With agent-filter and label-search
12661
13255
  * ```typescript
12662
- * const filtered = await conversationalAgent.conversations.getAll({
13256
+ * const firstPage = await conversationalAgent.conversations.getAll({
12663
13257
  * agentId: <agentId>,
12664
13258
  * label: 'budget'
12665
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
+ * }
12666
13269
  * ```
12667
13270
  */
12668
- getAll<T extends ConversationGetAllOptions = ConversationGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ConversationGetResponse> : NonPaginatedResponse<ConversationGetResponse>>;
13271
+ getAll(options?: ConversationGetAllOptions): Promise<PaginatedResponse<ConversationGetResponse>>;
12669
13272
  /**
12670
13273
  * Gets a conversation by ID
12671
13274
  *
@@ -13019,6 +13622,11 @@ interface ConversationSessionOptions {
13019
13622
  * ```
13020
13623
  */
13021
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;
13022
13630
  }
13023
13631
  /** Response for creating a conversation (includes methods) */
13024
13632
  interface ConversationCreateResponse extends ConversationGetResponse {
@@ -13054,7 +13662,7 @@ interface ConversationUpdateOptions {
13054
13662
  agentInput?: AgentInput;
13055
13663
  }
13056
13664
  type ConversationGetAllOptions = PaginationOptions & {
13057
- /** Sort order for conversations */
13665
+ /** Sort order for conversations (by the last activity timestamp) */
13058
13666
  sort?: SortOrder;
13059
13667
  /** GUID key of the agent to filter conversations by. */
13060
13668
  agentKey?: string;
@@ -14071,6 +14679,355 @@ interface FeedbackServiceModel {
14071
14679
  deleteCategory(id: string, options?: FeedbackDeleteCategoryOptions): Promise<void>;
14072
14680
  }
14073
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
+
14074
15031
  declare enum DocumentActionPriority {
14075
15032
  Low = "Low",
14076
15033
  Medium = "Medium",
@@ -15281,6 +16238,223 @@ declare namespace index {
15281
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 };
15282
16239
  }
15283
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
+
15284
16458
  /**
15285
16459
  * Error thrown when authorization fails (403 errors)
15286
16460
  * Common scenarios:
@@ -15547,7 +16721,12 @@ declare const track: _uipath_core_telemetry.Track;
15547
16721
  declare const trackEvent: (eventName: string, name?: string, attributes?: _uipath_core_telemetry.TelemetryAttributes) => void;
15548
16722
  declare const telemetryClient: {
15549
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;
15550
16729
  };
15551
16730
 
15552
- export { AgentMap, AssetValueScope, AssetValueType, AuthenticationError, AuthorizationError, BucketOptions, CitationErrorType, ConversationGetAllFilterMap, ConversationMap, DEFAULT_ITEMS_FIELD, DEFAULT_PAGE_SIZE, DEFAULT_TOTAL_COUNT_FIELD, DataDirectionType, DebugMode, index as DuFramework, EntityAggregateFunction, EntityFieldDataType, EntityType, ErrorType, EscalationActionType, EscalationRecipientScope, EscalationTriggerType, ExchangeMap, FeedbackRating, FeedbackStatus, FieldDisplayType, HttpStatus, InputStreamSpeechSensitivity, InstanceFinalStatus, InstanceStatus, InterruptType, JobPriority, JobSourceType, JobState, JobSubState, JobType, JoinType, LogicalOperator$1 as LogicalOperator, MAX_PAGE_SIZE, MessageMap, MessageRole, NetworkError, NotFoundError, PackageSourceType, PackageType, ProcessIncidentSeverity, ProcessIncidentStatus, ProcessIncidentType, QueryFilterOperator, RateLimitError, ReferenceType, RemoteControlAccess, RobotSize, RuntimeType, SLADurationUnit, ServerError, ServerlessJobType, SlaSummaryStatus, SortOrder, StageTaskType, StartStrategy, StopStrategy, TargetFramework, TaskActivityType, TaskPriority, TaskSlaCriteria, TaskSlaStatus, TaskSourceName, TaskStatus, TaskType, TaskUserType, TimeInterval, UiPath, UiPathError, UiPathMetaTags, UserSettingsMap, ValidationError, createAgentWithMethods, createCaseInstanceWithMethods, createConversationWithMethods, createEntityWithMethods, createJobWithMethods, createProcessInstanceWithMethods, createProcessWithMethods, createTaskWithMethods, getAppBase, getAsset, getErrorDetails, getLimitedPageSize, isAuthenticationError, isAuthorizationError, isNetworkError, isNotFoundError, isRateLimitError, isServerError, isUiPathError, isValidationError, loadFromMetaTags, telemetryClient, track, trackEvent };
15553
- export type { AgentAppearance, AgentConversationServiceModel, AgentCreateConversationOptions, AgentGetByIdResponse, AgentGetResponse, AgentInput, AgentMethods, AgentStartingPrompt, ArgumentMetadata, AssetGetAllOptions, AssetGetByIdOptions, AssetGetByNameOptions, AssetGetResponse, AssetServiceModel, AsyncInputStream, AsyncInputStreamChunkEvent, AsyncInputStreamEndEvent, AsyncInputStreamEvent, AsyncInputStreamStartEvent, AsyncToolCallStream, AttachmentGetByIdOptions, AttachmentResponse, AttachmentServiceModel, BaseConfig, BaseOptions, BaseProcessStartRequest, BlobItem, BodyOptions, BpmnXmlString, BucketDeleteFileOptions, BucketFile, BucketGetAllOptions, BucketGetByIdOptions, BucketGetByNameOptions, BucketGetFileMetaDataOptions, BucketGetFileMetaDataResponse, BucketGetFileMetaDataWithPaginationOptions, BucketGetFilesOptions, BucketGetReadUriOptions, BucketGetResponse, BucketGetUriOptions, BucketGetUriResponse, BucketServiceModel, BucketUploadFileOptions, BucketUploadResponse, CaseAppConfig, CaseAppOverview, CaseGetAllResponse, CaseGetStageResponse, CaseGetTopDurationResponse, CaseGetTopFaultedCountResponse, CaseGetTopRunCountResponse, CaseInstanceExecutionHistoryResponse, CaseInstanceGetAllOptions, CaseInstanceGetAllWithPaginationOptions, CaseInstanceGetResponse, CaseInstanceMethods, CaseInstanceOperationOptions, CaseInstanceOperationResponse, CaseInstanceReopenOptions, CaseInstanceRun, CaseInstanceSlaSummaryOptions, CaseInstanceStageSLAOptions, CaseInstanceStageSLAResponse, CaseInstanceStageSLAStage, CaseInstancesServiceModel, CasesServiceModel, ChoiceSetCreateOptions, ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, ChoiceSetUpdateOptions, ChoiceSetValueInsertOptions, ChoiceSetValueInsertResponse, ChoiceSetValueUpdateResponse, Citation, CitationEndEvent, CitationError, CitationEvent, CitationOptions, CitationSource, CitationSourceBase, CitationSourceMedia, CitationSourceUrl, CitationStartEvent, CollectionResponse, CompletedContentPart, CompletedMessage, CompletedToolCall, ContentPart, ContentPartChunkEvent, ContentPartData, ContentPartEndEvent, ContentPartEvent, ContentPartGetResponse, ContentPartInterrupted, ContentPartStartEvent, ContentPartStartMetaData, ContentPartStream, ConversationAttachmentCreateResponse, ConversationAttachmentUploadResponse, ConversationCreateOptions, ConversationCreateResponse, ConversationDeleteResponse, ConversationEvent, ConversationExchangeServiceModel, ConversationGetAllOptions, ConversationGetResponse, ConversationJobStartOverrides, ConversationMethods, ConversationServiceModel, ConversationSessionMethods, ConversationSessionOptions, ConversationUpdateOptions, ConversationUpdateResponse, ConversationalAgentOptions, ConversationalAgentServiceModel, CreateFeedbackOptions, CustomKeyValuePair, ElementExecutionMetadata, ElementMetaData, ElementRunMetadata, EntityAggregate, EntityBatchInsertOptions, EntityBatchInsertResponse, EntityCreateFieldOptions, EntityCreateOptions, EntityDeleteAttachmentResponse, EntityDeleteOptions, EntityDeleteRecordsOptions, EntityDeleteResponse, EntityFieldBase, EntityFieldUpdateOptions, EntityFileType, EntityGetAllRecordsOptions, EntityGetRecordByIdOptions, EntityGetRecordsByIdOptions, EntityGetResponse, EntityImportRecordsResponse, EntityInsertOptions, EntityInsertRecordOptions, EntityInsertRecordsOptions, EntityInsertResponse, EntityMethods, EntityOperationOptions, EntityOperationResponse, EntityQueryFilter, EntityQueryFilterGroup, EntityQueryRecordsOptions, EntityQueryRecordsResponse, EntityQuerySortOption, EntityRecord, EntityRemoveFieldOptions, EntityServiceModel, EntityUpdateByIdOptions, EntityUpdateOptions, EntityUpdateRecordOptions, EntityUpdateRecordResponse, EntityUpdateRecordsOptions, EntityUpdateResponse, EntityUploadAttachmentOptions, EntityUploadAttachmentResponse, ErrorEndEvent, ErrorEvent, ErrorStartEvent, EscalationAction, EscalationRecipient, EscalationRule, EscalationTriggerMetadata, Exchange, ExchangeEndEvent, ExchangeEvent, ExchangeGetAllOptions, ExchangeGetByIdOptions, ExchangeGetResponse, ExchangeServiceModel, ExchangeStartEvent, ExchangeStream, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, ExternalValue, FailureRecord, FeatureFlags, FeedbackCategory, FeedbackCategoryInput, FeedbackCategoryResponse, FeedbackCreateCategoryOptions, FeedbackCreateResponse, FeedbackDeleteCategoryOptions, FeedbackGetAllOptions, FeedbackGetCategoriesOptions, FeedbackGetResponse, FeedbackOptions, FeedbackResponse, FeedbackServiceModel, FeedbackSubmitOptions, FeedbackUpdateOptions, Field$1 as Field, FieldDataType, FieldMetaData, FileUploadAccess, FolderProperties, FolderScopedOptions, GenericInterruptStartEvent, GetTopBaseResponse, GetTopDurationResponse, GetTopFaultedCountResponse, GetTopRunCountResponse, GlobalVariableMetaData, HasPaginationOptions, Headers, HttpMethod, InlineOrExternalValue, InlineValue, InstanceStatusTimelineResponse, Interrupt, InterruptEndEvent, InterruptEvent, InterruptStartEvent, JSONArray, JSONObject, JSONPrimitive, JSONValue, JobAttachment, JobError, JobGetAllOptions, JobGetByIdOptions, JobGetResponse, JobMethods, JobResumeOptions, JobServiceModel, JobStopOptions, LabelUpdatedEvent, Machine, MaestroProcessGetAllResponse, MaestroProcessesServiceModel, MakeOptional, MakeRequired, Message, MessageEndEvent, MessageEvent, MessageGetResponse, MessageServiceModel, MessageStartEvent, MessageStream, MetaData, MetaEvent, NonPaginatedResponse, OAuthFields, OperationResponse, PaginatedResponse, PaginationCursor, PaginationMetadata, PaginationMethodUnion, PaginationOptions, PartialUiPathConfig, ProcessGetAllOptions, ProcessGetByIdOptions, ProcessGetByNameOptions, ProcessGetResponse, ProcessGetTopDurationResponse, ProcessGetTopFaultedCountResponse, ProcessGetTopRunCountResponse, ProcessIncidentGetAllResponse, ProcessIncidentGetResponse, ProcessIncidentsServiceModel, ProcessInstanceExecutionHistoryResponse, ProcessInstanceGetAllOptions, ProcessInstanceGetAllWithPaginationOptions, ProcessInstanceGetResponse, ProcessInstanceGetVariablesOptions, ProcessInstanceGetVariablesResponse, ProcessInstanceMethods, ProcessInstanceOperationOptions, ProcessInstanceOperationResponse, ProcessInstanceRun, ProcessInstancesServiceModel, ProcessMetadata, ProcessMethods, ProcessProperties, ProcessServiceModel, ProcessStartOptions, ProcessStartRequest, ProcessStartRequestWithKey, ProcessStartRequestWithName, ProcessStartResponse, QueryParams, QueueGetAllOptions, QueueGetByIdOptions, QueueGetResponse, QueueServiceModel, RawAgentGetByIdResponse, RawAgentGetResponse, RawCaseInstanceGetResponse, RawConversationGetResponse, RawEntityGetResponse, RawJobGetResponse, RawMaestroProcessGetAllResponse, RawProcessInstanceGetResponse, RawTaskCreateResponse, RawTaskGetResponse, RequestOptions, RequestSpec, ResponseDictionary, ResponseType, RetryOptions, RobotMetadata, SessionCapabilities, SessionEndEvent, SessionEndingEvent, SessionStartEvent, SessionStartedEvent, SessionStream, Simplify, SlaSummaryResponse, SourceJoinCriteria, SqlType, StageSLA, StageTask, Tag, TaskActivity, TaskAssignOptions, TaskAssignment, TaskAssignmentOptions, TaskAssignmentResponse, TaskBaseResponse, TaskCompleteOptions, TaskCompletionOptions, TaskCreateOptions, TaskCreateResponse, TaskGetAllOptions, TaskGetByIdOptions, TaskGetResponse, TaskGetUsersOptions, TaskMethods, TaskServiceModel, TaskSlaDetail, TaskSource, TasksUnassignOptions, TimelineOptions, TimeoutOptions, ToolCall, ToolCallConfirmationEndValue, ToolCallConfirmationEvent, ToolCallConfirmationInterruptStartEvent, ToolCallConfirmationValue, ToolCallEndEvent, ToolCallEvent, ToolCallInputValue, ToolCallOutputValue, ToolCallResult, ToolCallStartEvent, ToolCallStream, TopQueryOptions, UiPathSDKConfig, UserLoginInfo, UserSettingsGetResponse, UserSettingsServiceModel, UserSettingsUpdateOptions, UserSettingsUpdateResponse };
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 };