@uipath/uipath-typescript 1.4.0 → 1.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/agent-memory/index.cjs +16 -9
- package/dist/agent-memory/index.mjs +16 -9
- package/dist/agents/index.cjs +278 -9
- package/dist/agents/index.d.ts +465 -6
- package/dist/agents/index.mjs +279 -10
- package/dist/assets/index.cjs +16 -9
- package/dist/assets/index.mjs +16 -9
- package/dist/attachments/index.cjs +16 -9
- package/dist/attachments/index.mjs +16 -9
- package/dist/buckets/index.cjs +114 -124
- package/dist/buckets/index.d.ts +197 -84
- package/dist/buckets/index.mjs +114 -124
- package/dist/cases/index.cjs +79 -13
- package/dist/cases/index.d.ts +30 -3
- package/dist/cases/index.mjs +79 -13
- package/dist/conversational-agent/index.cjs +16 -9
- package/dist/conversational-agent/index.mjs +16 -9
- package/dist/core/index.cjs +35 -6
- package/dist/core/index.mjs +35 -6
- package/dist/document-understanding/index.cjs +84 -84
- package/dist/document-understanding/index.d.ts +2 -1
- package/dist/document-understanding/index.mjs +1 -1
- package/dist/entities/index.cjs +253 -69
- package/dist/entities/index.d.ts +343 -116
- package/dist/entities/index.mjs +253 -69
- package/dist/feedback/index.cjs +16 -9
- package/dist/feedback/index.mjs +16 -9
- package/dist/governance/index.cjs +16 -9
- package/dist/governance/index.mjs +16 -9
- package/dist/index.cjs +529 -193
- package/dist/index.d.ts +2141 -750
- package/dist/index.mjs +529 -194
- package/dist/index.umd.js +529 -193
- package/dist/jobs/index.cjs +16 -9
- package/dist/jobs/index.mjs +16 -9
- package/dist/maestro-processes/index.cjs +16 -9
- package/dist/maestro-processes/index.mjs +16 -9
- package/dist/orchestrator-du-module/index.cjs +1788 -0
- package/dist/orchestrator-du-module/index.d.ts +757 -0
- package/dist/orchestrator-du-module/index.mjs +1785 -0
- package/dist/processes/index.cjs +16 -9
- package/dist/processes/index.mjs +16 -9
- package/dist/queues/index.cjs +16 -9
- package/dist/queues/index.mjs +16 -9
- package/dist/tasks/index.cjs +79 -13
- package/dist/tasks/index.d.ts +109 -4
- package/dist/tasks/index.mjs +80 -14
- package/dist/traces/index.cjs +303 -9
- package/dist/traces/index.d.ts +482 -2
- package/dist/traces/index.mjs +302 -10
- package/package.json +11 -1
package/dist/index.d.ts
CHANGED
|
@@ -483,6 +483,24 @@ declare class BaseService {
|
|
|
483
483
|
private determineHasMorePages;
|
|
484
484
|
}
|
|
485
485
|
|
|
486
|
+
/**
|
|
487
|
+
* Shared types for the Data Fabric domain — used by both Entities and ChoiceSets.
|
|
488
|
+
* Lives here (not in either service's `*.types.ts`) to avoid cross-domain coupling
|
|
489
|
+
* between sibling services.
|
|
490
|
+
*/
|
|
491
|
+
/**
|
|
492
|
+
* Common shape for every folder-scoped Data Fabric operation.
|
|
493
|
+
* Forwarded on the wire as the `X-UIPATH-FolderKey` header.
|
|
494
|
+
*/
|
|
495
|
+
interface EntityFolderScopedOptions {
|
|
496
|
+
/**
|
|
497
|
+
* Key identifying the folder the entity belongs to. Omit for tenant-level entities.
|
|
498
|
+
*
|
|
499
|
+
* @experimental Folder-scoped Data Fabric is in preview — the contract may change.
|
|
500
|
+
*/
|
|
501
|
+
folderKey?: string;
|
|
502
|
+
}
|
|
503
|
+
|
|
486
504
|
/**
|
|
487
505
|
* Entity field data type names (SQL-level types returned by the API)
|
|
488
506
|
*/
|
|
@@ -599,14 +617,8 @@ interface EntityDeleteOptions extends EntityFolderScopedOptions {
|
|
|
599
617
|
*/
|
|
600
618
|
interface EntityDeleteRecordsOptions extends EntityDeleteOptions {
|
|
601
619
|
}
|
|
602
|
-
/**
|
|
603
|
-
* Options for {@link EntityServiceModel.deleteRecordById}
|
|
604
|
-
*/
|
|
605
620
|
interface EntityDeleteRecordByIdOptions extends EntityFolderScopedOptions {
|
|
606
621
|
}
|
|
607
|
-
/**
|
|
608
|
-
* Options for {@link EntityServiceModel.importRecordsById}
|
|
609
|
-
*/
|
|
610
622
|
interface EntityImportRecordsByIdOptions extends EntityFolderScopedOptions {
|
|
611
623
|
}
|
|
612
624
|
/**
|
|
@@ -773,23 +785,25 @@ interface EntityCreateFieldOptions extends EntityFieldBase {
|
|
|
773
785
|
referenceEntityId?: string;
|
|
774
786
|
/** UUID of the referenced field on the target entity (required when `type` is `RELATIONSHIP` or `FILE`) */
|
|
775
787
|
referenceFieldId?: string;
|
|
788
|
+
/**
|
|
789
|
+
* Folder key of the reference target when it lives outside the source's folder. Pass `'00000000-0000-0000-0000-000000000000'` for tenant-level system targets.
|
|
790
|
+
*
|
|
791
|
+
* @experimental Folder-scoped Data Fabric is in preview — the contract may change.
|
|
792
|
+
*/
|
|
793
|
+
referenceFolderKey?: string;
|
|
776
794
|
}
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
795
|
+
interface EntityGetAllOptions extends EntityFolderScopedOptions {
|
|
796
|
+
/**
|
|
797
|
+
* When `true`, returns tenant-level and folder-level entities together.
|
|
798
|
+
* Omit (or `false`, the default) to return only tenant-level entities.
|
|
799
|
+
* Ignored when `folderKey` is provided — `folderKey` is preferred over `includeFolderEntities` when both are set.
|
|
800
|
+
*
|
|
801
|
+
* @experimental Folder-scoped Data Fabric is in preview — the contract may change.
|
|
802
|
+
*/
|
|
803
|
+
includeFolderEntities?: boolean;
|
|
784
804
|
}
|
|
785
|
-
/**
|
|
786
|
-
* Options for {@link EntityServiceModel.getById}
|
|
787
|
-
*/
|
|
788
805
|
interface EntityGetByIdOptions extends EntityFolderScopedOptions {
|
|
789
806
|
}
|
|
790
|
-
/**
|
|
791
|
-
* Options for {@link EntityServiceModel.deleteById}
|
|
792
|
-
*/
|
|
793
807
|
interface EntityDeleteByIdOptions extends EntityFolderScopedOptions {
|
|
794
808
|
}
|
|
795
809
|
/**
|
|
@@ -1134,23 +1148,35 @@ interface RawEntityGetResponse {
|
|
|
1134
1148
|
*/
|
|
1135
1149
|
interface EntityServiceModel {
|
|
1136
1150
|
/**
|
|
1137
|
-
* Gets
|
|
1151
|
+
* Gets entities in the tenant.
|
|
1152
|
+
*
|
|
1153
|
+
* Three call modes:
|
|
1154
|
+
* - `getAll()` — default. Returns only tenant-level entities.
|
|
1155
|
+
* - `getAll({ folderKey: "<uuid>" })` — preferred for folder-scoped data. Returns only entities in that folder.
|
|
1156
|
+
* - `getAll({ includeFolderEntities: true })` — returns tenant-level **and** folder-level entities together. `folderKey` is preferred over `includeFolderEntities` when both are set.
|
|
1138
1157
|
*
|
|
1139
|
-
* @
|
|
1158
|
+
* @param options - Optional {@link EntityGetAllOptions} (`folderKey` to list a single folder's entities — preferred when scoping to a folder; `includeFolderEntities: true` to list tenant + folder entities together) The `folderKey` property is **experimental**.
|
|
1159
|
+
* @returns Promise resolving to an array of entity metadata
|
|
1140
1160
|
* {@link EntityGetResponse}
|
|
1141
1161
|
* @example
|
|
1142
1162
|
* ```typescript
|
|
1143
|
-
* //
|
|
1144
|
-
* const
|
|
1163
|
+
* // Tenant-only (default)
|
|
1164
|
+
* const tenantEntities = await entities.getAll();
|
|
1165
|
+
*
|
|
1166
|
+
* // A single folder's entities (preferred when targeting a specific folder)
|
|
1167
|
+
* const folderEntities = await entities.getAll({ folderKey: "<folderKey>" });
|
|
1168
|
+
*
|
|
1169
|
+
* // Tenant + folder entities together
|
|
1170
|
+
* const allEntities = await entities.getAll({ includeFolderEntities: true });
|
|
1145
1171
|
*
|
|
1146
1172
|
* // Iterate through entities
|
|
1147
|
-
*
|
|
1173
|
+
* tenantEntities.forEach(entity => {
|
|
1148
1174
|
* console.log(`Entity: ${entity.displayName} (${entity.name})`);
|
|
1149
1175
|
* console.log(`Type: ${entity.entityType}`);
|
|
1150
1176
|
* });
|
|
1151
1177
|
*
|
|
1152
1178
|
* // Find a specific entity by name
|
|
1153
|
-
* const customerEntity =
|
|
1179
|
+
* const customerEntity = tenantEntities.find(e => e.name === 'Customer');
|
|
1154
1180
|
*
|
|
1155
1181
|
* // Use entity methods directly
|
|
1156
1182
|
* if (customerEntity) {
|
|
@@ -1168,12 +1194,12 @@ interface EntityServiceModel {
|
|
|
1168
1194
|
* }
|
|
1169
1195
|
* ```
|
|
1170
1196
|
*/
|
|
1171
|
-
getAll(): Promise<EntityGetResponse[]>;
|
|
1197
|
+
getAll(options?: EntityGetAllOptions): Promise<EntityGetResponse[]>;
|
|
1172
1198
|
/**
|
|
1173
1199
|
* Gets entity metadata by entity ID with attached operation methods
|
|
1174
1200
|
*
|
|
1175
1201
|
* @param id - UUID of the entity
|
|
1176
|
-
* @param options - Optional {@link EntityGetByIdOptions} (e.g. `folderKey` for folder-scoped entities)
|
|
1202
|
+
* @param options - Optional {@link EntityGetByIdOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
|
|
1177
1203
|
* @returns Promise resolving to entity metadata with operation methods
|
|
1178
1204
|
* {@link EntityGetResponse}
|
|
1179
1205
|
* @example
|
|
@@ -1213,7 +1239,7 @@ interface EntityServiceModel {
|
|
|
1213
1239
|
* Gets entity records by entity ID
|
|
1214
1240
|
*
|
|
1215
1241
|
* @param entityId - UUID of the entity
|
|
1216
|
-
* @param options - Query options
|
|
1242
|
+
* @param options - Query options The `folderKey` property is **experimental**.
|
|
1217
1243
|
* @returns Promise resolving to either an array of entity records NonPaginatedResponse<EntityRecord> or a PaginatedResponse<EntityRecord> when pagination options are used.
|
|
1218
1244
|
* {@link EntityRecord}
|
|
1219
1245
|
* @example
|
|
@@ -1237,6 +1263,9 @@ interface EntityServiceModel {
|
|
|
1237
1263
|
* cursor: paginatedResponse.nextCursor,
|
|
1238
1264
|
* expansionLevel: 1
|
|
1239
1265
|
* });
|
|
1266
|
+
*
|
|
1267
|
+
* // Folder-scoped entity: pass the entity's folder key
|
|
1268
|
+
* const records = await entities.getAllRecords("<entityId>", { folderKey: "<folderKey>" });
|
|
1240
1269
|
* ```
|
|
1241
1270
|
*/
|
|
1242
1271
|
getAllRecords<T extends EntityGetAllRecordsOptions = EntityGetAllRecordsOptions>(entityId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<EntityRecord> : NonPaginatedResponse<EntityRecord>>;
|
|
@@ -1250,7 +1279,7 @@ interface EntityServiceModel {
|
|
|
1250
1279
|
*
|
|
1251
1280
|
* @param entityId - UUID of the entity
|
|
1252
1281
|
* @param recordId - UUID of the record
|
|
1253
|
-
* @param options - Query options
|
|
1282
|
+
* @param options - Query options The `folderKey` property is **experimental**.
|
|
1254
1283
|
* @returns Promise resolving to a single entity record
|
|
1255
1284
|
* {@link EntityRecord}
|
|
1256
1285
|
* @example
|
|
@@ -1266,6 +1295,11 @@ interface EntityServiceModel {
|
|
|
1266
1295
|
* const record = await entities.getRecordById(<entityId>, recordId, {
|
|
1267
1296
|
* expansionLevel: 1
|
|
1268
1297
|
* });
|
|
1298
|
+
*
|
|
1299
|
+
* // Folder-scoped entity: pass the entity's folder key
|
|
1300
|
+
* const record = await entities.getRecordById(<entityId>, recordId, {
|
|
1301
|
+
* folderKey: "<folderKey>"
|
|
1302
|
+
* });
|
|
1269
1303
|
* ```
|
|
1270
1304
|
*/
|
|
1271
1305
|
getRecordById(entityId: string, recordId: string, options?: EntityGetRecordByIdOptions): Promise<EntityRecord>;
|
|
@@ -1277,7 +1311,7 @@ interface EntityServiceModel {
|
|
|
1277
1311
|
*
|
|
1278
1312
|
* @param id - UUID of the entity
|
|
1279
1313
|
* @param data - Record to insert
|
|
1280
|
-
* @param options - Insert options
|
|
1314
|
+
* @param options - Insert options The `folderKey` property is **experimental**.
|
|
1281
1315
|
* @returns Promise resolving to the inserted record with generated record ID
|
|
1282
1316
|
* {@link EntityInsertResponse}
|
|
1283
1317
|
* @example
|
|
@@ -1289,6 +1323,11 @@ interface EntityServiceModel {
|
|
|
1289
1323
|
* const result = await entities.insertRecordById(<entityId>, { name: "John", age: 30 }, {
|
|
1290
1324
|
* expansionLevel: 1
|
|
1291
1325
|
* });
|
|
1326
|
+
*
|
|
1327
|
+
* // Folder-scoped entity: pass the entity's folder key
|
|
1328
|
+
* await entities.insertRecordById(<entityId>, { name: "John", age: 30 }, {
|
|
1329
|
+
* folderKey: "<folderKey>"
|
|
1330
|
+
* });
|
|
1292
1331
|
* ```
|
|
1293
1332
|
*/
|
|
1294
1333
|
insertRecordById(id: string, data: Record<string, any>, options?: EntityInsertRecordOptions): Promise<EntityInsertResponse>;
|
|
@@ -1305,7 +1344,7 @@ interface EntityServiceModel {
|
|
|
1305
1344
|
*
|
|
1306
1345
|
* @param id - UUID of the entity
|
|
1307
1346
|
* @param data - Array of records to insert
|
|
1308
|
-
* @param options - Insert options
|
|
1347
|
+
* @param options - Insert options The `folderKey` property is **experimental**.
|
|
1309
1348
|
* @returns Promise resolving to insert response
|
|
1310
1349
|
* {@link EntityBatchInsertResponse}
|
|
1311
1350
|
* @example
|
|
@@ -1324,6 +1363,12 @@ interface EntityServiceModel {
|
|
|
1324
1363
|
* expansionLevel: 1,
|
|
1325
1364
|
* failOnFirst: true
|
|
1326
1365
|
* });
|
|
1366
|
+
*
|
|
1367
|
+
* // Folder-scoped entity: pass the entity's folder key
|
|
1368
|
+
* await entities.insertRecordsById(<entityId>, [
|
|
1369
|
+
* { name: "John", age: 30 },
|
|
1370
|
+
* { name: "Jane", age: 25 }
|
|
1371
|
+
* ], { folderKey: "<folderKey>" });
|
|
1327
1372
|
* ```
|
|
1328
1373
|
*/
|
|
1329
1374
|
insertRecordsById(id: string, data: Record<string, any>[], options?: EntityInsertRecordsOptions): Promise<EntityBatchInsertResponse>;
|
|
@@ -1341,7 +1386,7 @@ interface EntityServiceModel {
|
|
|
1341
1386
|
* @param entityId - UUID of the entity
|
|
1342
1387
|
* @param recordId - UUID of the record to update
|
|
1343
1388
|
* @param data - Key-value pairs of fields to update
|
|
1344
|
-
* @param options - Update options
|
|
1389
|
+
* @param options - Update options The `folderKey` property is **experimental**.
|
|
1345
1390
|
* @returns Promise resolving to the updated record
|
|
1346
1391
|
* {@link EntityUpdateRecordResponse}
|
|
1347
1392
|
* @example
|
|
@@ -1353,6 +1398,11 @@ interface EntityServiceModel {
|
|
|
1353
1398
|
* const result = await entities.updateRecordById(<entityId>, <recordId>, { name: "John Updated", age: 31 }, {
|
|
1354
1399
|
* expansionLevel: 1
|
|
1355
1400
|
* });
|
|
1401
|
+
*
|
|
1402
|
+
* // Folder-scoped entity: pass the entity's folder key
|
|
1403
|
+
* await entities.updateRecordById(<entityId>, <recordId>, { name: "John Updated" }, {
|
|
1404
|
+
* folderKey: "<folderKey>"
|
|
1405
|
+
* });
|
|
1356
1406
|
* ```
|
|
1357
1407
|
*/
|
|
1358
1408
|
updateRecordById(entityId: string, recordId: string, data: Record<string, any>, options?: EntityUpdateRecordOptions): Promise<EntityUpdateRecordResponse>;
|
|
@@ -1363,7 +1413,7 @@ interface EntityServiceModel {
|
|
|
1363
1413
|
*
|
|
1364
1414
|
* @param id - UUID of the entity
|
|
1365
1415
|
* @param data - Array of records to update. Each record MUST contain the record id.
|
|
1366
|
-
* @param options - Update options
|
|
1416
|
+
* @param options - Update options The `folderKey` property is **experimental**.
|
|
1367
1417
|
* @returns Promise resolving to update response
|
|
1368
1418
|
* {@link EntityUpdateResponse}
|
|
1369
1419
|
* @example
|
|
@@ -1382,6 +1432,11 @@ interface EntityServiceModel {
|
|
|
1382
1432
|
* expansionLevel: 1,
|
|
1383
1433
|
* failOnFirst: true
|
|
1384
1434
|
* });
|
|
1435
|
+
*
|
|
1436
|
+
* // Folder-scoped entity: pass the entity's folder key
|
|
1437
|
+
* await entities.updateRecordsById(<entityId>, [
|
|
1438
|
+
* { Id: "123", name: "John Updated" }
|
|
1439
|
+
* ], { folderKey: "<folderKey>" });
|
|
1385
1440
|
* ```
|
|
1386
1441
|
*/
|
|
1387
1442
|
updateRecordsById(id: string, data: EntityRecord[], options?: EntityUpdateRecordsOptions): Promise<EntityUpdateResponse>;
|
|
@@ -1392,7 +1447,7 @@ interface EntityServiceModel {
|
|
|
1392
1447
|
*
|
|
1393
1448
|
* @param id - UUID of the entity
|
|
1394
1449
|
* @param recordIds - Array of record UUIDs to delete
|
|
1395
|
-
* @param options - Delete options
|
|
1450
|
+
* @param options - Delete options The `folderKey` property is **experimental**.
|
|
1396
1451
|
* @returns Promise resolving to delete response
|
|
1397
1452
|
* {@link EntityDeleteResponse}
|
|
1398
1453
|
* @example
|
|
@@ -1401,6 +1456,11 @@ interface EntityServiceModel {
|
|
|
1401
1456
|
* const result = await entities.deleteRecordsById(<entityId>, [
|
|
1402
1457
|
* <recordId-1>, <recordId-2>
|
|
1403
1458
|
* ]);
|
|
1459
|
+
*
|
|
1460
|
+
* // Folder-scoped entity: pass the entity's folder key
|
|
1461
|
+
* await entities.deleteRecordsById(<entityId>, [
|
|
1462
|
+
* <recordId-1>, <recordId-2>
|
|
1463
|
+
* ], { folderKey: "<folderKey>" });
|
|
1404
1464
|
* ```
|
|
1405
1465
|
*/
|
|
1406
1466
|
deleteRecordsById(id: string, recordIds: string[], options?: EntityDeleteRecordsOptions): Promise<EntityDeleteResponse>;
|
|
@@ -1412,7 +1472,7 @@ interface EntityServiceModel {
|
|
|
1412
1472
|
*
|
|
1413
1473
|
* @param entityId - UUID of the entity
|
|
1414
1474
|
* @param recordId - UUID of the record to delete
|
|
1415
|
-
* @param options - Optional {@link EntityDeleteRecordByIdOptions} (e.g. `folderKey` for folder-scoped entities)
|
|
1475
|
+
* @param options - Optional {@link EntityDeleteRecordByIdOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
|
|
1416
1476
|
* @returns Promise resolving to void on success
|
|
1417
1477
|
* @example
|
|
1418
1478
|
* ```typescript
|
|
@@ -1431,7 +1491,7 @@ interface EntityServiceModel {
|
|
|
1431
1491
|
* Queries entity records with filters, sorting, aggregates, and SDK-managed pagination
|
|
1432
1492
|
*
|
|
1433
1493
|
* @param id - UUID of the entity
|
|
1434
|
-
* @param options - Query options including filterGroup, selectedFields, sortOptions, aggregates, groupBy, and pagination
|
|
1494
|
+
* @param options - Query options including filterGroup, selectedFields, sortOptions, aggregates, groupBy, and pagination The `folderKey` property is **experimental**.
|
|
1435
1495
|
* @returns Promise resolving to {@link NonPaginatedResponse} without pagination options,
|
|
1436
1496
|
* or {@link PaginatedResponse} when `pageSize`, `cursor`, or `jumpToPage` are provided
|
|
1437
1497
|
* @example
|
|
@@ -1465,6 +1525,12 @@ interface EntityServiceModel {
|
|
|
1465
1525
|
* ],
|
|
1466
1526
|
* });
|
|
1467
1527
|
*
|
|
1528
|
+
* // Folder-scoped entity: pass the entity's folder key
|
|
1529
|
+
* await entities.queryRecordsById(<id>, {
|
|
1530
|
+
* filterGroup: { queryFilters: [{ fieldName: "status", operator: QueryFilterOperator.Equals, value: "active" }] },
|
|
1531
|
+
* folderKey: "<folderKey>",
|
|
1532
|
+
* });
|
|
1533
|
+
*
|
|
1468
1534
|
* // Aggregate: total sum and average across all records (no grouping)
|
|
1469
1535
|
* await entities.queryRecordsById(<id>, {
|
|
1470
1536
|
* aggregates: [
|
|
@@ -1480,7 +1546,7 @@ interface EntityServiceModel {
|
|
|
1480
1546
|
*
|
|
1481
1547
|
* @param id - UUID of the entity
|
|
1482
1548
|
* @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)
|
|
1549
|
+
* @param options - Optional {@link EntityImportRecordsByIdOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
|
|
1484
1550
|
* @returns Promise resolving to {@link EntityImportRecordsResponse} with record counts
|
|
1485
1551
|
* @example
|
|
1486
1552
|
* ```typescript
|
|
@@ -1500,7 +1566,7 @@ interface EntityServiceModel {
|
|
|
1500
1566
|
* @param entityId - UUID of the entity
|
|
1501
1567
|
* @param recordId - UUID of the record containing the attachment
|
|
1502
1568
|
* @param fieldName - Name of the File-type field containing the attachment
|
|
1503
|
-
* @param options - Optional {@link EntityDownloadAttachmentOptions} (e.g. `folderKey` for folder-scoped entities)
|
|
1569
|
+
* @param options - Optional {@link EntityDownloadAttachmentOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
|
|
1504
1570
|
* @returns Promise resolving to Blob containing the file content
|
|
1505
1571
|
* @example
|
|
1506
1572
|
* ```typescript
|
|
@@ -1557,7 +1623,7 @@ interface EntityServiceModel {
|
|
|
1557
1623
|
* @param recordId - UUID of the record to upload the attachment to
|
|
1558
1624
|
* @param fieldName - Name of the File-type field
|
|
1559
1625
|
* @param file - File to upload (Blob, File, or Uint8Array)
|
|
1560
|
-
* @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. `expansionLevel`, `folderKey` for folder-scoped entities)
|
|
1626
|
+
* @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. `expansionLevel`, `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
|
|
1561
1627
|
* @returns Promise resolving to {@link EntityUploadAttachmentResponse}
|
|
1562
1628
|
* @example
|
|
1563
1629
|
* ```typescript
|
|
@@ -1594,7 +1660,7 @@ interface EntityServiceModel {
|
|
|
1594
1660
|
* @param entityId - UUID of the entity
|
|
1595
1661
|
* @param recordId - UUID of the record containing the attachment
|
|
1596
1662
|
* @param fieldName - Name of the File-type field containing the attachment
|
|
1597
|
-
* @param options - Optional {@link EntityDeleteAttachmentOptions} (e.g. `folderKey` for folder-scoped entities)
|
|
1663
|
+
* @param options - Optional {@link EntityDeleteAttachmentOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
|
|
1598
1664
|
* @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
|
|
1599
1665
|
* @example
|
|
1600
1666
|
* ```typescript
|
|
@@ -1625,7 +1691,7 @@ interface EntityServiceModel {
|
|
|
1625
1691
|
* @param name - Entity name — must start with a letter, letters/numbers/underscores only
|
|
1626
1692
|
* (e.g., `"productCatalog"`).
|
|
1627
1693
|
* @param fields - Array of field definitions
|
|
1628
|
-
* @param options - Optional entity-level settings ({@link EntityCreateOptions})
|
|
1694
|
+
* @param options - Optional entity-level settings ({@link EntityCreateOptions}) The `folderKey` property is **experimental**.
|
|
1629
1695
|
* @returns Promise resolving to the ID of the created entity
|
|
1630
1696
|
* @example
|
|
1631
1697
|
* ```typescript
|
|
@@ -1644,6 +1710,24 @@ interface EntityServiceModel {
|
|
|
1644
1710
|
* { fieldName: "price", type: EntityFieldDataType.DECIMAL, decimalPrecision: 4, maxValue: 999999, minValue: 0 },
|
|
1645
1711
|
* { fieldName: "quantity", type: EntityFieldDataType.INTEGER, maxValue: 10000, minValue: 1, defaultValue: "0" },
|
|
1646
1712
|
* ]);
|
|
1713
|
+
*
|
|
1714
|
+
* // Cross-folder references — link a folder-scoped entity to entities and
|
|
1715
|
+
* // system choice sets that live in another folder or at the tenant level.
|
|
1716
|
+
* await entities.create("orderLine", [
|
|
1717
|
+
* {
|
|
1718
|
+
* fieldName: "order",
|
|
1719
|
+
* type: EntityFieldDataType.RELATIONSHIP,
|
|
1720
|
+
* referenceEntityId: "<orderEntityId>",
|
|
1721
|
+
* referenceFieldId: "<orderEntityPkId>",
|
|
1722
|
+
* referenceFolderKey: "<otherFolderKey>", // target lives in a different folder
|
|
1723
|
+
* },
|
|
1724
|
+
* {
|
|
1725
|
+
* fieldName: "userType",
|
|
1726
|
+
* type: EntityFieldDataType.CHOICE_SET_SINGLE,
|
|
1727
|
+
* choiceSetId: "<systemUserTypeChoiceSetId>", // tenant-level system choice set
|
|
1728
|
+
* // referenceFolderKey omitted → SDK looks up the target at tenant scope
|
|
1729
|
+
* },
|
|
1730
|
+
* ], { folderKey: "<sourceFolderKey>" });
|
|
1647
1731
|
* ```
|
|
1648
1732
|
* @internal
|
|
1649
1733
|
*/
|
|
@@ -1652,7 +1736,7 @@ interface EntityServiceModel {
|
|
|
1652
1736
|
* Deletes a Data Fabric entity and all its records
|
|
1653
1737
|
*
|
|
1654
1738
|
* @param id - UUID of the entity to delete
|
|
1655
|
-
* @param options - Optional {@link EntityDeleteByIdOptions} (e.g. `folderKey` for folder-scoped entities)
|
|
1739
|
+
* @param options - Optional {@link EntityDeleteByIdOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
|
|
1656
1740
|
* @returns Promise resolving when the entity is deleted
|
|
1657
1741
|
* @example
|
|
1658
1742
|
* ```typescript
|
|
@@ -1672,7 +1756,7 @@ interface EntityServiceModel {
|
|
|
1672
1756
|
* only when the corresponding fields are provided.
|
|
1673
1757
|
*
|
|
1674
1758
|
* @param id - UUID of the entity to update
|
|
1675
|
-
* @param options - Changes to apply ({@link EntityUpdateByIdOptions})
|
|
1759
|
+
* @param options - Changes to apply ({@link EntityUpdateByIdOptions}) The `folderKey` property is **experimental**.
|
|
1676
1760
|
* @returns Promise resolving when the update is complete
|
|
1677
1761
|
*
|
|
1678
1762
|
* @example
|
|
@@ -1790,7 +1874,7 @@ interface EntityMethods {
|
|
|
1790
1874
|
/**
|
|
1791
1875
|
* Get all records from this entity
|
|
1792
1876
|
*
|
|
1793
|
-
* @param options - Query options
|
|
1877
|
+
* @param options - Query options The `folderKey` property is **experimental**.
|
|
1794
1878
|
* @returns Promise resolving to query response
|
|
1795
1879
|
*/
|
|
1796
1880
|
getAllRecords<T extends EntityGetAllRecordsOptions = EntityGetAllRecordsOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<EntityRecord> : NonPaginatedResponse<EntityRecord>>;
|
|
@@ -1807,7 +1891,7 @@ interface EntityMethods {
|
|
|
1807
1891
|
*
|
|
1808
1892
|
* @param recordId - UUID of the record containing the attachment
|
|
1809
1893
|
* @param fieldName - Name of the File-type field containing the attachment
|
|
1810
|
-
* @param options - Optional {@link EntityDownloadAttachmentOptions} (e.g. folderKey)
|
|
1894
|
+
* @param options - Optional {@link EntityDownloadAttachmentOptions} (e.g. folderKey) The `folderKey` property is **experimental**.
|
|
1811
1895
|
* @returns Promise resolving to Blob containing the file content
|
|
1812
1896
|
*/
|
|
1813
1897
|
downloadAttachment(recordId: string, fieldName: string, options?: EntityDownloadAttachmentOptions): Promise<Blob>;
|
|
@@ -1817,7 +1901,7 @@ interface EntityMethods {
|
|
|
1817
1901
|
* @param recordId - UUID of the record to upload the attachment to
|
|
1818
1902
|
* @param fieldName - Name of the File-type field
|
|
1819
1903
|
* @param file - File to upload (Blob, File, or Uint8Array)
|
|
1820
|
-
* @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel, folderKey)
|
|
1904
|
+
* @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel, folderKey) The `folderKey` property is **experimental**.
|
|
1821
1905
|
* @returns Promise resolving to {@link EntityUploadAttachmentResponse}
|
|
1822
1906
|
*/
|
|
1823
1907
|
uploadAttachment(recordId: string, fieldName: string, file: EntityFileType, options?: EntityUploadAttachmentOptions): Promise<EntityUploadAttachmentResponse>;
|
|
@@ -1826,7 +1910,7 @@ interface EntityMethods {
|
|
|
1826
1910
|
*
|
|
1827
1911
|
* @param recordId - UUID of the record containing the attachment
|
|
1828
1912
|
* @param fieldName - Name of the File-type field containing the attachment
|
|
1829
|
-
* @param options - Optional {@link EntityDeleteAttachmentOptions} (e.g. folderKey)
|
|
1913
|
+
* @param options - Optional {@link EntityDeleteAttachmentOptions} (e.g. folderKey) The `folderKey` property is **experimental**.
|
|
1830
1914
|
* @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
|
|
1831
1915
|
*/
|
|
1832
1916
|
deleteAttachment(recordId: string, fieldName: string, options?: EntityDeleteAttachmentOptions): Promise<EntityDeleteAttachmentResponse>;
|
|
@@ -1966,7 +2050,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
1966
2050
|
* Gets entity metadata by entity ID with attached operation methods
|
|
1967
2051
|
*
|
|
1968
2052
|
* @param id - UUID of the entity
|
|
1969
|
-
* @param options - Optional {@link EntityGetByIdOptions} (e.g. `folderKey` for folder-scoped entities)
|
|
2053
|
+
* @param options - Optional {@link EntityGetByIdOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
|
|
1970
2054
|
* @returns Promise resolving to entity metadata with schema information and operation methods
|
|
1971
2055
|
*
|
|
1972
2056
|
* @example
|
|
@@ -1997,7 +2081,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
1997
2081
|
* Gets entity records by entity ID
|
|
1998
2082
|
*
|
|
1999
2083
|
* @param entityId - UUID of the entity
|
|
2000
|
-
* @param options - Query options including expansionLevel and pagination options
|
|
2084
|
+
* @param options - Query options including expansionLevel and pagination options The `folderKey` property is **experimental**.
|
|
2001
2085
|
* @returns Promise resolving to an array of entity records or paginated response
|
|
2002
2086
|
*
|
|
2003
2087
|
* @example
|
|
@@ -2025,6 +2109,9 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2025
2109
|
* cursor: paginatedResponse.nextCursor,
|
|
2026
2110
|
* expansionLevel: 1
|
|
2027
2111
|
* });
|
|
2112
|
+
*
|
|
2113
|
+
* // Folder-scoped entity: pass the entity's folder key
|
|
2114
|
+
* const records = await entities.getAllRecords("<entityId>", { folderKey: "<folderKey>" });
|
|
2028
2115
|
* ```
|
|
2029
2116
|
*/
|
|
2030
2117
|
getAllRecords<T extends EntityGetAllRecordsOptions = EntityGetAllRecordsOptions>(entityId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<EntityRecord> : NonPaginatedResponse<EntityRecord>>;
|
|
@@ -2033,7 +2120,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2033
2120
|
*
|
|
2034
2121
|
* @param entityId - UUID of the entity
|
|
2035
2122
|
* @param recordId - UUID of the record
|
|
2036
|
-
* @param options - Query options including expansionLevel
|
|
2123
|
+
* @param options - Query options including `expansionLevel` and `folderKey` The `folderKey` property is **experimental**.
|
|
2037
2124
|
* @returns Promise resolving to the entity record
|
|
2038
2125
|
*
|
|
2039
2126
|
* @example
|
|
@@ -2045,6 +2132,11 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2045
2132
|
* const record = await sdk.entities.getRecordById(<entityId>, <recordId>, {
|
|
2046
2133
|
* expansionLevel: 1
|
|
2047
2134
|
* });
|
|
2135
|
+
*
|
|
2136
|
+
* // Folder-scoped entity: pass the entity's folder key
|
|
2137
|
+
* const record = await sdk.entities.getRecordById(<entityId>, <recordId>, {
|
|
2138
|
+
* folderKey: "<folderKey>"
|
|
2139
|
+
* });
|
|
2048
2140
|
* ```
|
|
2049
2141
|
*/
|
|
2050
2142
|
getRecordById(entityId: string, recordId: string, options?: EntityGetRecordByIdOptions): Promise<EntityRecord>;
|
|
@@ -2053,7 +2145,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2053
2145
|
*
|
|
2054
2146
|
* @param entityId - UUID of the entity
|
|
2055
2147
|
* @param data - Record to insert
|
|
2056
|
-
* @param options - Insert options
|
|
2148
|
+
* @param options - Insert options The `folderKey` property is **experimental**.
|
|
2057
2149
|
* @returns Promise resolving to the inserted record with generated record ID
|
|
2058
2150
|
*
|
|
2059
2151
|
* @example
|
|
@@ -2069,6 +2161,11 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2069
2161
|
* const result = await entities.insertRecordById("<entityId>", { name: "John", age: 30 }, {
|
|
2070
2162
|
* expansionLevel: 1
|
|
2071
2163
|
* });
|
|
2164
|
+
*
|
|
2165
|
+
* // Folder-scoped entity: pass the entity's folder key
|
|
2166
|
+
* await entities.insertRecordById("<entityId>", { name: "John", age: 30 }, {
|
|
2167
|
+
* folderKey: "<folderKey>"
|
|
2168
|
+
* });
|
|
2072
2169
|
* ```
|
|
2073
2170
|
*/
|
|
2074
2171
|
insertRecordById(id: string, data: Record<string, any>, options?: EntityInsertRecordOptions): Promise<EntityInsertResponse>;
|
|
@@ -2077,7 +2174,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2077
2174
|
*
|
|
2078
2175
|
* @param entityId - UUID of the entity
|
|
2079
2176
|
* @param data - Array of records to insert
|
|
2080
|
-
* @param options - Insert options
|
|
2177
|
+
* @param options - Insert options The `folderKey` property is **experimental**.
|
|
2081
2178
|
* @returns Promise resolving to insert response
|
|
2082
2179
|
*
|
|
2083
2180
|
* @example
|
|
@@ -2100,6 +2197,12 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2100
2197
|
* expansionLevel: 1,
|
|
2101
2198
|
* failOnFirst: true
|
|
2102
2199
|
* });
|
|
2200
|
+
*
|
|
2201
|
+
* // Folder-scoped entity: pass the entity's folder key
|
|
2202
|
+
* await entities.insertRecordsById("<entityId>", [
|
|
2203
|
+
* { name: "John", age: 30 },
|
|
2204
|
+
* { name: "Jane", age: 25 }
|
|
2205
|
+
* ], { folderKey: "<folderKey>" });
|
|
2103
2206
|
* ```
|
|
2104
2207
|
*/
|
|
2105
2208
|
insertRecordsById(id: string, data: Record<string, any>[], options?: EntityInsertRecordsOptions): Promise<EntityBatchInsertResponse>;
|
|
@@ -2109,7 +2212,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2109
2212
|
* @param entityId - UUID of the entity
|
|
2110
2213
|
* @param recordId - UUID of the record to update
|
|
2111
2214
|
* @param data - Key-value pairs of fields to update
|
|
2112
|
-
* @param options - Update options
|
|
2215
|
+
* @param options - Update options The `folderKey` property is **experimental**.
|
|
2113
2216
|
* @returns Promise resolving to the updated record
|
|
2114
2217
|
*
|
|
2115
2218
|
* @example
|
|
@@ -2125,6 +2228,11 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2125
2228
|
* const result = await entities.updateRecordById("<entityId>", "<recordId>", { name: "John Updated", age: 31 }, {
|
|
2126
2229
|
* expansionLevel: 1
|
|
2127
2230
|
* });
|
|
2231
|
+
*
|
|
2232
|
+
* // Folder-scoped entity: pass the entity's folder key
|
|
2233
|
+
* await entities.updateRecordById("<entityId>", "<recordId>", { name: "John Updated" }, {
|
|
2234
|
+
* folderKey: "<folderKey>"
|
|
2235
|
+
* });
|
|
2128
2236
|
* ```
|
|
2129
2237
|
*/
|
|
2130
2238
|
updateRecordById(entityId: string, recordId: string, data: Record<string, any>, options?: EntityUpdateRecordOptions): Promise<EntityUpdateRecordResponse>;
|
|
@@ -2134,7 +2242,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2134
2242
|
* @param entityId - UUID of the entity
|
|
2135
2243
|
* @param data - Array of records to update. Each record MUST contain the record Id,
|
|
2136
2244
|
* otherwise the update will fail.
|
|
2137
|
-
* @param options - Update options
|
|
2245
|
+
* @param options - Update options The `folderKey` property is **experimental**.
|
|
2138
2246
|
* @returns Promise resolving to update response
|
|
2139
2247
|
*
|
|
2140
2248
|
* @example
|
|
@@ -2157,6 +2265,11 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2157
2265
|
* expansionLevel: 1,
|
|
2158
2266
|
* failOnFirst: true
|
|
2159
2267
|
* });
|
|
2268
|
+
*
|
|
2269
|
+
* // Folder-scoped entity: pass the entity's folder key
|
|
2270
|
+
* await entities.updateRecordsById("<entityId>", [
|
|
2271
|
+
* { Id: "123", name: "John Updated" }
|
|
2272
|
+
* ], { folderKey: "<folderKey>" });
|
|
2160
2273
|
* ```
|
|
2161
2274
|
*/
|
|
2162
2275
|
updateRecordsById(id: string, data: EntityRecord[], options?: EntityUpdateRecordsOptions): Promise<EntityUpdateResponse>;
|
|
@@ -2167,7 +2280,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2167
2280
|
*
|
|
2168
2281
|
* @param entityId - UUID of the entity
|
|
2169
2282
|
* @param recordIds - Array of record UUIDs to delete
|
|
2170
|
-
* @param options - Delete options
|
|
2283
|
+
* @param options - Delete options The `folderKey` property is **experimental**.
|
|
2171
2284
|
* @returns Promise resolving to delete response
|
|
2172
2285
|
*
|
|
2173
2286
|
* @example
|
|
@@ -2180,6 +2293,11 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2180
2293
|
* const result = await entities.deleteRecordsById("<entityId>", [
|
|
2181
2294
|
* "<recordId-1>", "<recordId-2>"
|
|
2182
2295
|
* ]);
|
|
2296
|
+
*
|
|
2297
|
+
* // Folder-scoped entity: pass the entity's folder key
|
|
2298
|
+
* await entities.deleteRecordsById("<entityId>", [
|
|
2299
|
+
* "<recordId-1>", "<recordId-2>"
|
|
2300
|
+
* ], { folderKey: "<folderKey>" });
|
|
2183
2301
|
* ```
|
|
2184
2302
|
*/
|
|
2185
2303
|
deleteRecordsById(id: string, recordIds: string[], options?: EntityDeleteRecordsOptions): Promise<EntityDeleteResponse>;
|
|
@@ -2191,7 +2309,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2191
2309
|
*
|
|
2192
2310
|
* @param entityId - UUID of the entity
|
|
2193
2311
|
* @param recordId - UUID of the record to delete
|
|
2194
|
-
* @param options - Optional {@link EntityDeleteRecordByIdOptions} (e.g. `folderKey` for folder-scoped entities)
|
|
2312
|
+
* @param options - Optional {@link EntityDeleteRecordByIdOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
|
|
2195
2313
|
* @returns Promise resolving to void on success
|
|
2196
2314
|
* @example
|
|
2197
2315
|
* ```typescript
|
|
@@ -2207,8 +2325,14 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2207
2325
|
*/
|
|
2208
2326
|
deleteRecordById(entityId: string, recordId: string, options?: EntityDeleteRecordByIdOptions): Promise<void>;
|
|
2209
2327
|
/**
|
|
2210
|
-
* Gets
|
|
2328
|
+
* Gets entities in the tenant.
|
|
2329
|
+
*
|
|
2330
|
+
* Three call modes:
|
|
2331
|
+
* - `getAll()` — default. Returns only tenant-level entities.
|
|
2332
|
+
* - `getAll({ folderKey: "<uuid>" })` — preferred for folder-scoped data. Returns only entities in that folder.
|
|
2333
|
+
* - `getAll({ includeFolderEntities: true })` — returns tenant-level **and** folder-level entities together. `folderKey` is preferred over `includeFolderEntities` when both are set.
|
|
2211
2334
|
*
|
|
2335
|
+
* @param options - Optional {@link EntityGetAllOptions} (`folderKey` to list a single folder's entities — preferred when scoping to a folder; `includeFolderEntities: true` to list tenant + folder entities together) The `folderKey` property is **experimental**.
|
|
2212
2336
|
* @returns Promise resolving to an array of entity metadata
|
|
2213
2337
|
*
|
|
2214
2338
|
* @example
|
|
@@ -2217,19 +2341,25 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2217
2341
|
*
|
|
2218
2342
|
* const entities = new Entities(sdk);
|
|
2219
2343
|
*
|
|
2220
|
-
* //
|
|
2221
|
-
* const
|
|
2344
|
+
* // Tenant-only (default)
|
|
2345
|
+
* const tenantEntities = await entities.getAll();
|
|
2346
|
+
*
|
|
2347
|
+
* // A single folder's entities (preferred when targeting a specific folder)
|
|
2348
|
+
* const folderEntities = await entities.getAll({ folderKey: "<folderKey>" });
|
|
2349
|
+
*
|
|
2350
|
+
* // Tenant + folder entities together
|
|
2351
|
+
* const allEntities = await entities.getAll({ includeFolderEntities: true });
|
|
2222
2352
|
*
|
|
2223
2353
|
* // Call operations on an entity
|
|
2224
|
-
* const records = await
|
|
2354
|
+
* const records = await tenantEntities[0].getAllRecords();
|
|
2225
2355
|
* ```
|
|
2226
2356
|
*/
|
|
2227
|
-
getAll(): Promise<EntityGetResponse[]>;
|
|
2357
|
+
getAll(options?: EntityGetAllOptions): Promise<EntityGetResponse[]>;
|
|
2228
2358
|
/**
|
|
2229
2359
|
* Queries entity records with filters, sorting, aggregates, and pagination
|
|
2230
2360
|
*
|
|
2231
2361
|
* @param id - UUID of the entity
|
|
2232
|
-
* @param options - Query options including filterGroup, selectedFields, sortOptions, aggregates, groupBy, and pagination
|
|
2362
|
+
* @param options - Query options including filterGroup, selectedFields, sortOptions, aggregates, groupBy, and pagination The `folderKey` property is **experimental**.
|
|
2233
2363
|
* @returns Promise resolving to {@link NonPaginatedResponse} without pagination options,
|
|
2234
2364
|
* or {@link PaginatedResponse} when `pageSize`, `cursor`, or `jumpToPage` are provided
|
|
2235
2365
|
*
|
|
@@ -2276,6 +2406,12 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2276
2406
|
* { function: EntityAggregateFunction.Avg, field: "amount", alias: "avgAmount" },
|
|
2277
2407
|
* ],
|
|
2278
2408
|
* });
|
|
2409
|
+
*
|
|
2410
|
+
* // Folder-scoped entity: pass the entity's folder key
|
|
2411
|
+
* await entities.queryRecordsById("<entityId>", {
|
|
2412
|
+
* filterGroup: { queryFilters: [{ fieldName: "status", operator: QueryFilterOperator.Equals, value: "active" }] },
|
|
2413
|
+
* folderKey: "<folderKey>",
|
|
2414
|
+
* });
|
|
2279
2415
|
* ```
|
|
2280
2416
|
*/
|
|
2281
2417
|
queryRecordsById<T extends EntityQueryRecordsOptions = EntityQueryRecordsOptions>(id: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<EntityRecord> : NonPaginatedResponse<EntityRecord>>;
|
|
@@ -2284,7 +2420,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2284
2420
|
*
|
|
2285
2421
|
* @param id - UUID of the entity
|
|
2286
2422
|
* @param file - CSV file to import (Blob, File, or Uint8Array)
|
|
2287
|
-
* @param options - Optional {@link EntityImportRecordsByIdOptions} (e.g. `folderKey` for folder-scoped entities)
|
|
2423
|
+
* @param options - Optional {@link EntityImportRecordsByIdOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
|
|
2288
2424
|
* @returns Promise resolving to import result with record counts
|
|
2289
2425
|
*
|
|
2290
2426
|
* @example
|
|
@@ -2317,7 +2453,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2317
2453
|
* @param entityId - UUID of the entity
|
|
2318
2454
|
* @param recordId - UUID of the record containing the attachment
|
|
2319
2455
|
* @param fieldName - Name of the File-type field containing the attachment
|
|
2320
|
-
* @param options - Optional {@link EntityDownloadAttachmentOptions} (e.g. `folderKey` for folder-scoped entities)
|
|
2456
|
+
* @param options - Optional {@link EntityDownloadAttachmentOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
|
|
2321
2457
|
* @returns Promise resolving to Blob containing the file content
|
|
2322
2458
|
*
|
|
2323
2459
|
* @example
|
|
@@ -2349,7 +2485,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2349
2485
|
* @param recordId - UUID of the record to upload the attachment to
|
|
2350
2486
|
* @param fieldName - Name of the File-type field
|
|
2351
2487
|
* @param file - File to upload (Blob, File, or Uint8Array)
|
|
2352
|
-
* @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. `expansionLevel`, `folderKey` for folder-scoped entities)
|
|
2488
|
+
* @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. `expansionLevel`, `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
|
|
2353
2489
|
* @returns Promise resolving to {@link EntityUploadAttachmentResponse}
|
|
2354
2490
|
*
|
|
2355
2491
|
* @example
|
|
@@ -2380,7 +2516,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2380
2516
|
* @param entityId - UUID of the entity
|
|
2381
2517
|
* @param recordId - UUID of the record containing the attachment
|
|
2382
2518
|
* @param fieldName - Name of the File-type field containing the attachment
|
|
2383
|
-
* @param options - Optional {@link EntityDeleteAttachmentOptions} (e.g. `folderKey` for folder-scoped entities)
|
|
2519
|
+
* @param options - Optional {@link EntityDeleteAttachmentOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
|
|
2384
2520
|
* @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
|
|
2385
2521
|
*
|
|
2386
2522
|
* @example
|
|
@@ -2426,7 +2562,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2426
2562
|
* @param name - Entity name — must start with a letter and contain
|
|
2427
2563
|
* only letters, numbers, and underscores (e.g., `"productCatalog"`).
|
|
2428
2564
|
* @param fields - Array of field definitions
|
|
2429
|
-
* @param options - Optional entity-level settings ({@link EntityCreateOptions})
|
|
2565
|
+
* @param options - Optional entity-level settings ({@link EntityCreateOptions}) The `folderKey` property is **experimental**.
|
|
2430
2566
|
* @returns Promise resolving to the ID of the created entity
|
|
2431
2567
|
*
|
|
2432
2568
|
* @example
|
|
@@ -2442,6 +2578,24 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2442
2578
|
* { fieldName: "price", type: EntityFieldDataType.DECIMAL, decimalPrecision: 4, maxValue: 999999, minValue: 0 },
|
|
2443
2579
|
* { fieldName: "quantity", type: EntityFieldDataType.INTEGER, maxValue: 10000, minValue: 1, defaultValue: "0" },
|
|
2444
2580
|
* ]);
|
|
2581
|
+
*
|
|
2582
|
+
* // Cross-folder references — link a folder-scoped entity to entities and
|
|
2583
|
+
* // system choice sets that live in another folder or at the tenant level.
|
|
2584
|
+
* await entities.create("orderLine", [
|
|
2585
|
+
* {
|
|
2586
|
+
* fieldName: "order",
|
|
2587
|
+
* type: EntityFieldDataType.RELATIONSHIP,
|
|
2588
|
+
* referenceEntityId: "<orderEntityId>",
|
|
2589
|
+
* referenceFieldId: "<orderEntityPkId>",
|
|
2590
|
+
* referenceFolderKey: "<otherFolderKey>", // target lives in a different folder
|
|
2591
|
+
* },
|
|
2592
|
+
* {
|
|
2593
|
+
* fieldName: "userType",
|
|
2594
|
+
* type: EntityFieldDataType.CHOICE_SET_SINGLE,
|
|
2595
|
+
* choiceSetId: "<systemUserTypeChoiceSetId>", // tenant-level system choice set
|
|
2596
|
+
* // referenceFolderKey omitted → SDK looks up the target at tenant scope
|
|
2597
|
+
* },
|
|
2598
|
+
* ], { folderKey: "<sourceFolderKey>" });
|
|
2445
2599
|
* ```
|
|
2446
2600
|
* @internal
|
|
2447
2601
|
*/
|
|
@@ -2450,7 +2604,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2450
2604
|
* Deletes a Data Fabric entity and all its records
|
|
2451
2605
|
*
|
|
2452
2606
|
* @param id - UUID of the entity to delete
|
|
2453
|
-
* @param options - Optional {@link EntityDeleteByIdOptions} (e.g. `folderKey` for folder-scoped entities)
|
|
2607
|
+
* @param options - Optional {@link EntityDeleteByIdOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
|
|
2454
2608
|
* @returns Promise resolving when the entity is deleted
|
|
2455
2609
|
*
|
|
2456
2610
|
* @example
|
|
@@ -2475,7 +2629,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2475
2629
|
* overwrite each other's changes.
|
|
2476
2630
|
*
|
|
2477
2631
|
* @param id - UUID of the entity to update
|
|
2478
|
-
* @param options - Changes to apply ({@link EntityUpdateByIdOptions})
|
|
2632
|
+
* @param options - Changes to apply ({@link EntityUpdateByIdOptions}) The `folderKey` property is **experimental**.
|
|
2479
2633
|
* @returns Promise resolving when the update is complete
|
|
2480
2634
|
*
|
|
2481
2635
|
* @example
|
|
@@ -2558,6 +2712,8 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2558
2712
|
* @private
|
|
2559
2713
|
*/
|
|
2560
2714
|
private mapExternalFields;
|
|
2715
|
+
private buildFieldsWithReferenceMeta;
|
|
2716
|
+
private buildReferenceMeta;
|
|
2561
2717
|
/** Converts a user-facing EntityCreateFieldOptions to the raw API field payload */
|
|
2562
2718
|
private buildSchemaFieldPayload;
|
|
2563
2719
|
/**
|
|
@@ -2631,40 +2787,54 @@ interface ChoiceSetGetResponse {
|
|
|
2631
2787
|
/** User ID of the record owner */
|
|
2632
2788
|
recordOwner?: string;
|
|
2633
2789
|
}
|
|
2790
|
+
interface ChoiceSetGetAllOptions extends EntityFolderScopedOptions {
|
|
2791
|
+
/**
|
|
2792
|
+
* When `true`, also returns folder-level choice sets alongside tenant ones.
|
|
2793
|
+
* Omit (or `false`, the default) to return only tenant-level choice sets.
|
|
2794
|
+
* Ignored when `folderKey` is provided — `folderKey` is preferred over `includeFolderChoiceSets` when both are set.
|
|
2795
|
+
*
|
|
2796
|
+
* @experimental Folder-scoped Data Fabric is in preview — the contract may change.
|
|
2797
|
+
*/
|
|
2798
|
+
includeFolderChoiceSets?: boolean;
|
|
2799
|
+
}
|
|
2634
2800
|
/**
|
|
2635
2801
|
* Options for getting choice set values by choice set ID
|
|
2636
2802
|
*/
|
|
2637
|
-
type ChoiceSetGetByIdOptions = PaginationOptions;
|
|
2803
|
+
type ChoiceSetGetByIdOptions = PaginationOptions & EntityFolderScopedOptions;
|
|
2638
2804
|
/**
|
|
2639
2805
|
* Options for creating a new choice set
|
|
2640
2806
|
*/
|
|
2641
|
-
interface ChoiceSetCreateOptions {
|
|
2807
|
+
interface ChoiceSetCreateOptions extends EntityFolderScopedOptions {
|
|
2642
2808
|
/** Human-readable display name */
|
|
2643
2809
|
displayName?: string;
|
|
2644
2810
|
/** Optional choice set description */
|
|
2645
2811
|
description?: string;
|
|
2646
|
-
/** UUID of the folder to place the choice set in (defaults to the tenant-level folder) */
|
|
2647
|
-
folderKey?: string;
|
|
2648
2812
|
}
|
|
2649
2813
|
/**
|
|
2650
2814
|
* Options for updating an existing choice set's metadata
|
|
2651
2815
|
*/
|
|
2652
|
-
interface ChoiceSetUpdateOptions {
|
|
2816
|
+
interface ChoiceSetUpdateOptions extends EntityFolderScopedOptions {
|
|
2653
2817
|
/** New display name for the choice set */
|
|
2654
2818
|
displayName?: string;
|
|
2655
2819
|
/** New description for the choice set */
|
|
2656
2820
|
description?: string;
|
|
2657
2821
|
}
|
|
2822
|
+
interface ChoiceSetDeleteByIdOptions extends EntityFolderScopedOptions {
|
|
2823
|
+
}
|
|
2658
2824
|
/**
|
|
2659
2825
|
* Optional fields when inserting a single value into a choice set.
|
|
2660
2826
|
*
|
|
2661
2827
|
* The required `name` identifier is passed as a positional argument to
|
|
2662
2828
|
* `insertValueById`.
|
|
2663
2829
|
*/
|
|
2664
|
-
interface ChoiceSetValueInsertOptions {
|
|
2830
|
+
interface ChoiceSetValueInsertOptions extends EntityFolderScopedOptions {
|
|
2665
2831
|
/** Human-readable display name */
|
|
2666
2832
|
displayName?: string;
|
|
2667
2833
|
}
|
|
2834
|
+
interface ChoiceSetValueUpdateOptions extends EntityFolderScopedOptions {
|
|
2835
|
+
}
|
|
2836
|
+
interface ChoiceSetValueDeleteOptions extends EntityFolderScopedOptions {
|
|
2837
|
+
}
|
|
2668
2838
|
/**
|
|
2669
2839
|
* Response returned after inserting a choice-set value — the full value object.
|
|
2670
2840
|
*/
|
|
@@ -2694,33 +2864,32 @@ interface ChoiceSetValueUpdateResponse extends ChoiceSetGetResponse {
|
|
|
2694
2864
|
*/
|
|
2695
2865
|
interface ChoiceSetServiceModel {
|
|
2696
2866
|
/**
|
|
2697
|
-
* Gets
|
|
2867
|
+
* Gets choice sets in the tenant.
|
|
2698
2868
|
*
|
|
2869
|
+
* Three call modes:
|
|
2870
|
+
* - `getAll()` — default. Returns only tenant-level choice sets.
|
|
2871
|
+
* - `getAll({ folderKey: "<uuid>" })` — preferred for folder-scoped data. Returns only choice sets in that folder.
|
|
2872
|
+
* - `getAll({ includeFolderChoiceSets: true })` — returns tenant-level **and** folder-level choice sets together. `folderKey` is preferred over `includeFolderChoiceSets` when both are set.
|
|
2873
|
+
*
|
|
2874
|
+
* @param options - Optional {@link ChoiceSetGetAllOptions} (`folderKey` to list a single folder's choice sets — preferred when scoping to a folder; `includeFolderChoiceSets: true` to list tenant + folder choice sets together) The `folderKey` property is **experimental**.
|
|
2699
2875
|
* @returns Promise resolving to an array of choice set metadata
|
|
2700
2876
|
* {@link ChoiceSetGetAllResponse}
|
|
2701
2877
|
* @example
|
|
2702
2878
|
* ```typescript
|
|
2703
|
-
* //
|
|
2704
|
-
* const
|
|
2879
|
+
* // Tenant-only (default)
|
|
2880
|
+
* const tenantChoiceSets = await choicesets.getAll();
|
|
2705
2881
|
*
|
|
2706
|
-
* //
|
|
2707
|
-
*
|
|
2708
|
-
* console.log(`ChoiceSet: ${choiceSet.displayName} (${choiceSet.name})`);
|
|
2709
|
-
* console.log(`Description: ${choiceSet.description}`);
|
|
2710
|
-
* console.log(`Created by: ${choiceSet.createdBy}`);
|
|
2711
|
-
* });
|
|
2882
|
+
* // A single folder's choice sets (preferred when targeting a specific folder)
|
|
2883
|
+
* const folderChoiceSets = await choicesets.getAll({ folderKey: "<folderKey>" });
|
|
2712
2884
|
*
|
|
2713
|
-
* //
|
|
2714
|
-
* const
|
|
2885
|
+
* // Tenant + folder choice sets together
|
|
2886
|
+
* const allChoiceSets = await choicesets.getAll({ includeFolderChoiceSets: true });
|
|
2715
2887
|
*
|
|
2716
|
-
* //
|
|
2717
|
-
*
|
|
2718
|
-
* console.log(`Last updated: ${expenseTypes.updatedTime}`);
|
|
2719
|
-
* console.log(`Updated by: ${expenseTypes.updatedBy}`);
|
|
2720
|
-
* }
|
|
2888
|
+
* // Find a specific choice set by name
|
|
2889
|
+
* const expenseTypes = tenantChoiceSets.find(cs => cs.name === 'ExpenseTypes');
|
|
2721
2890
|
* ```
|
|
2722
2891
|
*/
|
|
2723
|
-
getAll(): Promise<ChoiceSetGetAllResponse[]>;
|
|
2892
|
+
getAll(options?: ChoiceSetGetAllOptions): Promise<ChoiceSetGetAllResponse[]>;
|
|
2724
2893
|
/**
|
|
2725
2894
|
* Gets choice set values by choice set ID with optional pagination
|
|
2726
2895
|
*
|
|
@@ -2729,7 +2898,7 @@ interface ChoiceSetServiceModel {
|
|
|
2729
2898
|
* - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
|
|
2730
2899
|
*
|
|
2731
2900
|
* @param choiceSetId - UUID of the choice set
|
|
2732
|
-
* @param options - Pagination options
|
|
2901
|
+
* @param options - Pagination options and optional `folderKey` (omit for tenant-level choice sets) The `folderKey` property is **experimental**.
|
|
2733
2902
|
* @returns Promise resolving to choice set values or paginated result
|
|
2734
2903
|
* {@link ChoiceSetGetResponse}
|
|
2735
2904
|
* @example
|
|
@@ -2754,6 +2923,9 @@ interface ChoiceSetServiceModel {
|
|
|
2754
2923
|
* if (page1.hasNextPage) {
|
|
2755
2924
|
* const page2 = await choicesets.getById(choiceSetId, { cursor: page1.nextCursor });
|
|
2756
2925
|
* }
|
|
2926
|
+
*
|
|
2927
|
+
* // Folder-scoped choice set
|
|
2928
|
+
* const folderValues = await choicesets.getById(choiceSetId, { folderKey: "<folderKey>" });
|
|
2757
2929
|
* ```
|
|
2758
2930
|
*/
|
|
2759
2931
|
getById<T extends ChoiceSetGetByIdOptions = ChoiceSetGetByIdOptions>(choiceSetId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ChoiceSetGetResponse> : NonPaginatedResponse<ChoiceSetGetResponse>>;
|
|
@@ -2763,7 +2935,7 @@ interface ChoiceSetServiceModel {
|
|
|
2763
2935
|
* @param name - Choice set name. Must start with a
|
|
2764
2936
|
* letter, may contain only letters, numbers, and underscores, length
|
|
2765
2937
|
* 3–100 characters (e.g., `"expenseTypes"`).
|
|
2766
|
-
* @param options - Optional choice-set-level settings ({@link ChoiceSetCreateOptions})
|
|
2938
|
+
* @param options - Optional choice-set-level settings ({@link ChoiceSetCreateOptions}) The `folderKey` property is **experimental**.
|
|
2767
2939
|
* @returns Promise resolving to the UUID of the created choice set
|
|
2768
2940
|
*
|
|
2769
2941
|
* @example
|
|
@@ -2787,7 +2959,7 @@ interface ChoiceSetServiceModel {
|
|
|
2787
2959
|
* the call throws `ValidationError` if both are omitted.
|
|
2788
2960
|
*
|
|
2789
2961
|
* @param choiceSetId - UUID of the choice set to update
|
|
2790
|
-
* @param options - Metadata fields to change ({@link ChoiceSetUpdateOptions})
|
|
2962
|
+
* @param options - Metadata fields to change ({@link ChoiceSetUpdateOptions}) The `folderKey` property is **experimental**.
|
|
2791
2963
|
* @returns Promise resolving when the update is complete
|
|
2792
2964
|
*
|
|
2793
2965
|
* @example
|
|
@@ -2808,6 +2980,7 @@ interface ChoiceSetServiceModel {
|
|
|
2808
2980
|
* Deletes a Data Fabric choice set and all its values.
|
|
2809
2981
|
*
|
|
2810
2982
|
* @param choiceSetId - UUID of the choice set to delete
|
|
2983
|
+
* @param options - Optional {@link ChoiceSetDeleteByIdOptions} — pass `folderKey` for folder-scoped choice sets; omit for tenant-level The `folderKey` property is **experimental**.
|
|
2811
2984
|
* @returns Promise resolving when the choice set is deleted
|
|
2812
2985
|
*
|
|
2813
2986
|
* @example
|
|
@@ -2817,16 +2990,19 @@ interface ChoiceSetServiceModel {
|
|
|
2817
2990
|
* const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
|
|
2818
2991
|
*
|
|
2819
2992
|
* await choicesets.deleteById(expenseTypes.id);
|
|
2993
|
+
*
|
|
2994
|
+
* // Folder-scoped choice set
|
|
2995
|
+
* await choicesets.deleteById(expenseTypes.id, { folderKey: "<folderKey>" });
|
|
2820
2996
|
* ```
|
|
2821
2997
|
* @internal
|
|
2822
2998
|
*/
|
|
2823
|
-
deleteById(choiceSetId: string): Promise<void>;
|
|
2999
|
+
deleteById(choiceSetId: string, options?: ChoiceSetDeleteByIdOptions): Promise<void>;
|
|
2824
3000
|
/**
|
|
2825
3001
|
* Inserts a single value into a choice set.
|
|
2826
3002
|
*
|
|
2827
3003
|
* @param choiceSetId - UUID of the parent choice set
|
|
2828
3004
|
* @param name - Identifier name of the new value (e.g., `"TRAVEL"`)
|
|
2829
|
-
* @param options - Optional fields ({@link ChoiceSetValueInsertOptions})
|
|
3005
|
+
* @param options - Optional fields ({@link ChoiceSetValueInsertOptions}) The `folderKey` property is **experimental**.
|
|
2830
3006
|
* @returns Promise resolving to the inserted value ({@link ChoiceSetValueInsertResponse})
|
|
2831
3007
|
*
|
|
2832
3008
|
* @example
|
|
@@ -2839,6 +3015,12 @@ interface ChoiceSetServiceModel {
|
|
|
2839
3015
|
* displayName: 'Travel',
|
|
2840
3016
|
* });
|
|
2841
3017
|
* console.log(inserted.id);
|
|
3018
|
+
*
|
|
3019
|
+
* // Folder-scoped choice set: folderKey is required on the wire
|
|
3020
|
+
* await choicesets.insertValueById(expenseTypes.id, 'TRAVEL', {
|
|
3021
|
+
* displayName: 'Travel',
|
|
3022
|
+
* folderKey: "<folderKey>",
|
|
3023
|
+
* });
|
|
2842
3024
|
* ```
|
|
2843
3025
|
* @internal
|
|
2844
3026
|
*/
|
|
@@ -2852,6 +3034,7 @@ interface ChoiceSetServiceModel {
|
|
|
2852
3034
|
* @param choiceSetId - UUID of the parent choice set
|
|
2853
3035
|
* @param valueId - UUID of the value to update
|
|
2854
3036
|
* @param displayName - New human-readable display name for the value
|
|
3037
|
+
* @param options - Optional {@link ChoiceSetValueUpdateOptions} — pass `folderKey` for folder-scoped choice sets; omit for tenant-level. The `folderKey` property is **experimental**.
|
|
2855
3038
|
* @returns Promise resolving to the updated value ({@link ChoiceSetValueUpdateResponse})
|
|
2856
3039
|
*
|
|
2857
3040
|
* @example
|
|
@@ -2863,15 +3046,21 @@ interface ChoiceSetServiceModel {
|
|
|
2863
3046
|
* const travel = values.items.find(v => v.name === 'TRAVEL');
|
|
2864
3047
|
*
|
|
2865
3048
|
* await choicesets.updateValueById(expenseTypes.id, travel.id, 'Business Travel');
|
|
3049
|
+
*
|
|
3050
|
+
* // Folder-scoped choice set: folderKey is required on the wire
|
|
3051
|
+
* await choicesets.updateValueById(expenseTypes.id, travel.id, 'Business Travel', {
|
|
3052
|
+
* folderKey: "<folderKey>",
|
|
3053
|
+
* });
|
|
2866
3054
|
* ```
|
|
2867
3055
|
* @internal
|
|
2868
3056
|
*/
|
|
2869
|
-
updateValueById(choiceSetId: string, valueId: string, displayName: string): Promise<ChoiceSetValueUpdateResponse>;
|
|
3057
|
+
updateValueById(choiceSetId: string, valueId: string, displayName: string, options?: ChoiceSetValueUpdateOptions): Promise<ChoiceSetValueUpdateResponse>;
|
|
2870
3058
|
/**
|
|
2871
3059
|
* Deletes one or more values from a choice set.
|
|
2872
3060
|
*
|
|
2873
3061
|
* @param choiceSetId - UUID of the parent choice set
|
|
2874
3062
|
* @param valueIds - Array of value UUIDs to delete
|
|
3063
|
+
* @param options - Optional {@link ChoiceSetValueDeleteOptions} — pass `folderKey` for folder-scoped choice sets; omit for tenant-level The `folderKey` property is **experimental**.
|
|
2875
3064
|
* @returns Promise resolving when the values are deleted
|
|
2876
3065
|
*
|
|
2877
3066
|
* @example
|
|
@@ -2881,16 +3070,25 @@ interface ChoiceSetServiceModel {
|
|
|
2881
3070
|
* const idsToDelete = values.items.slice(0, 2).map(v => v.id);
|
|
2882
3071
|
*
|
|
2883
3072
|
* await choicesets.deleteValuesById('<choiceSetId>', idsToDelete);
|
|
3073
|
+
*
|
|
3074
|
+
* // Folder-scoped choice set
|
|
3075
|
+
* await choicesets.deleteValuesById('<choiceSetId>', idsToDelete, { folderKey: "<folderKey>" });
|
|
2884
3076
|
* ```
|
|
2885
3077
|
* @internal
|
|
2886
3078
|
*/
|
|
2887
|
-
deleteValuesById(choiceSetId: string, valueIds: string[]): Promise<void>;
|
|
3079
|
+
deleteValuesById(choiceSetId: string, valueIds: string[], options?: ChoiceSetValueDeleteOptions): Promise<void>;
|
|
2888
3080
|
}
|
|
2889
3081
|
|
|
2890
3082
|
declare class ChoiceSetService extends BaseService implements ChoiceSetServiceModel {
|
|
2891
3083
|
/**
|
|
2892
|
-
* Gets
|
|
3084
|
+
* Gets choice sets in the tenant.
|
|
3085
|
+
*
|
|
3086
|
+
* Three call modes:
|
|
3087
|
+
* - `getAll()` — default. Returns only tenant-level choice sets.
|
|
3088
|
+
* - `getAll({ folderKey: "<uuid>" })` — preferred for folder-scoped data. Returns only choice sets in that folder.
|
|
3089
|
+
* - `getAll({ includeFolderChoiceSets: true })` — returns tenant-level **and** folder-level choice sets together. `folderKey` is preferred over `includeFolderChoiceSets` when both are set.
|
|
2893
3090
|
*
|
|
3091
|
+
* @param options - Optional {@link ChoiceSetGetAllOptions} (`folderKey` to list a single folder's choice sets — preferred when scoping to a folder; `includeFolderChoiceSets: true` to list tenant + folder choice sets together) The `folderKey` property is **experimental**.
|
|
2894
3092
|
* @returns Promise resolving to an array of choice set metadata
|
|
2895
3093
|
*
|
|
2896
3094
|
* @example
|
|
@@ -2899,17 +3097,23 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
|
|
|
2899
3097
|
*
|
|
2900
3098
|
* const choiceSets = new ChoiceSets(sdk);
|
|
2901
3099
|
*
|
|
2902
|
-
* //
|
|
2903
|
-
* const
|
|
3100
|
+
* // Tenant-only (default)
|
|
3101
|
+
* const tenantChoiceSets = await choiceSets.getAll();
|
|
2904
3102
|
*
|
|
2905
|
-
* //
|
|
2906
|
-
*
|
|
2907
|
-
*
|
|
2908
|
-
*
|
|
2909
|
-
* });
|
|
3103
|
+
* // A single folder's choice sets (preferred when targeting a specific folder)
|
|
3104
|
+
* const folderChoiceSets = await choiceSets.getAll({ folderKey: "<folderKey>" });
|
|
3105
|
+
*
|
|
3106
|
+
* // Tenant + folder choice sets together
|
|
3107
|
+
* const allChoiceSets = await choiceSets.getAll({ includeFolderChoiceSets: true });
|
|
2910
3108
|
* ```
|
|
2911
3109
|
*/
|
|
2912
|
-
getAll(): Promise<ChoiceSetGetAllResponse[]>;
|
|
3110
|
+
getAll(options?: ChoiceSetGetAllOptions): Promise<ChoiceSetGetAllResponse[]>;
|
|
3111
|
+
/**
|
|
3112
|
+
* Internal helper that performs the choice-set fetch. Kept separate from the
|
|
3113
|
+
* public `getAll()` so that internal callers (e.g. `resolveChoiceSetName`)
|
|
3114
|
+
* can reuse it without triggering double `@track` telemetry.
|
|
3115
|
+
*/
|
|
3116
|
+
private fetchAllChoiceSets;
|
|
2913
3117
|
/**
|
|
2914
3118
|
* Gets choice set values by choice set ID with optional pagination
|
|
2915
3119
|
*
|
|
@@ -2918,7 +3122,7 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
|
|
|
2918
3122
|
* - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
|
|
2919
3123
|
*
|
|
2920
3124
|
* @param choiceSetId - UUID of the choice set
|
|
2921
|
-
* @param options - Pagination options
|
|
3125
|
+
* @param options - Pagination options and optional `folderKey` for folder-scoped choice sets The `folderKey` property is **experimental**.
|
|
2922
3126
|
* @returns Promise resolving to choice set values or paginated result
|
|
2923
3127
|
*
|
|
2924
3128
|
* @example
|
|
@@ -2947,6 +3151,9 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
|
|
|
2947
3151
|
* if (page1.hasNextPage) {
|
|
2948
3152
|
* const page2 = await choiceSets.getById(choiceSetId, { cursor: page1.nextCursor });
|
|
2949
3153
|
* }
|
|
3154
|
+
*
|
|
3155
|
+
* // Folder-scoped choice set
|
|
3156
|
+
* const folderValues = await choiceSets.getById(choiceSetId, { folderKey: "<folderKey>" });
|
|
2950
3157
|
* ```
|
|
2951
3158
|
*/
|
|
2952
3159
|
getById<T extends ChoiceSetGetByIdOptions = ChoiceSetGetByIdOptions>(choiceSetId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ChoiceSetGetResponse> : NonPaginatedResponse<ChoiceSetGetResponse>>;
|
|
@@ -2956,7 +3163,7 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
|
|
|
2956
3163
|
* @param name - Choice set name. Must start with a
|
|
2957
3164
|
* letter, may contain only letters, numbers, and underscores, length
|
|
2958
3165
|
* 3–100 characters (e.g., `"expenseTypes"`).
|
|
2959
|
-
* @param options - Optional choice-set-level settings ({@link ChoiceSetCreateOptions})
|
|
3166
|
+
* @param options - Optional choice-set-level settings ({@link ChoiceSetCreateOptions}) The `folderKey` property is **experimental**.
|
|
2960
3167
|
* @returns Promise resolving to the UUID of the created choice set
|
|
2961
3168
|
*
|
|
2962
3169
|
* @example
|
|
@@ -2984,7 +3191,7 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
|
|
|
2984
3191
|
* the call throws `ValidationError` if both are omitted.
|
|
2985
3192
|
*
|
|
2986
3193
|
* @param choiceSetId - UUID of the choice set to update
|
|
2987
|
-
* @param options - Metadata fields to change ({@link ChoiceSetUpdateOptions})
|
|
3194
|
+
* @param options - Metadata fields to change ({@link ChoiceSetUpdateOptions}) The `folderKey` property is **experimental**.
|
|
2988
3195
|
* @returns Promise resolving when the update is complete
|
|
2989
3196
|
*
|
|
2990
3197
|
* @example
|
|
@@ -3005,6 +3212,7 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
|
|
|
3005
3212
|
* Deletes a Data Fabric choice set and all its values.
|
|
3006
3213
|
*
|
|
3007
3214
|
* @param choiceSetId - UUID of the choice set to delete
|
|
3215
|
+
* @param options - Optional {@link ChoiceSetDeleteByIdOptions} (e.g. `folderKey` for folder-scoped choice sets) The `folderKey` property is **experimental**.
|
|
3008
3216
|
* @returns Promise resolving when the choice set is deleted
|
|
3009
3217
|
*
|
|
3010
3218
|
* @example
|
|
@@ -3014,16 +3222,19 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
|
|
|
3014
3222
|
* const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
|
|
3015
3223
|
*
|
|
3016
3224
|
* await choicesets.deleteById(expenseTypes.id);
|
|
3225
|
+
*
|
|
3226
|
+
* // Folder-scoped choice set
|
|
3227
|
+
* await choicesets.deleteById(expenseTypes.id, { folderKey: "<folderKey>" });
|
|
3017
3228
|
* ```
|
|
3018
3229
|
* @internal
|
|
3019
3230
|
*/
|
|
3020
|
-
deleteById(choiceSetId: string): Promise<void>;
|
|
3231
|
+
deleteById(choiceSetId: string, options?: ChoiceSetDeleteByIdOptions): Promise<void>;
|
|
3021
3232
|
/**
|
|
3022
3233
|
* Inserts a single value into a choice set.
|
|
3023
3234
|
*
|
|
3024
3235
|
* @param choiceSetId - UUID of the parent choice set
|
|
3025
3236
|
* @param name - Identifier name of the new value (e.g., `"TRAVEL"`)
|
|
3026
|
-
* @param options - Optional fields ({@link ChoiceSetValueInsertOptions})
|
|
3237
|
+
* @param options - Optional fields ({@link ChoiceSetValueInsertOptions}) The `folderKey` property is **experimental**.
|
|
3027
3238
|
* @returns Promise resolving to the inserted value ({@link ChoiceSetValueInsertResponse})
|
|
3028
3239
|
*
|
|
3029
3240
|
* @example
|
|
@@ -3036,6 +3247,12 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
|
|
|
3036
3247
|
* displayName: 'Travel',
|
|
3037
3248
|
* });
|
|
3038
3249
|
* console.log(inserted.id);
|
|
3250
|
+
*
|
|
3251
|
+
* // Folder-scoped choice set: folderKey is required on the wire
|
|
3252
|
+
* await choicesets.insertValueById(expenseTypes.id, 'TRAVEL', {
|
|
3253
|
+
* displayName: 'Travel',
|
|
3254
|
+
* folderKey: "<folderKey>",
|
|
3255
|
+
* });
|
|
3039
3256
|
* ```
|
|
3040
3257
|
* @internal
|
|
3041
3258
|
*/
|
|
@@ -3049,6 +3266,7 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
|
|
|
3049
3266
|
* @param choiceSetId - UUID of the parent choice set
|
|
3050
3267
|
* @param valueId - UUID of the value to update
|
|
3051
3268
|
* @param displayName - New human-readable display name for the value
|
|
3269
|
+
* @param options - Optional {@link ChoiceSetValueUpdateOptions} — pass `folderKey` for folder-scoped choice sets; omit for tenant-level. The `folderKey` property is **experimental**.
|
|
3052
3270
|
* @returns Promise resolving to the updated value ({@link ChoiceSetValueUpdateResponse})
|
|
3053
3271
|
*
|
|
3054
3272
|
* @example
|
|
@@ -3060,15 +3278,21 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
|
|
|
3060
3278
|
* const travel = values.items.find(v => v.name === 'TRAVEL');
|
|
3061
3279
|
*
|
|
3062
3280
|
* await choicesets.updateValueById(expenseTypes.id, travel.id, 'Business Travel');
|
|
3281
|
+
*
|
|
3282
|
+
* // Folder-scoped choice set: folderKey is required on the wire
|
|
3283
|
+
* await choicesets.updateValueById(expenseTypes.id, travel.id, 'Business Travel', {
|
|
3284
|
+
* folderKey: "<folderKey>",
|
|
3285
|
+
* });
|
|
3063
3286
|
* ```
|
|
3064
3287
|
* @internal
|
|
3065
3288
|
*/
|
|
3066
|
-
updateValueById(choiceSetId: string, valueId: string, displayName: string): Promise<ChoiceSetValueUpdateResponse>;
|
|
3289
|
+
updateValueById(choiceSetId: string, valueId: string, displayName: string, options?: ChoiceSetValueUpdateOptions): Promise<ChoiceSetValueUpdateResponse>;
|
|
3067
3290
|
/**
|
|
3068
3291
|
* Deletes one or more values from a choice set.
|
|
3069
3292
|
*
|
|
3070
3293
|
* @param choiceSetId - UUID of the parent choice set
|
|
3071
3294
|
* @param valueIds - Array of value UUIDs to delete
|
|
3295
|
+
* @param options - Optional {@link ChoiceSetValueDeleteOptions} (e.g. `folderKey` for folder-scoped choice sets) The `folderKey` property is **experimental**.
|
|
3072
3296
|
* @returns Promise resolving when the values are deleted
|
|
3073
3297
|
*
|
|
3074
3298
|
* @example
|
|
@@ -3078,10 +3302,13 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
|
|
|
3078
3302
|
* const idsToDelete = values.items.slice(0, 2).map(v => v.id);
|
|
3079
3303
|
*
|
|
3080
3304
|
* await choicesets.deleteValuesById('<choiceSetId>', idsToDelete);
|
|
3305
|
+
*
|
|
3306
|
+
* // Folder-scoped choice set
|
|
3307
|
+
* await choicesets.deleteValuesById('<choiceSetId>', idsToDelete, { folderKey: "<folderKey>" });
|
|
3081
3308
|
* ```
|
|
3082
3309
|
* @internal
|
|
3083
3310
|
*/
|
|
3084
|
-
deleteValuesById(choiceSetId: string, valueIds: string[]): Promise<void>;
|
|
3311
|
+
deleteValuesById(choiceSetId: string, valueIds: string[], options?: ChoiceSetValueDeleteOptions): Promise<void>;
|
|
3085
3312
|
private resolveChoiceSetName;
|
|
3086
3313
|
}
|
|
3087
3314
|
|
|
@@ -5056,22 +5283,49 @@ interface RawTaskGetResponse extends TaskBaseResponse {
|
|
|
5056
5283
|
actionLabel?: string | null;
|
|
5057
5284
|
taskSlaDetails?: TaskSlaDetail[] | null;
|
|
5058
5285
|
completedByUser?: UserLoginInfo | null;
|
|
5059
|
-
taskAssignmentCriteria?:
|
|
5286
|
+
taskAssignmentCriteria?: TaskAssignmentCriteria;
|
|
5060
5287
|
taskAssignees?: UserLoginInfo[] | null;
|
|
5061
5288
|
taskSource?: TaskSource | null;
|
|
5062
5289
|
processingTime?: number | null;
|
|
5063
5290
|
data?: Record<string, unknown> | null;
|
|
5064
5291
|
}
|
|
5292
|
+
/**
|
|
5293
|
+
* Defines how a task assignment is distributed.
|
|
5294
|
+
*
|
|
5295
|
+
* Defaults to {@link TaskAssignmentCriteria.SingleUser} (a direct single-user
|
|
5296
|
+
* assignment) when not specified. The group-based criteria tell Action Center
|
|
5297
|
+
* how to distribute the task across the members of a directory group.
|
|
5298
|
+
*/
|
|
5299
|
+
declare enum TaskAssignmentCriteria {
|
|
5300
|
+
/** Assigned to a single user, like a direct assignment. */
|
|
5301
|
+
SingleUser = "SingleUser",
|
|
5302
|
+
/** Assigned to the group member with the fewest pending tasks. */
|
|
5303
|
+
Workload = "Workload",
|
|
5304
|
+
/** Assigned to all users in the group. */
|
|
5305
|
+
AllUsers = "AllUsers",
|
|
5306
|
+
/** Assigned in a round-robin manner across the group's members. */
|
|
5307
|
+
RoundRobin = "RoundRobin"
|
|
5308
|
+
}
|
|
5065
5309
|
/**
|
|
5066
5310
|
* Options for task assignment operations when called from a task instance
|
|
5067
|
-
* Requires either userId or userNameOrEmail, but not both
|
|
5311
|
+
* Requires either userId or userNameOrEmail, but not both. Optionally accepts
|
|
5312
|
+
* an assignment criteria; defaults to a single-user assignment, set a group
|
|
5313
|
+
* criteria (e.g. {@link TaskAssignmentCriteria.AllUsers}) for a directory group.
|
|
5068
5314
|
*/
|
|
5069
|
-
type TaskAssignOptions = {
|
|
5315
|
+
type TaskAssignOptions = ({
|
|
5070
5316
|
userId: number;
|
|
5071
5317
|
userNameOrEmail?: never;
|
|
5072
5318
|
} | {
|
|
5073
5319
|
userId?: never;
|
|
5074
5320
|
userNameOrEmail: string;
|
|
5321
|
+
}) & {
|
|
5322
|
+
/**
|
|
5323
|
+
* How the assignment is distributed. Optional — defaults to
|
|
5324
|
+
* {@link TaskAssignmentCriteria.SingleUser} (a direct single-user assignment).
|
|
5325
|
+
* Set a group criteria (e.g. {@link TaskAssignmentCriteria.AllUsers}) to
|
|
5326
|
+
* distribute the task across a directory group's members.
|
|
5327
|
+
*/
|
|
5328
|
+
assignmentCriteria?: TaskAssignmentCriteria;
|
|
5075
5329
|
};
|
|
5076
5330
|
/**
|
|
5077
5331
|
* Options for task assignment operations when called from the service
|
|
@@ -5291,6 +5545,26 @@ interface TaskServiceModel {
|
|
|
5291
5545
|
* { taskId: <taskId2>, userNameOrEmail: "user@example.com" }
|
|
5292
5546
|
* ]);
|
|
5293
5547
|
* ```
|
|
5548
|
+
*
|
|
5549
|
+
* @example Group assignment
|
|
5550
|
+
* ```typescript
|
|
5551
|
+
* import { TaskAssignmentCriteria } from '@uipath/uipath-typescript/tasks';
|
|
5552
|
+
*
|
|
5553
|
+
* // Assign to a directory group by userId + criteria — Action Center
|
|
5554
|
+
* // distributes the task across the group's members based on the criteria
|
|
5555
|
+
* const result = await tasks.assign({
|
|
5556
|
+
* taskId: <taskId>,
|
|
5557
|
+
* userId: <groupId>, // a DirectoryGroup id from tasks.getUsers()
|
|
5558
|
+
* assignmentCriteria: TaskAssignmentCriteria.AllUsers
|
|
5559
|
+
* });
|
|
5560
|
+
*
|
|
5561
|
+
* // ...or identify the group by name instead of id
|
|
5562
|
+
* const result2 = await tasks.assign({
|
|
5563
|
+
* taskId: <taskId>,
|
|
5564
|
+
* userNameOrEmail: "<groupName>",
|
|
5565
|
+
* assignmentCriteria: TaskAssignmentCriteria.AllUsers
|
|
5566
|
+
* });
|
|
5567
|
+
* ```
|
|
5294
5568
|
*/
|
|
5295
5569
|
assign(options: TaskAssignmentOptions | TaskAssignmentOptions[]): Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>;
|
|
5296
5570
|
/**
|
|
@@ -5325,6 +5599,25 @@ interface TaskServiceModel {
|
|
|
5325
5599
|
* { taskId: <taskId2>, userNameOrEmail: "user@example.com" }
|
|
5326
5600
|
* ]);
|
|
5327
5601
|
* ```
|
|
5602
|
+
*
|
|
5603
|
+
* @example Group reassignment
|
|
5604
|
+
* ```typescript
|
|
5605
|
+
* import { TaskAssignmentCriteria } from '@uipath/uipath-typescript/tasks';
|
|
5606
|
+
*
|
|
5607
|
+
* // Reassign to a directory group by userId + criteria
|
|
5608
|
+
* const result = await tasks.reassign({
|
|
5609
|
+
* taskId: <taskId>,
|
|
5610
|
+
* userId: <groupId>, // a DirectoryGroup id from tasks.getUsers()
|
|
5611
|
+
* assignmentCriteria: TaskAssignmentCriteria.AllUsers
|
|
5612
|
+
* });
|
|
5613
|
+
*
|
|
5614
|
+
* // ...or identify the group by name instead of id
|
|
5615
|
+
* const result2 = await tasks.reassign({
|
|
5616
|
+
* taskId: <taskId>,
|
|
5617
|
+
* userNameOrEmail: "<groupName>",
|
|
5618
|
+
* assignmentCriteria: TaskAssignmentCriteria.AllUsers
|
|
5619
|
+
* });
|
|
5620
|
+
* ```
|
|
5328
5621
|
*/
|
|
5329
5622
|
reassign(options: TaskAssignmentOptions | TaskAssignmentOptions[]): Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>;
|
|
5330
5623
|
/**
|
|
@@ -7197,10 +7490,6 @@ interface BucketGetUriOptions extends BaseOptions {
|
|
|
7197
7490
|
* The ID of the bucket
|
|
7198
7491
|
*/
|
|
7199
7492
|
bucketId: number;
|
|
7200
|
-
/**
|
|
7201
|
-
* The ID of the folder
|
|
7202
|
-
*/
|
|
7203
|
-
folderId: number;
|
|
7204
7493
|
/**
|
|
7205
7494
|
* The full path to the BlobFile
|
|
7206
7495
|
*/
|
|
@@ -7211,9 +7500,23 @@ interface BucketGetUriOptions extends BaseOptions {
|
|
|
7211
7500
|
expiryInMinutes?: number;
|
|
7212
7501
|
}
|
|
7213
7502
|
/**
|
|
7214
|
-
*
|
|
7503
|
+
* Optional parameters for the preferred `getReadUri(bucketId, path, options?)` form.
|
|
7504
|
+
* Contains folder scoping (`folderId` / `folderKey` / `folderPath`),
|
|
7505
|
+
* `expiryInMinutes`, and standard query options (`expand`, `select`).
|
|
7506
|
+
*/
|
|
7507
|
+
interface BucketGetReadUriRequestOptions extends BaseOptions, FolderScopedOptions {
|
|
7508
|
+
/**
|
|
7509
|
+
* URL expiration time in minutes (0 for default)
|
|
7510
|
+
*/
|
|
7511
|
+
expiryInMinutes?: number;
|
|
7512
|
+
}
|
|
7513
|
+
/**
|
|
7514
|
+
* @deprecated Use the positional form: `getReadUri(bucketId, path, options?)`.
|
|
7515
|
+
* See {@link BucketGetReadUriRequestOptions} for the supported options.
|
|
7516
|
+
*
|
|
7517
|
+
* Request options for getting a read URI for a file in a bucket.
|
|
7215
7518
|
*/
|
|
7216
|
-
interface BucketGetReadUriOptions extends BucketGetUriOptions {
|
|
7519
|
+
interface BucketGetReadUriOptions extends BucketGetUriOptions, FolderScopedOptions {
|
|
7217
7520
|
}
|
|
7218
7521
|
/**
|
|
7219
7522
|
* Request options for getting files in a bucket
|
|
@@ -7227,7 +7530,7 @@ interface BucketGetFileMetaDataOptions {
|
|
|
7227
7530
|
/**
|
|
7228
7531
|
* Request options for getting files in a bucket with pagination support
|
|
7229
7532
|
*/
|
|
7230
|
-
type BucketGetFileMetaDataWithPaginationOptions = BucketGetFileMetaDataOptions & PaginationOptions;
|
|
7533
|
+
type BucketGetFileMetaDataWithPaginationOptions = BucketGetFileMetaDataOptions & PaginationOptions & FolderScopedOptions;
|
|
7231
7534
|
/**
|
|
7232
7535
|
* Response from the GetFiles API
|
|
7233
7536
|
*/
|
|
@@ -7302,17 +7605,23 @@ type BucketGetFilesOptions = RequestOptions & PaginationOptions & FolderScopedOp
|
|
|
7302
7605
|
interface BucketDeleteFileOptions extends FolderScopedOptions {
|
|
7303
7606
|
}
|
|
7304
7607
|
/**
|
|
7305
|
-
*
|
|
7608
|
+
* Optional parameters for the preferred
|
|
7609
|
+
* `uploadFile(bucketId, path, content, options?)` form. Contains folder
|
|
7610
|
+
* scoping (`folderId` / `folderKey` / `folderPath`).
|
|
7611
|
+
*/
|
|
7612
|
+
interface BucketUploadFileRequestOptions extends FolderScopedOptions {
|
|
7613
|
+
}
|
|
7614
|
+
/**
|
|
7615
|
+
* @deprecated Use the positional form: `uploadFile(bucketId, path, content, options?)`.
|
|
7616
|
+
* See {@link BucketUploadFileRequestOptions} for the supported options.
|
|
7617
|
+
*
|
|
7618
|
+
* Options for uploading files to a bucket.
|
|
7306
7619
|
*/
|
|
7307
|
-
interface BucketUploadFileOptions {
|
|
7620
|
+
interface BucketUploadFileOptions extends FolderScopedOptions {
|
|
7308
7621
|
/**
|
|
7309
7622
|
* The ID of the bucket to upload to
|
|
7310
7623
|
*/
|
|
7311
7624
|
bucketId: number;
|
|
7312
|
-
/**
|
|
7313
|
-
* The folder/organization unit ID for context
|
|
7314
|
-
*/
|
|
7315
|
-
folderId: number;
|
|
7316
7625
|
/**
|
|
7317
7626
|
* Path where the file should be stored in the bucket
|
|
7318
7627
|
*/
|
|
@@ -7430,81 +7739,128 @@ interface BucketServiceModel {
|
|
|
7430
7739
|
*/
|
|
7431
7740
|
getByName(name: string, options?: BucketGetByNameOptions): Promise<BucketGetResponse>;
|
|
7432
7741
|
/**
|
|
7433
|
-
* Gets metadata for files in a bucket with optional filtering and pagination
|
|
7742
|
+
* Gets metadata for files in a bucket with optional filtering and pagination.
|
|
7743
|
+
*
|
|
7744
|
+
* Folder context can be supplied as `folderId`, `folderKey`, or `folderPath`
|
|
7745
|
+
* inside the options.
|
|
7434
7746
|
*
|
|
7435
7747
|
* The method returns either:
|
|
7436
7748
|
* - A NonPaginatedResponse with items array (when no pagination parameters are provided)
|
|
7437
7749
|
* - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
|
|
7438
7750
|
*
|
|
7439
7751
|
* @param bucketId - The ID of the bucket to get file metadata from
|
|
7440
|
-
* @param
|
|
7441
|
-
* @param options - Optional parameters for filtering, pagination and access URL generation
|
|
7752
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional parameters for filtering and pagination
|
|
7442
7753
|
* @returns Promise resolving to either an array of files metadata NonPaginatedResponse<BlobItem> or a PaginatedResponse<BlobItem> when pagination options are used.
|
|
7443
7754
|
* {@link BlobItem}
|
|
7444
7755
|
* @example
|
|
7445
7756
|
* ```typescript
|
|
7446
|
-
* //
|
|
7447
|
-
* const fileMetadata = await buckets.getFileMetaData(<bucketId>, <folderId>);
|
|
7757
|
+
* // By folder ID
|
|
7758
|
+
* const fileMetadata = await buckets.getFileMetaData(<bucketId>, { folderId: <folderId> });
|
|
7448
7759
|
*
|
|
7449
|
-
* //
|
|
7450
|
-
*
|
|
7451
|
-
*
|
|
7452
|
-
*
|
|
7760
|
+
* // By folder key (GUID)
|
|
7761
|
+
* await buckets.getFileMetaData(<bucketId>, { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
|
|
7762
|
+
*
|
|
7763
|
+
* // By folder path
|
|
7764
|
+
* await buckets.getFileMetaData(<bucketId>, { folderPath: 'Shared/Finance' });
|
|
7765
|
+
*
|
|
7766
|
+
* // Filter by prefix
|
|
7767
|
+
* await buckets.getFileMetaData(<bucketId>, { folderId: <folderId>, prefix: '/folder1' });
|
|
7453
7768
|
*
|
|
7454
7769
|
* // First page with pagination
|
|
7455
|
-
* const page1 = await buckets.getFileMetaData(<bucketId>, <folderId>,
|
|
7770
|
+
* const page1 = await buckets.getFileMetaData(<bucketId>, { folderId: <folderId>, pageSize: 10 });
|
|
7456
7771
|
*
|
|
7457
7772
|
* // Navigate using cursor
|
|
7458
7773
|
* if (page1.hasNextPage) {
|
|
7459
|
-
* const page2 = await buckets.getFileMetaData(<bucketId>, <folderId>,
|
|
7774
|
+
* const page2 = await buckets.getFileMetaData(<bucketId>, { folderId: <folderId>, cursor: page1.nextCursor });
|
|
7460
7775
|
* }
|
|
7461
7776
|
* ```
|
|
7462
7777
|
*/
|
|
7778
|
+
getFileMetaData<T extends BucketGetFileMetaDataWithPaginationOptions = BucketGetFileMetaDataWithPaginationOptions>(bucketId: number, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<BlobItem> : NonPaginatedResponse<BlobItem>>;
|
|
7779
|
+
/**
|
|
7780
|
+
* Gets metadata for files in a bucket — positional `folderId` form.
|
|
7781
|
+
*
|
|
7782
|
+
* @deprecated Use the options-object form: `getFileMetaData(bucketId, { folderId })`. See {@link BucketGetFileMetaDataWithPaginationOptions} for the supported options.
|
|
7783
|
+
*
|
|
7784
|
+
* @param bucketId - The ID of the bucket to get file metadata from
|
|
7785
|
+
* @param folderId - Required folder ID (numeric)
|
|
7786
|
+
* @param options - Optional parameters for filtering and pagination
|
|
7787
|
+
* @returns Promise resolving to either an array of files metadata NonPaginatedResponse<BlobItem> or a PaginatedResponse<BlobItem> when pagination options are used.
|
|
7788
|
+
* {@link BlobItem}
|
|
7789
|
+
*/
|
|
7463
7790
|
getFileMetaData<T extends BucketGetFileMetaDataWithPaginationOptions = BucketGetFileMetaDataWithPaginationOptions>(bucketId: number, folderId: number, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<BlobItem> : NonPaginatedResponse<BlobItem>>;
|
|
7464
7791
|
/**
|
|
7465
|
-
* Gets a direct download URL for a file in the bucket
|
|
7792
|
+
* Gets a direct download URL for a file in the bucket.
|
|
7793
|
+
*
|
|
7794
|
+
* Folder context can be supplied as `folderId`, `folderKey`, or `folderPath`
|
|
7795
|
+
* in the options.
|
|
7466
7796
|
*
|
|
7467
|
-
* @param
|
|
7797
|
+
* @param bucketId - The ID of the bucket
|
|
7798
|
+
* @param path - The full path to the file
|
|
7799
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional `expiryInMinutes`
|
|
7468
7800
|
* @returns Promise resolving to blob file access information
|
|
7469
7801
|
* {@link BucketGetUriResponse}
|
|
7470
7802
|
* @example
|
|
7471
7803
|
* ```typescript
|
|
7472
|
-
* //
|
|
7473
|
-
*
|
|
7474
|
-
*
|
|
7475
|
-
*
|
|
7476
|
-
*
|
|
7477
|
-
*
|
|
7804
|
+
* // By folder ID
|
|
7805
|
+
* await buckets.getReadUri(<bucketId>, '/folder/file.pdf', { folderId: <folderId> });
|
|
7806
|
+
*
|
|
7807
|
+
* // By folder key (GUID)
|
|
7808
|
+
* await buckets.getReadUri(<bucketId>, '/folder/file.pdf', { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
|
|
7809
|
+
*
|
|
7810
|
+
* // By folder path
|
|
7811
|
+
* await buckets.getReadUri(<bucketId>, '/folder/file.pdf', { folderPath: 'Shared/Finance' });
|
|
7478
7812
|
* ```
|
|
7479
7813
|
*/
|
|
7814
|
+
getReadUri(bucketId: number, path: string, options?: BucketGetReadUriRequestOptions): Promise<BucketGetUriResponse>;
|
|
7815
|
+
/**
|
|
7816
|
+
* Gets a direct download URL for a file in the bucket — options-only form.
|
|
7817
|
+
*
|
|
7818
|
+
* @deprecated Use the positional form: `getReadUri(bucketId, path, options?)`. See {@link BucketGetReadUriRequestOptions} for the supported options.
|
|
7819
|
+
*
|
|
7820
|
+
* @param options - Contains bucketId, folder scoping (`folderId` / `folderKey` / `folderPath`), file path and optional expiry time
|
|
7821
|
+
* @returns Promise resolving to blob file access information
|
|
7822
|
+
* {@link BucketGetUriResponse}
|
|
7823
|
+
*/
|
|
7480
7824
|
getReadUri(options: BucketGetReadUriOptions): Promise<BucketGetUriResponse>;
|
|
7481
7825
|
/**
|
|
7482
|
-
* Uploads a file to a bucket
|
|
7826
|
+
* Uploads a file to a bucket.
|
|
7827
|
+
*
|
|
7828
|
+
* Folder context can be supplied as `folderId`, `folderKey`, or `folderPath`
|
|
7829
|
+
* in the options.
|
|
7483
7830
|
*
|
|
7484
|
-
* @param
|
|
7831
|
+
* @param bucketId - The ID of the bucket to upload to
|
|
7832
|
+
* @param path - Path where the file should be stored in the bucket
|
|
7833
|
+
* @param content - File content to upload
|
|
7834
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`)
|
|
7485
7835
|
* @returns Promise resolving bucket upload response
|
|
7486
7836
|
* {@link BucketUploadResponse}
|
|
7487
7837
|
* @example
|
|
7488
7838
|
* ```typescript
|
|
7489
|
-
* //
|
|
7839
|
+
* // By folder ID
|
|
7490
7840
|
* const file = new File(['file content'], 'example.txt');
|
|
7491
|
-
*
|
|
7492
|
-
*
|
|
7493
|
-
*
|
|
7494
|
-
*
|
|
7495
|
-
*
|
|
7496
|
-
*
|
|
7841
|
+
* await buckets.uploadFile(<bucketId>, '/folder/example.txt', file, { folderId: <folderId> });
|
|
7842
|
+
*
|
|
7843
|
+
* // By folder key (GUID)
|
|
7844
|
+
* await buckets.uploadFile(<bucketId>, '/folder/example.txt', file, { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
|
|
7845
|
+
*
|
|
7846
|
+
* // By folder path
|
|
7847
|
+
* await buckets.uploadFile(<bucketId>, '/folder/example.txt', file, { folderPath: 'Shared/Finance' });
|
|
7497
7848
|
*
|
|
7498
7849
|
* // In Node env with Uint8Array or Buffer
|
|
7499
7850
|
* const content = new TextEncoder().encode('file content');
|
|
7500
|
-
*
|
|
7501
|
-
* bucketId: <bucketId>,
|
|
7502
|
-
* folderId: <folderId>,
|
|
7503
|
-
* path: '/folder/example.txt',
|
|
7504
|
-
* content,
|
|
7505
|
-
* });
|
|
7851
|
+
* await buckets.uploadFile(<bucketId>, '/folder/example.txt', content, { folderId: <folderId> });
|
|
7506
7852
|
* ```
|
|
7507
7853
|
*/
|
|
7854
|
+
uploadFile(bucketId: number, path: string, content: Blob | Uint8Array<ArrayBuffer> | File, options?: BucketUploadFileRequestOptions): Promise<BucketUploadResponse>;
|
|
7855
|
+
/**
|
|
7856
|
+
* Uploads a file to a bucket — options-only form.
|
|
7857
|
+
*
|
|
7858
|
+
* @deprecated Use the positional form: `uploadFile(bucketId, path, content, options?)`. See {@link BucketUploadFileRequestOptions} for the supported options.
|
|
7859
|
+
*
|
|
7860
|
+
* @param options - Options for file upload including bucket ID, folder scoping (`folderId` / `folderKey` / `folderPath`), path, and content
|
|
7861
|
+
* @returns Promise resolving bucket upload response
|
|
7862
|
+
* {@link BucketUploadResponse}
|
|
7863
|
+
*/
|
|
7508
7864
|
uploadFile(options: BucketUploadFileOptions): Promise<BucketUploadResponse>;
|
|
7509
7865
|
/**
|
|
7510
7866
|
* Deletes a file from a bucket
|
|
@@ -7655,16 +8011,19 @@ declare class BucketService extends FolderScopedService implements BucketService
|
|
|
7655
8011
|
*/
|
|
7656
8012
|
getAll<T extends BucketGetAllOptions = BucketGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<BucketGetResponse> : NonPaginatedResponse<BucketGetResponse>>;
|
|
7657
8013
|
/**
|
|
7658
|
-
* Gets metadata for files in a bucket with optional filtering and pagination
|
|
8014
|
+
* Gets metadata for files in a bucket with optional filtering and pagination.
|
|
8015
|
+
*
|
|
8016
|
+
* Folder context can be supplied as `folderId`, `folderKey`, or `folderPath`
|
|
8017
|
+
* inside the options.
|
|
7659
8018
|
*
|
|
7660
8019
|
* The method returns either:
|
|
7661
8020
|
* - A NonPaginatedResponse with items array (when no pagination parameters are provided)
|
|
7662
8021
|
* - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
|
|
7663
8022
|
*
|
|
7664
8023
|
* @param bucketId - The ID of the bucket to get file metadata from
|
|
7665
|
-
* @param
|
|
7666
|
-
* @param options - Optional parameters for filtering, pagination and access URL generation
|
|
8024
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional parameters for filtering and pagination
|
|
7667
8025
|
* @returns Promise resolving to the list of file metadata in the bucket or paginated result
|
|
8026
|
+
* {@link BlobItem}
|
|
7668
8027
|
*
|
|
7669
8028
|
* @example
|
|
7670
8029
|
* ```typescript
|
|
@@ -7672,29 +8031,52 @@ declare class BucketService extends FolderScopedService implements BucketService
|
|
|
7672
8031
|
*
|
|
7673
8032
|
* const buckets = new Buckets(sdk);
|
|
7674
8033
|
*
|
|
7675
|
-
* //
|
|
7676
|
-
* const fileMetadata = await buckets.getFileMetaData(
|
|
8034
|
+
* // By folder ID
|
|
8035
|
+
* const fileMetadata = await buckets.getFileMetaData(<bucketId>, { folderId: <folderId> });
|
|
7677
8036
|
*
|
|
7678
|
-
* //
|
|
7679
|
-
*
|
|
7680
|
-
*
|
|
7681
|
-
*
|
|
8037
|
+
* // By folder key (GUID)
|
|
8038
|
+
* await buckets.getFileMetaData(<bucketId>, { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
|
|
8039
|
+
*
|
|
8040
|
+
* // By folder path
|
|
8041
|
+
* await buckets.getFileMetaData(<bucketId>, { folderPath: 'Shared/Finance' });
|
|
8042
|
+
*
|
|
8043
|
+
* // Filter by prefix
|
|
8044
|
+
* await buckets.getFileMetaData(<bucketId>, { folderId: <folderId>, prefix: '/folder1' });
|
|
7682
8045
|
*
|
|
7683
8046
|
* // First page with pagination
|
|
7684
|
-
* const page1 = await buckets.getFileMetaData(
|
|
8047
|
+
* const page1 = await buckets.getFileMetaData(<bucketId>, { folderId: <folderId>, pageSize: 10 });
|
|
7685
8048
|
*
|
|
7686
8049
|
* // Navigate using cursor
|
|
7687
8050
|
* if (page1.hasNextPage) {
|
|
7688
|
-
* const page2 = await buckets.getFileMetaData(
|
|
8051
|
+
* const page2 = await buckets.getFileMetaData(<bucketId>, { folderId: <folderId>, cursor: page1.nextCursor });
|
|
7689
8052
|
* }
|
|
7690
8053
|
* ```
|
|
7691
8054
|
*/
|
|
8055
|
+
getFileMetaData<T extends BucketGetFileMetaDataWithPaginationOptions = BucketGetFileMetaDataWithPaginationOptions>(bucketId: number, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<BlobItem> : NonPaginatedResponse<BlobItem>>;
|
|
8056
|
+
/**
|
|
8057
|
+
* Gets metadata for files in a bucket — positional `folderId` form.
|
|
8058
|
+
*
|
|
8059
|
+
* @deprecated Use the options-object form: `getFileMetaData(bucketId, { folderId })`. See {@link BucketGetFileMetaDataWithPaginationOptions} for the supported options.
|
|
8060
|
+
*
|
|
8061
|
+
* @param bucketId - The ID of the bucket to get file metadata from
|
|
8062
|
+
* @param folderId - Required folder ID (numeric)
|
|
8063
|
+
* @param options - Optional parameters for filtering and pagination
|
|
8064
|
+
* @returns Promise resolving to the list of file metadata in the bucket or paginated result
|
|
8065
|
+
* {@link BlobItem}
|
|
8066
|
+
*/
|
|
7692
8067
|
getFileMetaData<T extends BucketGetFileMetaDataWithPaginationOptions = BucketGetFileMetaDataWithPaginationOptions>(bucketId: number, folderId: number, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<BlobItem> : NonPaginatedResponse<BlobItem>>;
|
|
7693
8068
|
/**
|
|
7694
|
-
* Uploads a file to a bucket
|
|
8069
|
+
* Uploads a file to a bucket.
|
|
8070
|
+
*
|
|
8071
|
+
* Folder context can be supplied as `folderId`, `folderKey`, or `folderPath`
|
|
8072
|
+
* in the options.
|
|
7695
8073
|
*
|
|
7696
|
-
* @param
|
|
8074
|
+
* @param bucketId - The ID of the bucket to upload to
|
|
8075
|
+
* @param path - Path where the file should be stored in the bucket
|
|
8076
|
+
* @param content - File content to upload
|
|
8077
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`)
|
|
7697
8078
|
* @returns Promise resolving to a response with success status and HTTP status code
|
|
8079
|
+
* {@link BucketUploadResponse}
|
|
7698
8080
|
*
|
|
7699
8081
|
* @example
|
|
7700
8082
|
* ```typescript
|
|
@@ -7702,31 +8084,43 @@ declare class BucketService extends FolderScopedService implements BucketService
|
|
|
7702
8084
|
*
|
|
7703
8085
|
* const buckets = new Buckets(sdk);
|
|
7704
8086
|
*
|
|
7705
|
-
* //
|
|
8087
|
+
* // By folder ID
|
|
7706
8088
|
* const file = new File(['file content'], 'example.txt');
|
|
7707
|
-
*
|
|
7708
|
-
*
|
|
7709
|
-
*
|
|
7710
|
-
*
|
|
7711
|
-
*
|
|
7712
|
-
*
|
|
8089
|
+
* await buckets.uploadFile(<bucketId>, '/folder/example.txt', file, { folderId: <folderId> });
|
|
8090
|
+
*
|
|
8091
|
+
* // By folder key (GUID)
|
|
8092
|
+
* await buckets.uploadFile(<bucketId>, '/folder/example.txt', file, { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
|
|
8093
|
+
*
|
|
8094
|
+
* // By folder path
|
|
8095
|
+
* await buckets.uploadFile(<bucketId>, '/folder/example.txt', file, { folderPath: 'Shared/Finance' });
|
|
7713
8096
|
*
|
|
7714
8097
|
* // In Node env with Buffer
|
|
7715
8098
|
* const buffer = Buffer.from('file content');
|
|
7716
|
-
*
|
|
7717
|
-
* bucketId: 123,
|
|
7718
|
-
* folderId: 456,
|
|
7719
|
-
* path: '/folder/example.txt',
|
|
7720
|
-
* content: buffer
|
|
7721
|
-
* });
|
|
8099
|
+
* await buckets.uploadFile(<bucketId>, '/folder/example.txt', buffer, { folderId: <folderId> });
|
|
7722
8100
|
* ```
|
|
7723
8101
|
*/
|
|
8102
|
+
uploadFile(bucketId: number, path: string, content: Blob | Uint8Array<ArrayBuffer> | File, options?: BucketUploadFileRequestOptions): Promise<BucketUploadResponse>;
|
|
8103
|
+
/**
|
|
8104
|
+
* Uploads a file to a bucket — options-only form.
|
|
8105
|
+
*
|
|
8106
|
+
* @deprecated Use the positional form: `uploadFile(bucketId, path, content, options?)`. See {@link BucketUploadFileRequestOptions} for the supported options.
|
|
8107
|
+
*
|
|
8108
|
+
* @param options - Options for file upload including bucket ID, folder scoping (`folderId` / `folderKey` / `folderPath`), path, and content
|
|
8109
|
+
* @returns Promise resolving to a response with success status and HTTP status code
|
|
8110
|
+
* {@link BucketUploadResponse}
|
|
8111
|
+
*/
|
|
7724
8112
|
uploadFile(options: BucketUploadFileOptions): Promise<BucketUploadResponse>;
|
|
7725
8113
|
/**
|
|
7726
|
-
* Gets a direct download URL for a file in the bucket
|
|
8114
|
+
* Gets a direct download URL for a file in the bucket.
|
|
8115
|
+
*
|
|
8116
|
+
* Folder context can be supplied as `folderId`, `folderKey`, or `folderPath`
|
|
8117
|
+
* inside the options.
|
|
7727
8118
|
*
|
|
7728
|
-
* @param
|
|
8119
|
+
* @param bucketId - The ID of the bucket
|
|
8120
|
+
* @param path - The full path to the file
|
|
8121
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional `expiryInMinutes`
|
|
7729
8122
|
* @returns Promise resolving to blob file access information
|
|
8123
|
+
* {@link BucketGetUriResponse}
|
|
7730
8124
|
*
|
|
7731
8125
|
* @example
|
|
7732
8126
|
* ```typescript
|
|
@@ -7734,14 +8128,26 @@ declare class BucketService extends FolderScopedService implements BucketService
|
|
|
7734
8128
|
*
|
|
7735
8129
|
* const buckets = new Buckets(sdk);
|
|
7736
8130
|
*
|
|
7737
|
-
* //
|
|
7738
|
-
*
|
|
7739
|
-
*
|
|
7740
|
-
*
|
|
7741
|
-
*
|
|
7742
|
-
*
|
|
8131
|
+
* // By folder ID
|
|
8132
|
+
* await buckets.getReadUri(<bucketId>, '/folder/file.pdf', { folderId: <folderId> });
|
|
8133
|
+
*
|
|
8134
|
+
* // By folder key (GUID)
|
|
8135
|
+
* await buckets.getReadUri(<bucketId>, '/folder/file.pdf', { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
|
|
8136
|
+
*
|
|
8137
|
+
* // By folder path
|
|
8138
|
+
* await buckets.getReadUri(<bucketId>, '/folder/file.pdf', { folderPath: 'Shared/Finance' });
|
|
7743
8139
|
* ```
|
|
7744
8140
|
*/
|
|
8141
|
+
getReadUri(bucketId: number, path: string, options?: BucketGetReadUriRequestOptions): Promise<BucketGetUriResponse>;
|
|
8142
|
+
/**
|
|
8143
|
+
* Gets a direct download URL for a file in the bucket — options-only form.
|
|
8144
|
+
*
|
|
8145
|
+
* @deprecated Use the positional form: `getReadUri(bucketId, path, options?)`. See {@link BucketGetReadUriRequestOptions} for the supported options.
|
|
8146
|
+
*
|
|
8147
|
+
* @param options - Contains bucketId, folder scoping (`folderId` / `folderKey` / `folderPath`), file path and optional expiry time
|
|
8148
|
+
* @returns Promise resolving to blob file access information
|
|
8149
|
+
* {@link BucketGetUriResponse}
|
|
8150
|
+
*/
|
|
7745
8151
|
getReadUri(options: BucketGetReadUriOptions): Promise<BucketGetUriResponse>;
|
|
7746
8152
|
/**
|
|
7747
8153
|
* Uploads content to the provided URI
|
|
@@ -7754,8 +8160,8 @@ declare class BucketService extends FolderScopedService implements BucketService
|
|
|
7754
8160
|
* Private method to handle common URI request logic
|
|
7755
8161
|
* @param endpoint - The API endpoint to call
|
|
7756
8162
|
* @param bucketId - The bucket ID
|
|
7757
|
-
* @param folderId - The folder ID
|
|
7758
8163
|
* @param path - The file path
|
|
8164
|
+
* @param headers - Pre-built folder-context headers (built via `resolveFolderHeaders`)
|
|
7759
8165
|
* @param queryOptions - Additional query parameters
|
|
7760
8166
|
* @returns Promise resolving to blob file access information
|
|
7761
8167
|
*/
|
|
@@ -7829,7 +8235,7 @@ declare class BucketService extends FolderScopedService implements BucketService
|
|
|
7829
8235
|
/**
|
|
7830
8236
|
* Gets a direct upload URL for a file in the bucket
|
|
7831
8237
|
*
|
|
7832
|
-
* @param options - Contains bucketId,
|
|
8238
|
+
* @param options - Contains bucketId, file path, optional expiry time, and pre-built folder-context headers
|
|
7833
8239
|
* @returns Promise resolving to blob file access information
|
|
7834
8240
|
*/
|
|
7835
8241
|
private _getWriteUri;
|
|
@@ -9339,6 +9745,26 @@ declare class TaskService extends BaseService implements TaskServiceModel {
|
|
|
9339
9745
|
* }
|
|
9340
9746
|
* ]);
|
|
9341
9747
|
* ```
|
|
9748
|
+
*
|
|
9749
|
+
* @example Group assignment
|
|
9750
|
+
* ```typescript
|
|
9751
|
+
* import { TaskAssignmentCriteria } from '@uipath/uipath-typescript/tasks';
|
|
9752
|
+
*
|
|
9753
|
+
* // Assign to a directory group by userId + criteria — Action Center
|
|
9754
|
+
* // distributes the task across the group's members based on the criteria
|
|
9755
|
+
* const result = await tasks.assign({
|
|
9756
|
+
* taskId: 123,
|
|
9757
|
+
* userId: 456, // a DirectoryGroup id from tasks.getUsers()
|
|
9758
|
+
* assignmentCriteria: TaskAssignmentCriteria.AllUsers
|
|
9759
|
+
* });
|
|
9760
|
+
*
|
|
9761
|
+
* // ...or identify the group by name instead of id
|
|
9762
|
+
* const result2 = await tasks.assign({
|
|
9763
|
+
* taskId: 123,
|
|
9764
|
+
* userNameOrEmail: "My Group",
|
|
9765
|
+
* assignmentCriteria: TaskAssignmentCriteria.AllUsers
|
|
9766
|
+
* });
|
|
9767
|
+
* ```
|
|
9342
9768
|
*/
|
|
9343
9769
|
assign(taskAssignments: TaskAssignmentOptions | TaskAssignmentOptions[]): Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>;
|
|
9344
9770
|
/**
|
|
@@ -9377,6 +9803,25 @@ declare class TaskService extends BaseService implements TaskServiceModel {
|
|
|
9377
9803
|
* }
|
|
9378
9804
|
* ]);
|
|
9379
9805
|
* ```
|
|
9806
|
+
*
|
|
9807
|
+
* @example Group reassignment
|
|
9808
|
+
* ```typescript
|
|
9809
|
+
* import { TaskAssignmentCriteria } from '@uipath/uipath-typescript/tasks';
|
|
9810
|
+
*
|
|
9811
|
+
* // Reassign to a directory group by userId + criteria
|
|
9812
|
+
* const result = await tasks.reassign({
|
|
9813
|
+
* taskId: 123,
|
|
9814
|
+
* userId: 456, // a DirectoryGroup id from tasks.getUsers()
|
|
9815
|
+
* assignmentCriteria: TaskAssignmentCriteria.AllUsers
|
|
9816
|
+
* });
|
|
9817
|
+
*
|
|
9818
|
+
* // ...or identify the group by name instead of id
|
|
9819
|
+
* const result2 = await tasks.reassign({
|
|
9820
|
+
* taskId: 123,
|
|
9821
|
+
* userNameOrEmail: "My Group",
|
|
9822
|
+
* assignmentCriteria: TaskAssignmentCriteria.AllUsers
|
|
9823
|
+
* });
|
|
9824
|
+
* ```
|
|
9380
9825
|
*/
|
|
9381
9826
|
reassign(taskAssignments: TaskAssignmentOptions | TaskAssignmentOptions[]): Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>;
|
|
9382
9827
|
/**
|
|
@@ -9569,145 +10014,633 @@ type MetaTagConfig = PartialUiPathConfig & {
|
|
|
9569
10014
|
*/
|
|
9570
10015
|
declare function loadFromMetaTags(): MetaTagConfig | null;
|
|
9571
10016
|
|
|
9572
|
-
|
|
9573
|
-
|
|
9574
|
-
|
|
9575
|
-
|
|
9576
|
-
|
|
9577
|
-
|
|
9578
|
-
|
|
9579
|
-
*/
|
|
9580
|
-
declare const ConversationMap: {
|
|
9581
|
-
[key: string]: string;
|
|
9582
|
-
};
|
|
9583
|
-
/**
|
|
9584
|
-
* Maps API filter param names (left) to SDK-facing names (right) for the conversation list endpoint.
|
|
9585
|
-
* Used by `getAll` to translate SDK filters to the field names the backend expects. Kept separate
|
|
9586
|
-
* from `ConversationMap` because `label`/`search` would otherwise collide with the `label` field
|
|
9587
|
-
* on create/update payloads.
|
|
9588
|
-
*/
|
|
9589
|
-
declare const ConversationGetAllFilterMap: {
|
|
9590
|
-
[key: string]: string;
|
|
9591
|
-
};
|
|
9592
|
-
/**
|
|
9593
|
-
* Maps fields for Exchange entity to ensure consistent SDK naming
|
|
9594
|
-
*/
|
|
9595
|
-
declare const ExchangeMap: {
|
|
9596
|
-
[key: string]: string;
|
|
9597
|
-
};
|
|
9598
|
-
/**
|
|
9599
|
-
* Maps fields for Message entity to ensure consistent SDK naming
|
|
9600
|
-
*/
|
|
9601
|
-
declare const MessageMap: {
|
|
9602
|
-
[key: string]: string;
|
|
9603
|
-
};
|
|
9604
|
-
|
|
9605
|
-
/**
|
|
9606
|
-
* Common types for Conversational Agent
|
|
9607
|
-
* Contains IDs, primitives, and utility types used across conversation types.
|
|
9608
|
-
*/
|
|
9609
|
-
/**
|
|
9610
|
-
* Identifies the origin of a message in the conversation.
|
|
9611
|
-
*/
|
|
9612
|
-
declare enum MessageRole {
|
|
9613
|
-
System = "system",
|
|
9614
|
-
User = "user",
|
|
9615
|
-
Assistant = "assistant"
|
|
9616
|
-
}
|
|
9617
|
-
/**
|
|
9618
|
-
* Identifies the type of an interrupt.
|
|
9619
|
-
*/
|
|
9620
|
-
declare enum InterruptType {
|
|
9621
|
-
ToolCallConfirmation = "uipath_cas_tool_call_confirmation"
|
|
10017
|
+
declare enum ComparisonOperator {
|
|
10018
|
+
Equals = "Equals",
|
|
10019
|
+
NotEquals = "NotEquals",
|
|
10020
|
+
Greater = "Greater",
|
|
10021
|
+
Less = "Less",
|
|
10022
|
+
GreaterOrEqual = "GreaterOrEqual",
|
|
10023
|
+
LessOrEqual = "LessOrEqual"
|
|
9622
10024
|
}
|
|
9623
|
-
|
|
9624
|
-
|
|
9625
|
-
|
|
9626
|
-
interface CitationSourceBase {
|
|
9627
|
-
/**
|
|
9628
|
-
* Title for the citation source, suitable for display to users.
|
|
9629
|
-
*/
|
|
9630
|
-
title: string;
|
|
9631
|
-
/**
|
|
9632
|
-
* Label number for the citation source, suitable for display to users
|
|
9633
|
-
* (e.g. [1] for the first unique source, [2] for the second, etc.).
|
|
9634
|
-
*/
|
|
9635
|
-
number: number;
|
|
10025
|
+
declare enum Criticality {
|
|
10026
|
+
Must = "Must",
|
|
10027
|
+
Should = "Should"
|
|
9636
10028
|
}
|
|
9637
|
-
|
|
9638
|
-
|
|
9639
|
-
|
|
9640
|
-
|
|
9641
|
-
|
|
9642
|
-
|
|
9643
|
-
|
|
9644
|
-
|
|
10029
|
+
declare enum FieldType {
|
|
10030
|
+
Text = "Text",
|
|
10031
|
+
Number = "Number",
|
|
10032
|
+
Date = "Date",
|
|
10033
|
+
Name = "Name",
|
|
10034
|
+
Address = "Address",
|
|
10035
|
+
Keyword = "Keyword",
|
|
10036
|
+
Set = "Set",
|
|
10037
|
+
Boolean = "Boolean",
|
|
10038
|
+
Table = "Table",
|
|
10039
|
+
Internal = "Internal",
|
|
10040
|
+
FieldGroup = "FieldGroup",
|
|
10041
|
+
MonetaryQuantity = "MonetaryQuantity"
|
|
9645
10042
|
}
|
|
9646
|
-
|
|
9647
|
-
|
|
9648
|
-
|
|
9649
|
-
interface CitationSourceMedia extends CitationSourceBase {
|
|
9650
|
-
/** The mime type of the media. If non-specified, should be discovered through the downloadUrl. */
|
|
9651
|
-
mimeType?: string;
|
|
9652
|
-
/** Download URL for the media */
|
|
9653
|
-
downloadUrl?: string;
|
|
9654
|
-
/** The page number for the media, if applicable (e.g. for application/pdf documents) */
|
|
9655
|
-
pageNumber?: string;
|
|
10043
|
+
declare enum LogicalOperator {
|
|
10044
|
+
AND = "AND",
|
|
10045
|
+
OR = "OR"
|
|
9656
10046
|
}
|
|
9657
|
-
|
|
9658
|
-
|
|
9659
|
-
|
|
9660
|
-
|
|
9661
|
-
|
|
9662
|
-
|
|
9663
|
-
|
|
9664
|
-
|
|
9665
|
-
|
|
9666
|
-
|
|
9667
|
-
|
|
9668
|
-
|
|
9669
|
-
|
|
9670
|
-
|
|
9671
|
-
* JSON compatible object type.
|
|
9672
|
-
*/
|
|
9673
|
-
type JSONObject = Record<string, JSONValue>;
|
|
9674
|
-
/**
|
|
9675
|
-
* JSON compatible array type.
|
|
9676
|
-
*/
|
|
9677
|
-
type JSONArray = JSONValue[];
|
|
9678
|
-
/**
|
|
9679
|
-
* An arbitrary JSON serializable object.
|
|
9680
|
-
*/
|
|
9681
|
-
type MetaData = JSONObject;
|
|
9682
|
-
/**
|
|
9683
|
-
* Produces the provided object type with specified properties changed to optional.
|
|
9684
|
-
*/
|
|
9685
|
-
type MakeOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
9686
|
-
/**
|
|
9687
|
-
* Produces the provided object type with specified properties changed to required.
|
|
9688
|
-
*/
|
|
9689
|
-
type MakeRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
|
|
9690
|
-
/**
|
|
9691
|
-
* Causes typescript to simplify the display of object types created using MakeOptional, MakeRequired, and other utility
|
|
9692
|
-
* types. This doesn't change the effective type, but makes popups in the ide and compile error messages cleaner.
|
|
9693
|
-
*/
|
|
9694
|
-
type Simplify<T> = T extends any[] | Date ? T : {
|
|
9695
|
-
[K in keyof T]: T[K];
|
|
9696
|
-
} & {};
|
|
9697
|
-
/**
|
|
9698
|
-
* Inline value - used when a value is small enough to be returned inline with an API result.
|
|
9699
|
-
*/
|
|
9700
|
-
interface InlineValue<T> {
|
|
9701
|
-
inline: T;
|
|
10047
|
+
declare enum RuleType {
|
|
10048
|
+
Mandatory = "Mandatory",
|
|
10049
|
+
PossibleValues = "PossibleValues",
|
|
10050
|
+
Regex = "Regex",
|
|
10051
|
+
StartsWith = "StartsWith",
|
|
10052
|
+
EndsWith = "EndsWith",
|
|
10053
|
+
FixedLength = "FixedLength",
|
|
10054
|
+
IsNumeric = "IsNumeric",
|
|
10055
|
+
IsDate = "IsDate",
|
|
10056
|
+
IsEmail = "IsEmail",
|
|
10057
|
+
Contains = "Contains",
|
|
10058
|
+
Expression = "Expression",
|
|
10059
|
+
TableExpression = "TableExpression",
|
|
10060
|
+
IsEmpty = "IsEmpty"
|
|
9702
10061
|
}
|
|
9703
|
-
|
|
9704
|
-
|
|
9705
|
-
|
|
9706
|
-
interface ExternalValue {
|
|
9707
|
-
uri: string;
|
|
9708
|
-
byteCount?: number;
|
|
10062
|
+
interface DataSource {
|
|
10063
|
+
ResourceId?: string | null;
|
|
10064
|
+
ElementFieldId?: string | null;
|
|
9709
10065
|
}
|
|
9710
|
-
|
|
10066
|
+
interface DocumentGroup {
|
|
10067
|
+
Name?: string | null;
|
|
10068
|
+
Categories?: string[] | null;
|
|
10069
|
+
}
|
|
10070
|
+
interface DocumentTaxonomy {
|
|
10071
|
+
DataContractVersion?: string | null;
|
|
10072
|
+
DocumentTypes?: DocumentTypeEntity[] | null;
|
|
10073
|
+
Groups?: DocumentGroup[] | null;
|
|
10074
|
+
SupportedLanguages?: LanguageInfo[] | null;
|
|
10075
|
+
ReportAsExceptionSettings?: ReportAsExceptionSettings;
|
|
10076
|
+
}
|
|
10077
|
+
interface DocumentTypeEntity {
|
|
10078
|
+
DocumentTypeId?: string | null;
|
|
10079
|
+
Group?: string | null;
|
|
10080
|
+
Category?: string | null;
|
|
10081
|
+
Name?: string | null;
|
|
10082
|
+
OptionalUniqueIdentifier?: string | null;
|
|
10083
|
+
TypeField?: TypeField;
|
|
10084
|
+
Fields?: Field[] | null;
|
|
10085
|
+
Metadata?: MetadataEntry[] | null;
|
|
10086
|
+
}
|
|
10087
|
+
interface ExceptionReasonOption {
|
|
10088
|
+
ExceptionReason?: string | null;
|
|
10089
|
+
}
|
|
10090
|
+
interface Field {
|
|
10091
|
+
FieldId?: string | null;
|
|
10092
|
+
FieldName?: string | null;
|
|
10093
|
+
IsMultiValue?: boolean;
|
|
10094
|
+
Type?: FieldType;
|
|
10095
|
+
DeriveFieldsFormat?: string | null;
|
|
10096
|
+
Components?: Field[] | null;
|
|
10097
|
+
SetValues?: string[] | null;
|
|
10098
|
+
Metadata?: MetadataEntry[] | null;
|
|
10099
|
+
RuleSet?: RuleSet;
|
|
10100
|
+
DefaultValue?: string | null;
|
|
10101
|
+
DataSource?: DataSource;
|
|
10102
|
+
}
|
|
10103
|
+
interface LanguageInfo {
|
|
10104
|
+
Name?: string | null;
|
|
10105
|
+
Code?: string | null;
|
|
10106
|
+
}
|
|
10107
|
+
interface MetadataEntry {
|
|
10108
|
+
Key?: string | null;
|
|
10109
|
+
Value?: string | null;
|
|
10110
|
+
}
|
|
10111
|
+
interface ReportAsExceptionSettings {
|
|
10112
|
+
ExceptionReasonOptions?: ExceptionReasonOption[] | null;
|
|
10113
|
+
}
|
|
10114
|
+
interface Rule {
|
|
10115
|
+
Name?: string | null;
|
|
10116
|
+
Type?: RuleType;
|
|
10117
|
+
LogicalOperator?: LogicalOperator;
|
|
10118
|
+
ComparisonOperator?: ComparisonOperator;
|
|
10119
|
+
Expression?: string | null;
|
|
10120
|
+
SetValues?: string[] | null;
|
|
10121
|
+
}
|
|
10122
|
+
interface RuleSet {
|
|
10123
|
+
Criticality?: Criticality;
|
|
10124
|
+
Rules?: Rule[] | null;
|
|
10125
|
+
}
|
|
10126
|
+
interface TypeField {
|
|
10127
|
+
FieldId?: string | null;
|
|
10128
|
+
FieldName?: string | null;
|
|
10129
|
+
}
|
|
10130
|
+
|
|
10131
|
+
interface FieldValue {
|
|
10132
|
+
Value?: string | null;
|
|
10133
|
+
DerivedValue?: string | null;
|
|
10134
|
+
}
|
|
10135
|
+
interface FieldValueResult {
|
|
10136
|
+
Value?: FieldValue;
|
|
10137
|
+
IsValid?: boolean;
|
|
10138
|
+
Rules?: RuleResult[] | null;
|
|
10139
|
+
}
|
|
10140
|
+
interface RuleResult {
|
|
10141
|
+
Rule?: Rule;
|
|
10142
|
+
IsValid?: boolean;
|
|
10143
|
+
}
|
|
10144
|
+
interface RuleSetResult {
|
|
10145
|
+
FieldId?: string | null;
|
|
10146
|
+
FieldType?: FieldType;
|
|
10147
|
+
Criticality?: Criticality;
|
|
10148
|
+
IsValid?: boolean;
|
|
10149
|
+
Results?: FieldValueResult[] | null;
|
|
10150
|
+
BrokenRules?: Rule[] | null;
|
|
10151
|
+
RowIndex?: number | null;
|
|
10152
|
+
TableFieldId?: string | null;
|
|
10153
|
+
}
|
|
10154
|
+
|
|
10155
|
+
declare enum MarkupType {
|
|
10156
|
+
Unknown = "Unknown",
|
|
10157
|
+
Circled = "Circled",
|
|
10158
|
+
Underlined = "Underlined",
|
|
10159
|
+
Strikethrough = "Strikethrough"
|
|
10160
|
+
}
|
|
10161
|
+
declare enum ProcessingSource {
|
|
10162
|
+
Unknown = "Unknown",
|
|
10163
|
+
Ocr = "Ocr",
|
|
10164
|
+
Pdf = "Pdf",
|
|
10165
|
+
PlainText = "PlainText",
|
|
10166
|
+
PdfAndOcr = "PdfAndOcr"
|
|
10167
|
+
}
|
|
10168
|
+
declare enum Rotation {
|
|
10169
|
+
None = "None",
|
|
10170
|
+
Rotated90 = "Rotated90",
|
|
10171
|
+
Rotated180 = "Rotated180",
|
|
10172
|
+
Rotated270 = "Rotated270",
|
|
10173
|
+
Other = "Other"
|
|
10174
|
+
}
|
|
10175
|
+
declare enum SectionType {
|
|
10176
|
+
Vertical = "Vertical",
|
|
10177
|
+
Paragraph = "Paragraph",
|
|
10178
|
+
Header = "Header",
|
|
10179
|
+
Footer = "Footer",
|
|
10180
|
+
Table = "Table"
|
|
10181
|
+
}
|
|
10182
|
+
declare enum TextType {
|
|
10183
|
+
Unknown = "Unknown",
|
|
10184
|
+
Text = "Text",
|
|
10185
|
+
Checkbox = "Checkbox",
|
|
10186
|
+
Handwriting = "Handwriting",
|
|
10187
|
+
Barcode = "Barcode",
|
|
10188
|
+
QRcode = "QRcode",
|
|
10189
|
+
Stamp = "Stamp",
|
|
10190
|
+
Logo = "Logo",
|
|
10191
|
+
Circle = "Circle",
|
|
10192
|
+
Underline = "Underline",
|
|
10193
|
+
Cut = "Cut"
|
|
10194
|
+
}
|
|
10195
|
+
declare enum WordGroupType {
|
|
10196
|
+
Sentence = "Sentence",
|
|
10197
|
+
TableCell = "TableCell",
|
|
10198
|
+
TableRowEnd = "TableRowEnd",
|
|
10199
|
+
Heading = "Heading",
|
|
10200
|
+
Other = "Other"
|
|
10201
|
+
}
|
|
10202
|
+
interface DocumentEntity {
|
|
10203
|
+
DocumentId?: string | null;
|
|
10204
|
+
ContentType?: string | null;
|
|
10205
|
+
Length?: number;
|
|
10206
|
+
Pages?: Page[] | null;
|
|
10207
|
+
DocumentMetadata?: Metadata[] | null;
|
|
10208
|
+
}
|
|
10209
|
+
interface Metadata {
|
|
10210
|
+
Key?: string | null;
|
|
10211
|
+
Value?: string | null;
|
|
10212
|
+
}
|
|
10213
|
+
interface Page {
|
|
10214
|
+
PageIndex?: number;
|
|
10215
|
+
Size?: number[];
|
|
10216
|
+
Sections?: PageSection[] | null;
|
|
10217
|
+
PageMarkups?: PageMarkup[] | null;
|
|
10218
|
+
ProcessingSource?: ProcessingSource;
|
|
10219
|
+
IndexInText?: number;
|
|
10220
|
+
TextLength?: number;
|
|
10221
|
+
SkewAngle?: number;
|
|
10222
|
+
Rotation?: Rotation;
|
|
10223
|
+
PageMetadata?: Metadata[] | null;
|
|
10224
|
+
}
|
|
10225
|
+
interface PageMarkup {
|
|
10226
|
+
Box?: number[];
|
|
10227
|
+
Polygon?: number[] | null;
|
|
10228
|
+
OcrConfidence?: number;
|
|
10229
|
+
Text?: string | null;
|
|
10230
|
+
MarkupType?: MarkupType;
|
|
10231
|
+
}
|
|
10232
|
+
interface PageSection {
|
|
10233
|
+
IndexInText?: number;
|
|
10234
|
+
Language?: string | null;
|
|
10235
|
+
Length?: number;
|
|
10236
|
+
Rotation?: Rotation;
|
|
10237
|
+
SkewAngle?: number;
|
|
10238
|
+
Type?: SectionType;
|
|
10239
|
+
WordGroups?: WordGroup[] | null;
|
|
10240
|
+
}
|
|
10241
|
+
interface Word {
|
|
10242
|
+
Box?: number[];
|
|
10243
|
+
Polygon?: number[] | null;
|
|
10244
|
+
IndexInText?: number;
|
|
10245
|
+
OcrConfidence?: number;
|
|
10246
|
+
Text?: string | null;
|
|
10247
|
+
VisualLineNumber?: number;
|
|
10248
|
+
TextType?: TextType;
|
|
10249
|
+
MarkupType?: MarkupType[] | null;
|
|
10250
|
+
}
|
|
10251
|
+
interface WordGroup {
|
|
10252
|
+
IndexInText?: number;
|
|
10253
|
+
Length?: number;
|
|
10254
|
+
Type?: WordGroupType;
|
|
10255
|
+
Words?: Word[] | null;
|
|
10256
|
+
}
|
|
10257
|
+
|
|
10258
|
+
declare enum ResultsDataSource {
|
|
10259
|
+
Automatic = "Automatic",
|
|
10260
|
+
Manual = "Manual",
|
|
10261
|
+
ManuallyChanged = "ManuallyChanged",
|
|
10262
|
+
Defaulted = "Defaulted",
|
|
10263
|
+
External = "External"
|
|
10264
|
+
}
|
|
10265
|
+
interface ClassificationResult {
|
|
10266
|
+
DocumentTypeId?: string | null;
|
|
10267
|
+
DocumentId?: string | null;
|
|
10268
|
+
Confidence?: number;
|
|
10269
|
+
OcrConfidence?: number;
|
|
10270
|
+
Reference?: ResultsContentReference;
|
|
10271
|
+
DocumentBounds?: ResultsDocumentBounds;
|
|
10272
|
+
ClassifierName?: string | null;
|
|
10273
|
+
}
|
|
10274
|
+
interface ExtractionResult {
|
|
10275
|
+
DocumentId?: string | null;
|
|
10276
|
+
ResultsVersion?: number;
|
|
10277
|
+
ResultsDocument?: ResultsDocument;
|
|
10278
|
+
ExtractorPayloads?: ExtractorPayload[] | null;
|
|
10279
|
+
BusinessRulesResults?: RuleSetResult[] | null;
|
|
10280
|
+
}
|
|
10281
|
+
interface ExtractorPayload {
|
|
10282
|
+
Id?: string | null;
|
|
10283
|
+
Payload?: string | null;
|
|
10284
|
+
SavedPayloadId?: string | null;
|
|
10285
|
+
TaxonomySchemaMapping?: string | null;
|
|
10286
|
+
}
|
|
10287
|
+
interface ResultsContentReference {
|
|
10288
|
+
TextStartIndex?: number;
|
|
10289
|
+
TextLength?: number;
|
|
10290
|
+
Tokens?: ResultsValueTokens[] | null;
|
|
10291
|
+
}
|
|
10292
|
+
interface ResultsDataPoint {
|
|
10293
|
+
FieldId?: string | null;
|
|
10294
|
+
FieldName?: string | null;
|
|
10295
|
+
FieldType?: FieldType;
|
|
10296
|
+
IsMissing?: boolean;
|
|
10297
|
+
DataSource?: ResultsDataSource;
|
|
10298
|
+
Values?: ResultsValue[] | null;
|
|
10299
|
+
DataVersion?: number;
|
|
10300
|
+
OperatorConfirmed?: boolean;
|
|
10301
|
+
ValidatorNotes?: string | null;
|
|
10302
|
+
ValidatorNotesInfo?: string | null;
|
|
10303
|
+
}
|
|
10304
|
+
interface ResultsDerivedField {
|
|
10305
|
+
FieldId?: string | null;
|
|
10306
|
+
Value?: string | null;
|
|
10307
|
+
}
|
|
10308
|
+
interface ResultsDocument {
|
|
10309
|
+
Bounds?: ResultsDocumentBounds;
|
|
10310
|
+
Language?: string | null;
|
|
10311
|
+
DocumentGroup?: string | null;
|
|
10312
|
+
DocumentCategory?: string | null;
|
|
10313
|
+
DocumentTypeId?: string | null;
|
|
10314
|
+
DocumentTypeName?: string | null;
|
|
10315
|
+
DocumentTypeDataVersion?: number;
|
|
10316
|
+
DataVersion?: number;
|
|
10317
|
+
DocumentTypeSource?: ResultsDataSource;
|
|
10318
|
+
DocumentTypeField?: ResultsValue;
|
|
10319
|
+
Fields?: ResultsDataPoint[] | null;
|
|
10320
|
+
Tables?: ResultsTable[] | null;
|
|
10321
|
+
}
|
|
10322
|
+
interface ResultsDocumentBounds {
|
|
10323
|
+
PageCount?: number;
|
|
10324
|
+
PageRange?: string | null;
|
|
10325
|
+
}
|
|
10326
|
+
interface ResultsTable {
|
|
10327
|
+
FieldId?: string | null;
|
|
10328
|
+
FieldName?: string | null;
|
|
10329
|
+
IsMissing?: boolean;
|
|
10330
|
+
DataSource?: ResultsDataSource;
|
|
10331
|
+
DataVersion?: number;
|
|
10332
|
+
OperatorConfirmed?: boolean;
|
|
10333
|
+
Values?: ResultsTableValue[] | null;
|
|
10334
|
+
ValidatorNotes?: string | null;
|
|
10335
|
+
ValidatorNotesInfo?: string | null;
|
|
10336
|
+
}
|
|
10337
|
+
interface ResultsTableCell {
|
|
10338
|
+
RowIndex?: number;
|
|
10339
|
+
ColumnIndex?: number;
|
|
10340
|
+
IsHeader?: boolean;
|
|
10341
|
+
IsMissing?: boolean;
|
|
10342
|
+
OperatorConfirmed?: boolean;
|
|
10343
|
+
DataSource?: ResultsDataSource;
|
|
10344
|
+
DataVersion?: number;
|
|
10345
|
+
Values?: ResultsValue[] | null;
|
|
10346
|
+
}
|
|
10347
|
+
interface ResultsTableColumnInfo {
|
|
10348
|
+
FieldId?: string | null;
|
|
10349
|
+
FieldName?: string | null;
|
|
10350
|
+
FieldType?: FieldType;
|
|
10351
|
+
}
|
|
10352
|
+
interface ResultsTableValue {
|
|
10353
|
+
OperatorConfirmed?: boolean;
|
|
10354
|
+
Confidence?: number;
|
|
10355
|
+
OcrConfidence?: number;
|
|
10356
|
+
Cells?: ResultsTableCell[] | null;
|
|
10357
|
+
ColumnInfo?: ResultsTableColumnInfo[] | null;
|
|
10358
|
+
NumberOfRows?: number;
|
|
10359
|
+
ValidatorNotes?: string | null;
|
|
10360
|
+
ValidatorNotesInfo?: string | null;
|
|
10361
|
+
}
|
|
10362
|
+
interface ResultsValue {
|
|
10363
|
+
Components?: ResultsDataPoint[] | null;
|
|
10364
|
+
Value?: string | null;
|
|
10365
|
+
UnformattedValue?: string | null;
|
|
10366
|
+
Reference?: ResultsContentReference;
|
|
10367
|
+
DerivedFields?: ResultsDerivedField[] | null;
|
|
10368
|
+
Confidence?: number;
|
|
10369
|
+
OperatorConfirmed?: boolean;
|
|
10370
|
+
OcrConfidence?: number;
|
|
10371
|
+
TextType?: TextType;
|
|
10372
|
+
ValidatorNotes?: string | null;
|
|
10373
|
+
ValidatorNotesInfo?: string | null;
|
|
10374
|
+
}
|
|
10375
|
+
interface ResultsValueTokens {
|
|
10376
|
+
TextStartIndex?: number;
|
|
10377
|
+
TextLength?: number;
|
|
10378
|
+
Page?: number;
|
|
10379
|
+
PageWidth?: number;
|
|
10380
|
+
PageHeight?: number;
|
|
10381
|
+
Boxes?: number[][] | null;
|
|
10382
|
+
}
|
|
10383
|
+
|
|
10384
|
+
/**
|
|
10385
|
+
* Echoed payload returned alongside an exception-report submission.
|
|
10386
|
+
*/
|
|
10387
|
+
interface ExceptionReportSubmitResult {
|
|
10388
|
+
/** Document identifier the exception was reported against. */
|
|
10389
|
+
DocumentId: string | null;
|
|
10390
|
+
/** Reason captured for the exception. */
|
|
10391
|
+
Reason: string | null;
|
|
10392
|
+
}
|
|
10393
|
+
/**
|
|
10394
|
+
* Response returned by `submitExceptionReport()`.
|
|
10395
|
+
*/
|
|
10396
|
+
interface SubmitExceptionReportResponse {
|
|
10397
|
+
/** Echo of the submitted exception report. */
|
|
10398
|
+
SubmitResult?: ExceptionReportSubmitResult;
|
|
10399
|
+
/** Whether the submission was accepted by the server. */
|
|
10400
|
+
IsSuccessful: boolean;
|
|
10401
|
+
/** Server-supplied error message when {@link SubmitExceptionReportResponse.IsSuccessful} is `false`; empty string on success. */
|
|
10402
|
+
ErrorMessage: string | null;
|
|
10403
|
+
}
|
|
10404
|
+
/**
|
|
10405
|
+
* Options for `submitExceptionReport()`.
|
|
10406
|
+
*/
|
|
10407
|
+
interface SubmitExceptionReportOptions extends FolderScopedOptions {
|
|
10408
|
+
}
|
|
10409
|
+
/**
|
|
10410
|
+
* Request body for processing extracted document data against a taxonomy.
|
|
10411
|
+
*
|
|
10412
|
+
* Combines the automatic extraction output with any validator-supplied edits so the
|
|
10413
|
+
* server can compute the merged extraction result.
|
|
10414
|
+
*/
|
|
10415
|
+
interface ProcessExtractedDataRequest {
|
|
10416
|
+
/** Extraction result produced by the automatic extractor. */
|
|
10417
|
+
AutomaticExtractedResults: ExtractionResult;
|
|
10418
|
+
/** Extraction result after human validation/edits. */
|
|
10419
|
+
ValidatedExtractedResults: ExtractionResult;
|
|
10420
|
+
/** Document taxonomy describing the schema both results conform to. */
|
|
10421
|
+
Taxonomy: DocumentTaxonomy;
|
|
10422
|
+
}
|
|
10423
|
+
/**
|
|
10424
|
+
* Options for `processExtractedData()`.
|
|
10425
|
+
*/
|
|
10426
|
+
interface ProcessExtractedDataOptions extends FolderScopedOptions {
|
|
10427
|
+
}
|
|
10428
|
+
|
|
10429
|
+
/**
|
|
10430
|
+
* Service for the Orchestrator Document Understanding module.
|
|
10431
|
+
*
|
|
10432
|
+
* Exposes the validation-flow endpoints used by Document Understanding apps to
|
|
10433
|
+
* submit exception reports against a task and to process extracted data against
|
|
10434
|
+
* a taxonomy. [UiPath Document Understanding Guide](https://docs.uipath.com/document-understanding/automation-cloud/latest)
|
|
10435
|
+
*
|
|
10436
|
+
* ### Usage
|
|
10437
|
+
*
|
|
10438
|
+
* Prerequisites: Initialize the SDK first - see [Getting Started](/uipath-typescript/getting-started/#import-initialize)
|
|
10439
|
+
*
|
|
10440
|
+
* ```typescript
|
|
10441
|
+
* import { OrchestratorDuModule } from '@uipath/uipath-typescript/orchestrator-du-module';
|
|
10442
|
+
*
|
|
10443
|
+
* const orchestratorDuModule = new OrchestratorDuModule(sdk);
|
|
10444
|
+
* ```
|
|
10445
|
+
*/
|
|
10446
|
+
interface OrchestratorDuModuleServiceModel {
|
|
10447
|
+
/**
|
|
10448
|
+
* Submits an exception report for a Document Understanding validation task.
|
|
10449
|
+
*
|
|
10450
|
+
* Records that the document under validation cannot be processed normally and captures
|
|
10451
|
+
* a reason. The server echoes the submitted payload and signals acceptance via
|
|
10452
|
+
* {@link SubmitExceptionReportResponse.IsSuccessful}.
|
|
10453
|
+
*
|
|
10454
|
+
* @param taskId - Identifier of the validation task the exception applies to.
|
|
10455
|
+
* @param documentId - Identifier of the document the exception applies to.
|
|
10456
|
+
* @param reason - Free-text reason the document is being reported as an exception.
|
|
10457
|
+
* @returns Promise resolving to a {@link SubmitExceptionReportResponse} containing the echoed payload and success status.
|
|
10458
|
+
*
|
|
10459
|
+
* @example
|
|
10460
|
+
* ```typescript
|
|
10461
|
+
* import { Tasks, TaskType } from '@uipath/uipath-typescript/tasks';
|
|
10462
|
+
*
|
|
10463
|
+
* const tasks = new Tasks(sdk);
|
|
10464
|
+
*
|
|
10465
|
+
* // Fetch the Document Validation task to get its documentId
|
|
10466
|
+
* const dvTask = await tasks.getById(<taskId>, { taskType: TaskType.DocumentValidation }, <folderId>);
|
|
10467
|
+
* const documentId = dvTask.data?.documentId as string;
|
|
10468
|
+
*
|
|
10469
|
+
* // Submit an exception report for the validation task
|
|
10470
|
+
* const result = await orchestratorDuModule.submitExceptionReport(<taskId>, documentId, '<reason>');
|
|
10471
|
+
*
|
|
10472
|
+
* if (result.IsSuccessful) {
|
|
10473
|
+
* console.log('Exception recorded for', result.SubmitResult?.DocumentId);
|
|
10474
|
+
* }
|
|
10475
|
+
* ```
|
|
10476
|
+
* @internal
|
|
10477
|
+
*/
|
|
10478
|
+
submitExceptionReport(taskId: number, documentId: string, reason: string, options: SubmitExceptionReportOptions): Promise<SubmitExceptionReportResponse>;
|
|
10479
|
+
/**
|
|
10480
|
+
* Processes automatically extracted data against validator-edited data and a taxonomy.
|
|
10481
|
+
*
|
|
10482
|
+
* Sends the automatic extraction result, the validated extraction result, and the
|
|
10483
|
+
* document taxonomy to the server, which merges and normalizes the inputs and returns
|
|
10484
|
+
* the resulting {@link ExtractionResult}.
|
|
10485
|
+
*
|
|
10486
|
+
* @param request - Automatic and validated extraction results plus the document taxonomy.
|
|
10487
|
+
* @returns Promise resolving to the merged {@link ExtractionResult}.
|
|
10488
|
+
*
|
|
10489
|
+
* @example
|
|
10490
|
+
* ```typescript
|
|
10491
|
+
* // Merge automatic and validator-edited extraction results against a taxonomy
|
|
10492
|
+
* const result = await orchestratorDuModule.processExtractedData({
|
|
10493
|
+
* AutomaticExtractedResults: <automaticExtractionResult>,
|
|
10494
|
+
* ValidatedExtractedResults: <validatedData>,
|
|
10495
|
+
* Taxonomy: <taxonomy>,
|
|
10496
|
+
* });
|
|
10497
|
+
*
|
|
10498
|
+
* console.log(result.DocumentId, result.ResultsDocument?.DocumentTypeName);
|
|
10499
|
+
* ```
|
|
10500
|
+
* @internal
|
|
10501
|
+
*/
|
|
10502
|
+
processExtractedData(request: ProcessExtractedDataRequest, options: ProcessExtractedDataOptions): Promise<ExtractionResult>;
|
|
10503
|
+
}
|
|
10504
|
+
|
|
10505
|
+
/**
|
|
10506
|
+
* Constants for Conversational Agent
|
|
10507
|
+
*/
|
|
10508
|
+
/**
|
|
10509
|
+
* Maps API response fields to SDK field names (API → SDK)
|
|
10510
|
+
* Used when transforming API responses for SDK consumers.
|
|
10511
|
+
* For request transformation (SDK → API), use `transformRequest(data, ConversationMap)`.
|
|
10512
|
+
*/
|
|
10513
|
+
declare const ConversationMap: {
|
|
10514
|
+
[key: string]: string;
|
|
10515
|
+
};
|
|
10516
|
+
/**
|
|
10517
|
+
* Maps API filter param names (left) to SDK-facing names (right) for the conversation list endpoint.
|
|
10518
|
+
* Used by `getAll` to translate SDK filters to the field names the backend expects. Kept separate
|
|
10519
|
+
* from `ConversationMap` because `label`/`search` would otherwise collide with the `label` field
|
|
10520
|
+
* on create/update payloads.
|
|
10521
|
+
*/
|
|
10522
|
+
declare const ConversationGetAllFilterMap: {
|
|
10523
|
+
[key: string]: string;
|
|
10524
|
+
};
|
|
10525
|
+
/**
|
|
10526
|
+
* Maps fields for Exchange entity to ensure consistent SDK naming
|
|
10527
|
+
*/
|
|
10528
|
+
declare const ExchangeMap: {
|
|
10529
|
+
[key: string]: string;
|
|
10530
|
+
};
|
|
10531
|
+
/**
|
|
10532
|
+
* Maps fields for Message entity to ensure consistent SDK naming
|
|
10533
|
+
*/
|
|
10534
|
+
declare const MessageMap: {
|
|
10535
|
+
[key: string]: string;
|
|
10536
|
+
};
|
|
10537
|
+
|
|
10538
|
+
/**
|
|
10539
|
+
* Common types for Conversational Agent
|
|
10540
|
+
* Contains IDs, primitives, and utility types used across conversation types.
|
|
10541
|
+
*/
|
|
10542
|
+
/**
|
|
10543
|
+
* Identifies the origin of a message in the conversation.
|
|
10544
|
+
*/
|
|
10545
|
+
declare enum MessageRole {
|
|
10546
|
+
System = "system",
|
|
10547
|
+
User = "user",
|
|
10548
|
+
Assistant = "assistant"
|
|
10549
|
+
}
|
|
10550
|
+
/**
|
|
10551
|
+
* Identifies the type of an interrupt.
|
|
10552
|
+
*/
|
|
10553
|
+
declare enum InterruptType {
|
|
10554
|
+
ToolCallConfirmation = "uipath_cas_tool_call_confirmation"
|
|
10555
|
+
}
|
|
10556
|
+
/**
|
|
10557
|
+
* Base interface for citation sources.
|
|
10558
|
+
*/
|
|
10559
|
+
interface CitationSourceBase {
|
|
10560
|
+
/**
|
|
10561
|
+
* Title for the citation source, suitable for display to users.
|
|
10562
|
+
*/
|
|
10563
|
+
title: string;
|
|
10564
|
+
/**
|
|
10565
|
+
* Label number for the citation source, suitable for display to users
|
|
10566
|
+
* (e.g. [1] for the first unique source, [2] for the second, etc.).
|
|
10567
|
+
*/
|
|
10568
|
+
number: number;
|
|
10569
|
+
}
|
|
10570
|
+
/**
|
|
10571
|
+
* Used when the citation can be rendered as a link.
|
|
10572
|
+
*/
|
|
10573
|
+
interface CitationSourceUrl extends CitationSourceBase {
|
|
10574
|
+
/**
|
|
10575
|
+
* Citation url.
|
|
10576
|
+
*/
|
|
10577
|
+
url: string;
|
|
10578
|
+
}
|
|
10579
|
+
/**
|
|
10580
|
+
* Used when the citation references media, such as a PDF document.
|
|
10581
|
+
*/
|
|
10582
|
+
interface CitationSourceMedia extends CitationSourceBase {
|
|
10583
|
+
/** The mime type of the media. If non-specified, should be discovered through the downloadUrl. */
|
|
10584
|
+
mimeType?: string;
|
|
10585
|
+
/** Download URL for the media */
|
|
10586
|
+
downloadUrl?: string;
|
|
10587
|
+
/** The page number for the media, if applicable (e.g. for application/pdf documents) */
|
|
10588
|
+
pageNumber?: string;
|
|
10589
|
+
}
|
|
10590
|
+
/**
|
|
10591
|
+
* Citation sources can target either an Url or a media (e.g. a pdf document).
|
|
10592
|
+
* Repeated citation sources within a content part are identified by the same title and number.
|
|
10593
|
+
*/
|
|
10594
|
+
type CitationSource = CitationSourceUrl | CitationSourceMedia;
|
|
10595
|
+
/**
|
|
10596
|
+
* JSON compatible primitive type.
|
|
10597
|
+
*/
|
|
10598
|
+
type JSONPrimitive = string | number | boolean | null;
|
|
10599
|
+
/**
|
|
10600
|
+
* JSON compatible value type.
|
|
10601
|
+
*/
|
|
10602
|
+
type JSONValue = JSONPrimitive | Record<string, any> | any[];
|
|
10603
|
+
/**
|
|
10604
|
+
* JSON compatible object type.
|
|
10605
|
+
*/
|
|
10606
|
+
type JSONObject = Record<string, JSONValue>;
|
|
10607
|
+
/**
|
|
10608
|
+
* JSON compatible array type.
|
|
10609
|
+
*/
|
|
10610
|
+
type JSONArray = JSONValue[];
|
|
10611
|
+
/**
|
|
10612
|
+
* An arbitrary JSON serializable object.
|
|
10613
|
+
*/
|
|
10614
|
+
type MetaData = JSONObject;
|
|
10615
|
+
/**
|
|
10616
|
+
* Produces the provided object type with specified properties changed to optional.
|
|
10617
|
+
*/
|
|
10618
|
+
type MakeOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
10619
|
+
/**
|
|
10620
|
+
* Produces the provided object type with specified properties changed to required.
|
|
10621
|
+
*/
|
|
10622
|
+
type MakeRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
|
|
10623
|
+
/**
|
|
10624
|
+
* Causes typescript to simplify the display of object types created using MakeOptional, MakeRequired, and other utility
|
|
10625
|
+
* types. This doesn't change the effective type, but makes popups in the ide and compile error messages cleaner.
|
|
10626
|
+
*/
|
|
10627
|
+
type Simplify<T> = T extends any[] | Date ? T : {
|
|
10628
|
+
[K in keyof T]: T[K];
|
|
10629
|
+
} & {};
|
|
10630
|
+
/**
|
|
10631
|
+
* Inline value - used when a value is small enough to be returned inline with an API result.
|
|
10632
|
+
*/
|
|
10633
|
+
interface InlineValue<T> {
|
|
10634
|
+
inline: T;
|
|
10635
|
+
}
|
|
10636
|
+
/**
|
|
10637
|
+
* External value - used when a value is too large to be returned inline with an API result.
|
|
10638
|
+
*/
|
|
10639
|
+
interface ExternalValue {
|
|
10640
|
+
uri: string;
|
|
10641
|
+
byteCount?: number;
|
|
10642
|
+
}
|
|
10643
|
+
/**
|
|
9711
10644
|
* Inline or external value - used when a value can be too large to include inline in input or output data.
|
|
9712
10645
|
* If the inline property is set, it contains the full value, otherwise the uri property is set and it contains an uri
|
|
9713
10646
|
* from which the data can be downloaded.
|
|
@@ -14757,14 +15690,153 @@ interface AgentListItem {
|
|
|
14757
15690
|
quantityPLTU: number;
|
|
14758
15691
|
}
|
|
14759
15692
|
/**
|
|
14760
|
-
* Options for
|
|
14761
|
-
*
|
|
14762
|
-
* Composes filter, pagination, and sort options.
|
|
15693
|
+
* Options for getting the list of agents.
|
|
15694
|
+
*
|
|
15695
|
+
* Composes filter, pagination, and sort options.
|
|
15696
|
+
*/
|
|
15697
|
+
type AgentGetAllOptions = AgentFilterOptions & PaginationOptions & {
|
|
15698
|
+
/** Sort order for the result set. */
|
|
15699
|
+
orderBy?: AgentListOrderBy;
|
|
15700
|
+
};
|
|
15701
|
+
/**
|
|
15702
|
+
* Summary information about a single job execution — included on every
|
|
15703
|
+
* error entry to anchor the window.
|
|
15704
|
+
*/
|
|
15705
|
+
interface AgentJobInfo {
|
|
15706
|
+
/** Job key */
|
|
15707
|
+
jobKey: string;
|
|
15708
|
+
/** Folder key the job ran in */
|
|
15709
|
+
folderKey: string;
|
|
15710
|
+
/** Display name of the folder */
|
|
15711
|
+
folderName: string;
|
|
15712
|
+
/** Fully qualified folder path */
|
|
15713
|
+
folderPath: string;
|
|
15714
|
+
/** Job start time */
|
|
15715
|
+
startTime: string;
|
|
15716
|
+
/** Job end time. `null` while the job is still running. */
|
|
15717
|
+
endTime: string | null;
|
|
15718
|
+
/** Process key the job was launched from. `null` for ad-hoc jobs. */
|
|
15719
|
+
processKey: string | null;
|
|
15720
|
+
}
|
|
15721
|
+
/**
|
|
15722
|
+
* Columns available for ordering / grouping the agent errors list.
|
|
15723
|
+
*/
|
|
15724
|
+
declare enum AgentErrorSortColumn {
|
|
15725
|
+
AgentId = "AgentId",
|
|
15726
|
+
AgentName = "AgentName",
|
|
15727
|
+
ParentProcessName = "ParentProcessName",
|
|
15728
|
+
ErrorTitle = "ErrorTitle",
|
|
15729
|
+
FirstSeenStartTime = "FirstSeenStartTime",
|
|
15730
|
+
ExecutionCount = "ExecutionCount",
|
|
15731
|
+
Type = "Type",
|
|
15732
|
+
FirstSeenFolderName = "FirstSeenFolderName",
|
|
15733
|
+
FirstSeenFolderPath = "FirstSeenFolderPath",
|
|
15734
|
+
LastSeenStartTime = "LastSeenStartTime",
|
|
15735
|
+
LastSeenFolderName = "LastSeenFolderName",
|
|
15736
|
+
LastSeenFolderPath = "LastSeenFolderPath"
|
|
15737
|
+
}
|
|
15738
|
+
/**
|
|
15739
|
+
* Ordering directive for the agent errors list.
|
|
15740
|
+
*/
|
|
15741
|
+
interface AgentErrorOrderBy {
|
|
15742
|
+
/** Column to sort by */
|
|
15743
|
+
column: AgentErrorSortColumn;
|
|
15744
|
+
/** Sort descending. Defaults to false (ascending) server-side. */
|
|
15745
|
+
desc?: boolean;
|
|
15746
|
+
}
|
|
15747
|
+
/**
|
|
15748
|
+
* One error in the agent errors list — an error/error-class observed
|
|
15749
|
+
* for an agent over the requested window.
|
|
15750
|
+
*/
|
|
15751
|
+
interface AgentError {
|
|
15752
|
+
/** Error type */
|
|
15753
|
+
type: string;
|
|
15754
|
+
/** Error description */
|
|
15755
|
+
description: string;
|
|
15756
|
+
/** Agent ID */
|
|
15757
|
+
agentId: string;
|
|
15758
|
+
/** Agent display name. `null` if the agent has no display name set. */
|
|
15759
|
+
agentName: string | null;
|
|
15760
|
+
/** Job key where the error was first seen */
|
|
15761
|
+
jobKey: string;
|
|
15762
|
+
/** Parent process name. `null` for jobs not bound to a parent process. */
|
|
15763
|
+
parentProcess: string | null;
|
|
15764
|
+
/** First-seen timestamp */
|
|
15765
|
+
firstSeen: string;
|
|
15766
|
+
/** Folder key where the error was first observed */
|
|
15767
|
+
folderKey: string;
|
|
15768
|
+
/** Folder display name */
|
|
15769
|
+
folderName: string;
|
|
15770
|
+
/** Fully qualified folder path */
|
|
15771
|
+
folderPath: string;
|
|
15772
|
+
/** Number of error executions counted for this error */
|
|
15773
|
+
count: number;
|
|
15774
|
+
/** First job in the window where this error was observed */
|
|
15775
|
+
firstSeenJob: AgentJobInfo;
|
|
15776
|
+
/** Last job in the window where this error was observed */
|
|
15777
|
+
lastSeenJob: AgentJobInfo;
|
|
15778
|
+
}
|
|
15779
|
+
/**
|
|
15780
|
+
* Options for the agent errors list.
|
|
15781
|
+
*
|
|
15782
|
+
* Composes filter, pagination, and sort/group options.
|
|
15783
|
+
*/
|
|
15784
|
+
type AgentGetErrorsOptions = AgentFilterOptions & PaginationOptions & {
|
|
15785
|
+
/** Sort order for the result set. */
|
|
15786
|
+
orderBy?: AgentErrorOrderBy;
|
|
15787
|
+
/** Group results by one or more columns. */
|
|
15788
|
+
groupBy?: AgentErrorSortColumn[];
|
|
15789
|
+
};
|
|
15790
|
+
/**
|
|
15791
|
+
* A single point on the agent errors timeline
|
|
15792
|
+
*/
|
|
15793
|
+
interface AgentGetErrorsTimelineResponse {
|
|
15794
|
+
/** Agent name */
|
|
15795
|
+
name: string;
|
|
15796
|
+
/** Error count in this time bucket */
|
|
15797
|
+
value: number;
|
|
15798
|
+
/** Bucket timestamp (ISO 8601, UTC) */
|
|
15799
|
+
date: string;
|
|
15800
|
+
}
|
|
15801
|
+
/**
|
|
15802
|
+
* Options for getting the agent errors timeline.
|
|
14763
15803
|
*/
|
|
14764
|
-
|
|
14765
|
-
/**
|
|
14766
|
-
|
|
14767
|
-
}
|
|
15804
|
+
interface AgentGetErrorsTimelineOptions extends AgentFilterOptions {
|
|
15805
|
+
/** Max number of agents to return. Defaults to 10 server-side. */
|
|
15806
|
+
limit?: number;
|
|
15807
|
+
}
|
|
15808
|
+
/**
|
|
15809
|
+
* A single point on the agent consumption timeline
|
|
15810
|
+
*/
|
|
15811
|
+
interface AgentGetConsumptionTimelineResponse {
|
|
15812
|
+
/** Bucket timestamp (ISO 8601, UTC) */
|
|
15813
|
+
timeSlice: string;
|
|
15814
|
+
/** AGU quantity consumed in this time bucket */
|
|
15815
|
+
aguConsumption: number;
|
|
15816
|
+
}
|
|
15817
|
+
/**
|
|
15818
|
+
* Options for getting the agent consumption timeline.
|
|
15819
|
+
*/
|
|
15820
|
+
interface AgentGetConsumptionTimelineOptions extends AgentFilterOptions {
|
|
15821
|
+
}
|
|
15822
|
+
/**
|
|
15823
|
+
* A single point on the agent latency timeline
|
|
15824
|
+
*/
|
|
15825
|
+
interface AgentGetLatencyTimelineResponse {
|
|
15826
|
+
/**
|
|
15827
|
+
* Percentile label for this point — observed values: `"P50"`, `"P95"`.
|
|
15828
|
+
*/
|
|
15829
|
+
name: string;
|
|
15830
|
+
/** Latency value in milliseconds. */
|
|
15831
|
+
value: number;
|
|
15832
|
+
/** Bucket timestamp (ISO 8601, UTC) */
|
|
15833
|
+
date: string;
|
|
15834
|
+
}
|
|
15835
|
+
/**
|
|
15836
|
+
* Options for getting the agent latency timeline.
|
|
15837
|
+
*/
|
|
15838
|
+
interface AgentGetLatencyTimelineOptions extends AgentFilterOptions {
|
|
15839
|
+
}
|
|
14768
15840
|
|
|
14769
15841
|
/**
|
|
14770
15842
|
* Service for retrieving runtime data for UiPath Agents.
|
|
@@ -14820,7 +15892,164 @@ interface AgentServiceModel {
|
|
|
14820
15892
|
* }
|
|
14821
15893
|
* ```
|
|
14822
15894
|
*/
|
|
14823
|
-
getAll<T extends
|
|
15895
|
+
getAll<T extends AgentGetAllOptions = AgentGetAllOptions>(startTime: Date, endTime: Date, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<AgentListItem> : NonPaginatedResponse<AgentListItem>>;
|
|
15896
|
+
/**
|
|
15897
|
+
* Retrieves agent errors (error-classes observed for agents) over the
|
|
15898
|
+
* requested window.
|
|
15899
|
+
*
|
|
15900
|
+
* Returns a {@link PaginatedResponse} when pagination options (`pageSize`,
|
|
15901
|
+
* `cursor`, or `jumpToPage`) are provided, otherwise a
|
|
15902
|
+
* {@link NonPaginatedResponse}.
|
|
15903
|
+
*
|
|
15904
|
+
* @param startTime - Inclusive lower bound for the query window
|
|
15905
|
+
* @param endTime - Exclusive upper bound for the query window
|
|
15906
|
+
* @param options - Optional pagination, sort/group, and filters
|
|
15907
|
+
* @returns Promise resolving to a paginated or non-paginated list of {@link AgentError}
|
|
15908
|
+
* @example
|
|
15909
|
+
* ```typescript
|
|
15910
|
+
* import { Agents, AgentErrorSortColumn } from '@uipath/uipath-typescript/agents';
|
|
15911
|
+
*
|
|
15912
|
+
* const agents = new Agents(sdk);
|
|
15913
|
+
*
|
|
15914
|
+
* // Non-paginated — errors in the window
|
|
15915
|
+
* const result = await agents.getErrors(
|
|
15916
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
15917
|
+
* new Date('2026-05-14T00:00:00Z'),
|
|
15918
|
+
* );
|
|
15919
|
+
* result.items.forEach((error) => {
|
|
15920
|
+
* console.log(`${error.type}: ${error.description} (count=${error.count})`);
|
|
15921
|
+
* });
|
|
15922
|
+
*
|
|
15923
|
+
* // Paginated — sorted by execution count descending
|
|
15924
|
+
* const page = await agents.getErrors(
|
|
15925
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
15926
|
+
* new Date('2026-05-14T00:00:00Z'),
|
|
15927
|
+
* {
|
|
15928
|
+
* pageSize: 25,
|
|
15929
|
+
* orderBy: { column: AgentErrorSortColumn.ExecutionCount, desc: true },
|
|
15930
|
+
* },
|
|
15931
|
+
* );
|
|
15932
|
+
*
|
|
15933
|
+
* if (page.hasNextPage && page.nextCursor) {
|
|
15934
|
+
* const next = await agents.getErrors(
|
|
15935
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
15936
|
+
* new Date('2026-05-14T00:00:00Z'),
|
|
15937
|
+
* { cursor: page.nextCursor },
|
|
15938
|
+
* );
|
|
15939
|
+
* }
|
|
15940
|
+
* ```
|
|
15941
|
+
*/
|
|
15942
|
+
getErrors<T extends AgentGetErrorsOptions = AgentGetErrorsOptions>(startTime: Date, endTime: Date, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<AgentError> : NonPaginatedResponse<AgentError>>;
|
|
15943
|
+
/**
|
|
15944
|
+
* Retrieves a time-series of error counts grouped by agent over the requested window.
|
|
15945
|
+
*
|
|
15946
|
+
* @param startTime - Inclusive lower bound for the query window
|
|
15947
|
+
* @param endTime - Exclusive upper bound for the query window
|
|
15948
|
+
* @param options - Optional filters
|
|
15949
|
+
* @returns Promise resolving to an array of {@link AgentGetErrorsTimelineResponse}
|
|
15950
|
+
* @example
|
|
15951
|
+
* ```typescript
|
|
15952
|
+
* import { Agents } from '@uipath/uipath-typescript/agents';
|
|
15953
|
+
*
|
|
15954
|
+
* const agents = new Agents(sdk);
|
|
15955
|
+
*
|
|
15956
|
+
* // All errors in May 2025
|
|
15957
|
+
* const result = await agents.getErrorsTimeline(
|
|
15958
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
15959
|
+
* new Date('2025-06-01T00:00:00Z'),
|
|
15960
|
+
* );
|
|
15961
|
+
* result.forEach((point) => {
|
|
15962
|
+
* console.log(`${point.date} ${point.name}: ${point.value} errors`);
|
|
15963
|
+
* });
|
|
15964
|
+
* ```
|
|
15965
|
+
* @example
|
|
15966
|
+
* ```typescript
|
|
15967
|
+
* // Scope to specific folders and top 5 agents
|
|
15968
|
+
* const result = await agents.getErrorsTimeline(
|
|
15969
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
15970
|
+
* new Date('2025-06-01T00:00:00Z'),
|
|
15971
|
+
* {
|
|
15972
|
+
* folderKeys: ['<folderKey1>'],
|
|
15973
|
+
* agentNames: ['JokeAgent', 'StoryAgent'],
|
|
15974
|
+
* limit: 5,
|
|
15975
|
+
* },
|
|
15976
|
+
* );
|
|
15977
|
+
* ```
|
|
15978
|
+
*/
|
|
15979
|
+
getErrorsTimeline(startTime: Date, endTime: Date, options?: AgentGetErrorsTimelineOptions): Promise<AgentGetErrorsTimelineResponse[]>;
|
|
15980
|
+
/**
|
|
15981
|
+
* Retrieves a time-series of AGU (Agent Units) consumption over the requested window.
|
|
15982
|
+
*
|
|
15983
|
+
* @param startTime - Inclusive lower bound for the query window
|
|
15984
|
+
* @param endTime - Exclusive upper bound for the query window
|
|
15985
|
+
* @param options - Optional filters
|
|
15986
|
+
* @returns Promise resolving to an array of {@link AgentGetConsumptionTimelineResponse}
|
|
15987
|
+
* @example
|
|
15988
|
+
* ```typescript
|
|
15989
|
+
* import { Agents } from '@uipath/uipath-typescript/agents';
|
|
15990
|
+
*
|
|
15991
|
+
* const agents = new Agents(sdk);
|
|
15992
|
+
*
|
|
15993
|
+
* // AGU consumption timeline in May 2025
|
|
15994
|
+
* const result = await agents.getConsumptionTimeline(
|
|
15995
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
15996
|
+
* new Date('2025-06-01T00:00:00Z'),
|
|
15997
|
+
* );
|
|
15998
|
+
* result.forEach((point) => {
|
|
15999
|
+
* console.log(`${point.timeSlice}: ${point.aguConsumption} AGU`);
|
|
16000
|
+
* });
|
|
16001
|
+
* ```
|
|
16002
|
+
* @example
|
|
16003
|
+
* ```typescript
|
|
16004
|
+
* // Scope to specific folders and agents
|
|
16005
|
+
* const result = await agents.getConsumptionTimeline(
|
|
16006
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
16007
|
+
* new Date('2025-06-01T00:00:00Z'),
|
|
16008
|
+
* {
|
|
16009
|
+
* folderKeys: ['<folderKey1>'],
|
|
16010
|
+
* agentNames: ['JokeAgent'],
|
|
16011
|
+
* },
|
|
16012
|
+
* );
|
|
16013
|
+
* ```
|
|
16014
|
+
*/
|
|
16015
|
+
getConsumptionTimeline(startTime: Date, endTime: Date, options?: AgentGetConsumptionTimelineOptions): Promise<AgentGetConsumptionTimelineResponse[]>;
|
|
16016
|
+
/**
|
|
16017
|
+
* Retrieves a time-series of agent latency (milliseconds) over the requested
|
|
16018
|
+
* window.
|
|
16019
|
+
*
|
|
16020
|
+
* @param startTime - Inclusive lower bound for the query window
|
|
16021
|
+
* @param endTime - Exclusive upper bound for the query window
|
|
16022
|
+
* @param options - Optional filters
|
|
16023
|
+
* @returns Promise resolving to an array of {@link AgentGetLatencyTimelineResponse}
|
|
16024
|
+
* @example
|
|
16025
|
+
* ```typescript
|
|
16026
|
+
* import { Agents } from '@uipath/uipath-typescript/agents';
|
|
16027
|
+
*
|
|
16028
|
+
* const agents = new Agents(sdk);
|
|
16029
|
+
*
|
|
16030
|
+
* // Latency timeline in May 2025
|
|
16031
|
+
* const result = await agents.getLatencyTimeline(
|
|
16032
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
16033
|
+
* new Date('2025-06-01T00:00:00Z'),
|
|
16034
|
+
* );
|
|
16035
|
+
* result.forEach((point) => {
|
|
16036
|
+
* console.log(`${point.date} ${point.name}: ${point.value} ms`);
|
|
16037
|
+
* });
|
|
16038
|
+
* ```
|
|
16039
|
+
* @example
|
|
16040
|
+
* ```typescript
|
|
16041
|
+
* // Scope to specific folders and a single agent
|
|
16042
|
+
* const result = await agents.getLatencyTimeline(
|
|
16043
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
16044
|
+
* new Date('2025-06-01T00:00:00Z'),
|
|
16045
|
+
* {
|
|
16046
|
+
* folderKeys: ['<folderKey1>'],
|
|
16047
|
+
* agentId: '<agentId>',
|
|
16048
|
+
* },
|
|
16049
|
+
* );
|
|
16050
|
+
* ```
|
|
16051
|
+
*/
|
|
16052
|
+
getLatencyTimeline(startTime: Date, endTime: Date, options?: AgentGetLatencyTimelineOptions): Promise<AgentGetLatencyTimelineResponse[]>;
|
|
14824
16053
|
}
|
|
14825
16054
|
|
|
14826
16055
|
/**
|
|
@@ -15028,162 +16257,24 @@ interface AgentMemoryServiceModel {
|
|
|
15028
16257
|
getTopSpaces(options?: AgentMemoryGetTopSpacesOptions): Promise<AgentMemoryGetTopSpacesResponse[]>;
|
|
15029
16258
|
}
|
|
15030
16259
|
|
|
15031
|
-
declare enum DocumentActionPriority {
|
|
15032
|
-
Low = "Low",
|
|
15033
|
-
Medium = "Medium",
|
|
15034
|
-
High = "High",
|
|
15035
|
-
Critical = "Critical"
|
|
15036
|
-
}
|
|
15037
|
-
declare enum DocumentActionStatus {
|
|
15038
|
-
Unassigned = "Unassigned",
|
|
15039
|
-
Pending = "Pending",
|
|
15040
|
-
Completed = "Completed"
|
|
15041
|
-
}
|
|
15042
|
-
declare enum DocumentActionType {
|
|
15043
|
-
Validation = "Validation",
|
|
15044
|
-
Classification = "Classification"
|
|
15045
|
-
}
|
|
15046
|
-
interface UserData {
|
|
15047
|
-
Id?: number | null;
|
|
15048
|
-
EmailAddress?: string | null;
|
|
15049
|
-
}
|
|
15050
|
-
|
|
15051
|
-
declare enum ComparisonOperator {
|
|
15052
|
-
Equals = "Equals",
|
|
15053
|
-
NotEquals = "NotEquals",
|
|
15054
|
-
Greater = "Greater",
|
|
15055
|
-
Less = "Less",
|
|
15056
|
-
GreaterOrEqual = "GreaterOrEqual",
|
|
15057
|
-
LessOrEqual = "LessOrEqual"
|
|
15058
|
-
}
|
|
15059
|
-
declare enum Criticality {
|
|
15060
|
-
Must = "Must",
|
|
15061
|
-
Should = "Should"
|
|
15062
|
-
}
|
|
15063
|
-
declare enum FieldType {
|
|
15064
|
-
Text = "Text",
|
|
15065
|
-
Number = "Number",
|
|
15066
|
-
Date = "Date",
|
|
15067
|
-
Name = "Name",
|
|
15068
|
-
Address = "Address",
|
|
15069
|
-
Keyword = "Keyword",
|
|
15070
|
-
Set = "Set",
|
|
15071
|
-
Boolean = "Boolean",
|
|
15072
|
-
Table = "Table",
|
|
15073
|
-
Internal = "Internal",
|
|
15074
|
-
FieldGroup = "FieldGroup",
|
|
15075
|
-
MonetaryQuantity = "MonetaryQuantity"
|
|
15076
|
-
}
|
|
15077
|
-
declare enum LogicalOperator {
|
|
15078
|
-
AND = "AND",
|
|
15079
|
-
OR = "OR"
|
|
15080
|
-
}
|
|
15081
|
-
declare enum RuleType {
|
|
15082
|
-
Mandatory = "Mandatory",
|
|
15083
|
-
PossibleValues = "PossibleValues",
|
|
15084
|
-
Regex = "Regex",
|
|
15085
|
-
StartsWith = "StartsWith",
|
|
15086
|
-
EndsWith = "EndsWith",
|
|
15087
|
-
FixedLength = "FixedLength",
|
|
15088
|
-
IsNumeric = "IsNumeric",
|
|
15089
|
-
IsDate = "IsDate",
|
|
15090
|
-
IsEmail = "IsEmail",
|
|
15091
|
-
Contains = "Contains",
|
|
15092
|
-
Expression = "Expression",
|
|
15093
|
-
TableExpression = "TableExpression",
|
|
15094
|
-
IsEmpty = "IsEmpty"
|
|
15095
|
-
}
|
|
15096
|
-
interface DataSource {
|
|
15097
|
-
ResourceId?: string | null;
|
|
15098
|
-
ElementFieldId?: string | null;
|
|
15099
|
-
}
|
|
15100
|
-
interface DocumentGroup {
|
|
15101
|
-
Name?: string | null;
|
|
15102
|
-
Categories?: string[] | null;
|
|
15103
|
-
}
|
|
15104
|
-
interface DocumentTaxonomy {
|
|
15105
|
-
DataContractVersion?: string | null;
|
|
15106
|
-
DocumentTypes?: DocumentTypeEntity[] | null;
|
|
15107
|
-
Groups?: DocumentGroup[] | null;
|
|
15108
|
-
SupportedLanguages?: LanguageInfo[] | null;
|
|
15109
|
-
ReportAsExceptionSettings?: ReportAsExceptionSettings;
|
|
15110
|
-
}
|
|
15111
|
-
interface DocumentTypeEntity {
|
|
15112
|
-
DocumentTypeId?: string | null;
|
|
15113
|
-
Group?: string | null;
|
|
15114
|
-
Category?: string | null;
|
|
15115
|
-
Name?: string | null;
|
|
15116
|
-
OptionalUniqueIdentifier?: string | null;
|
|
15117
|
-
TypeField?: TypeField;
|
|
15118
|
-
Fields?: Field[] | null;
|
|
15119
|
-
Metadata?: MetadataEntry[] | null;
|
|
15120
|
-
}
|
|
15121
|
-
interface ExceptionReasonOption {
|
|
15122
|
-
ExceptionReason?: string | null;
|
|
15123
|
-
}
|
|
15124
|
-
interface Field {
|
|
15125
|
-
FieldId?: string | null;
|
|
15126
|
-
FieldName?: string | null;
|
|
15127
|
-
IsMultiValue?: boolean;
|
|
15128
|
-
Type?: FieldType;
|
|
15129
|
-
DeriveFieldsFormat?: string | null;
|
|
15130
|
-
Components?: Field[] | null;
|
|
15131
|
-
SetValues?: string[] | null;
|
|
15132
|
-
Metadata?: MetadataEntry[] | null;
|
|
15133
|
-
RuleSet?: RuleSet;
|
|
15134
|
-
DefaultValue?: string | null;
|
|
15135
|
-
DataSource?: DataSource;
|
|
15136
|
-
}
|
|
15137
|
-
interface LanguageInfo {
|
|
15138
|
-
Name?: string | null;
|
|
15139
|
-
Code?: string | null;
|
|
15140
|
-
}
|
|
15141
|
-
interface MetadataEntry {
|
|
15142
|
-
Key?: string | null;
|
|
15143
|
-
Value?: string | null;
|
|
15144
|
-
}
|
|
15145
|
-
interface ReportAsExceptionSettings {
|
|
15146
|
-
ExceptionReasonOptions?: ExceptionReasonOption[] | null;
|
|
15147
|
-
}
|
|
15148
|
-
interface Rule {
|
|
15149
|
-
Name?: string | null;
|
|
15150
|
-
Type?: RuleType;
|
|
15151
|
-
LogicalOperator?: LogicalOperator;
|
|
15152
|
-
ComparisonOperator?: ComparisonOperator;
|
|
15153
|
-
Expression?: string | null;
|
|
15154
|
-
SetValues?: string[] | null;
|
|
15155
|
-
}
|
|
15156
|
-
interface RuleSet {
|
|
15157
|
-
Criticality?: Criticality;
|
|
15158
|
-
Rules?: Rule[] | null;
|
|
15159
|
-
}
|
|
15160
|
-
interface TypeField {
|
|
15161
|
-
FieldId?: string | null;
|
|
15162
|
-
FieldName?: string | null;
|
|
15163
|
-
}
|
|
15164
|
-
|
|
15165
|
-
interface FieldValue {
|
|
15166
|
-
Value?: string | null;
|
|
15167
|
-
DerivedValue?: string | null;
|
|
16260
|
+
declare enum DocumentActionPriority {
|
|
16261
|
+
Low = "Low",
|
|
16262
|
+
Medium = "Medium",
|
|
16263
|
+
High = "High",
|
|
16264
|
+
Critical = "Critical"
|
|
15168
16265
|
}
|
|
15169
|
-
|
|
15170
|
-
|
|
15171
|
-
|
|
15172
|
-
|
|
16266
|
+
declare enum DocumentActionStatus {
|
|
16267
|
+
Unassigned = "Unassigned",
|
|
16268
|
+
Pending = "Pending",
|
|
16269
|
+
Completed = "Completed"
|
|
15173
16270
|
}
|
|
15174
|
-
|
|
15175
|
-
|
|
15176
|
-
|
|
16271
|
+
declare enum DocumentActionType {
|
|
16272
|
+
Validation = "Validation",
|
|
16273
|
+
Classification = "Classification"
|
|
15177
16274
|
}
|
|
15178
|
-
interface
|
|
15179
|
-
|
|
15180
|
-
|
|
15181
|
-
Criticality?: Criticality;
|
|
15182
|
-
IsValid?: boolean;
|
|
15183
|
-
Results?: FieldValueResult[] | null;
|
|
15184
|
-
BrokenRules?: Rule[] | null;
|
|
15185
|
-
RowIndex?: number | null;
|
|
15186
|
-
TableFieldId?: string | null;
|
|
16275
|
+
interface UserData {
|
|
16276
|
+
Id?: number | null;
|
|
16277
|
+
EmailAddress?: string | null;
|
|
15187
16278
|
}
|
|
15188
16279
|
|
|
15189
16280
|
declare enum ClassifierDocumentTypeType {
|
|
@@ -15278,264 +16369,35 @@ interface DocumentExtractionActionDataModel {
|
|
|
15278
16369
|
LastModifierUser?: UserData;
|
|
15279
16370
|
CompletedByUser?: UserData;
|
|
15280
16371
|
CreationTime?: string | null;
|
|
15281
|
-
LastAssignedTime?: string | null;
|
|
15282
|
-
CompletionTime?: string | null;
|
|
15283
|
-
ProcessingTime?: number | null;
|
|
15284
|
-
Type?: DocumentActionType;
|
|
15285
|
-
}
|
|
15286
|
-
interface ExtractionPrompt {
|
|
15287
|
-
Id?: string | null;
|
|
15288
|
-
Question?: string | null;
|
|
15289
|
-
FieldType?: GptFieldType;
|
|
15290
|
-
MultiValued?: boolean | null;
|
|
15291
|
-
}
|
|
15292
|
-
interface ExtractionValidationConfigurationV2 {
|
|
15293
|
-
EnableRtlControls?: boolean;
|
|
15294
|
-
DisplayMode?: ValidationDisplayMode;
|
|
15295
|
-
FieldsValidationConfidence?: number | null;
|
|
15296
|
-
AllowChangeOfDocumentType?: boolean | null;
|
|
15297
|
-
}
|
|
15298
|
-
interface FieldGroupValueProjection {
|
|
15299
|
-
FieldGroupName?: string | null;
|
|
15300
|
-
FieldValues?: FieldValueProjection[] | null;
|
|
15301
|
-
}
|
|
15302
|
-
interface FieldValueProjection {
|
|
15303
|
-
Id?: string | null;
|
|
15304
|
-
Name?: string | null;
|
|
15305
|
-
Value?: string | null;
|
|
15306
|
-
UnformattedValue?: string | null;
|
|
15307
|
-
Confidence?: number | null;
|
|
15308
|
-
OcrConfidence?: number | null;
|
|
15309
|
-
Type?: FieldType;
|
|
15310
|
-
}
|
|
15311
|
-
|
|
15312
|
-
declare enum MarkupType {
|
|
15313
|
-
Unknown = "Unknown",
|
|
15314
|
-
Circled = "Circled",
|
|
15315
|
-
Underlined = "Underlined",
|
|
15316
|
-
Strikethrough = "Strikethrough"
|
|
15317
|
-
}
|
|
15318
|
-
declare enum ProcessingSource {
|
|
15319
|
-
Unknown = "Unknown",
|
|
15320
|
-
Ocr = "Ocr",
|
|
15321
|
-
Pdf = "Pdf",
|
|
15322
|
-
PlainText = "PlainText",
|
|
15323
|
-
PdfAndOcr = "PdfAndOcr"
|
|
15324
|
-
}
|
|
15325
|
-
declare enum Rotation {
|
|
15326
|
-
None = "None",
|
|
15327
|
-
Rotated90 = "Rotated90",
|
|
15328
|
-
Rotated180 = "Rotated180",
|
|
15329
|
-
Rotated270 = "Rotated270",
|
|
15330
|
-
Other = "Other"
|
|
15331
|
-
}
|
|
15332
|
-
declare enum SectionType {
|
|
15333
|
-
Vertical = "Vertical",
|
|
15334
|
-
Paragraph = "Paragraph",
|
|
15335
|
-
Header = "Header",
|
|
15336
|
-
Footer = "Footer",
|
|
15337
|
-
Table = "Table"
|
|
15338
|
-
}
|
|
15339
|
-
declare enum TextType {
|
|
15340
|
-
Unknown = "Unknown",
|
|
15341
|
-
Text = "Text",
|
|
15342
|
-
Checkbox = "Checkbox",
|
|
15343
|
-
Handwriting = "Handwriting",
|
|
15344
|
-
Barcode = "Barcode",
|
|
15345
|
-
QRcode = "QRcode",
|
|
15346
|
-
Stamp = "Stamp",
|
|
15347
|
-
Logo = "Logo",
|
|
15348
|
-
Circle = "Circle",
|
|
15349
|
-
Underline = "Underline",
|
|
15350
|
-
Cut = "Cut"
|
|
15351
|
-
}
|
|
15352
|
-
declare enum WordGroupType {
|
|
15353
|
-
Sentence = "Sentence",
|
|
15354
|
-
TableCell = "TableCell",
|
|
15355
|
-
TableRowEnd = "TableRowEnd",
|
|
15356
|
-
Heading = "Heading",
|
|
15357
|
-
Other = "Other"
|
|
15358
|
-
}
|
|
15359
|
-
interface DocumentEntity {
|
|
15360
|
-
DocumentId?: string | null;
|
|
15361
|
-
ContentType?: string | null;
|
|
15362
|
-
Length?: number;
|
|
15363
|
-
Pages?: Page[] | null;
|
|
15364
|
-
DocumentMetadata?: Metadata[] | null;
|
|
15365
|
-
}
|
|
15366
|
-
interface Metadata {
|
|
15367
|
-
Key?: string | null;
|
|
15368
|
-
Value?: string | null;
|
|
15369
|
-
}
|
|
15370
|
-
interface Page {
|
|
15371
|
-
PageIndex?: number;
|
|
15372
|
-
Size?: number[];
|
|
15373
|
-
Sections?: PageSection[] | null;
|
|
15374
|
-
PageMarkups?: PageMarkup[] | null;
|
|
15375
|
-
ProcessingSource?: ProcessingSource;
|
|
15376
|
-
IndexInText?: number;
|
|
15377
|
-
TextLength?: number;
|
|
15378
|
-
SkewAngle?: number;
|
|
15379
|
-
Rotation?: Rotation;
|
|
15380
|
-
PageMetadata?: Metadata[] | null;
|
|
15381
|
-
}
|
|
15382
|
-
interface PageMarkup {
|
|
15383
|
-
Box?: number[];
|
|
15384
|
-
Polygon?: number[] | null;
|
|
15385
|
-
OcrConfidence?: number;
|
|
15386
|
-
Text?: string | null;
|
|
15387
|
-
MarkupType?: MarkupType;
|
|
15388
|
-
}
|
|
15389
|
-
interface PageSection {
|
|
15390
|
-
IndexInText?: number;
|
|
15391
|
-
Language?: string | null;
|
|
15392
|
-
Length?: number;
|
|
15393
|
-
Rotation?: Rotation;
|
|
15394
|
-
SkewAngle?: number;
|
|
15395
|
-
Type?: SectionType;
|
|
15396
|
-
WordGroups?: WordGroup[] | null;
|
|
15397
|
-
}
|
|
15398
|
-
interface Word {
|
|
15399
|
-
Box?: number[];
|
|
15400
|
-
Polygon?: number[] | null;
|
|
15401
|
-
IndexInText?: number;
|
|
15402
|
-
OcrConfidence?: number;
|
|
15403
|
-
Text?: string | null;
|
|
15404
|
-
VisualLineNumber?: number;
|
|
15405
|
-
TextType?: TextType;
|
|
15406
|
-
MarkupType?: MarkupType[] | null;
|
|
15407
|
-
}
|
|
15408
|
-
interface WordGroup {
|
|
15409
|
-
IndexInText?: number;
|
|
15410
|
-
Length?: number;
|
|
15411
|
-
Type?: WordGroupType;
|
|
15412
|
-
Words?: Word[] | null;
|
|
15413
|
-
}
|
|
15414
|
-
|
|
15415
|
-
declare enum ResultsDataSource {
|
|
15416
|
-
Automatic = "Automatic",
|
|
15417
|
-
Manual = "Manual",
|
|
15418
|
-
ManuallyChanged = "ManuallyChanged",
|
|
15419
|
-
Defaulted = "Defaulted",
|
|
15420
|
-
External = "External"
|
|
15421
|
-
}
|
|
15422
|
-
interface ClassificationResult {
|
|
15423
|
-
DocumentTypeId?: string | null;
|
|
15424
|
-
DocumentId?: string | null;
|
|
15425
|
-
Confidence?: number;
|
|
15426
|
-
OcrConfidence?: number;
|
|
15427
|
-
Reference?: ResultsContentReference;
|
|
15428
|
-
DocumentBounds?: ResultsDocumentBounds;
|
|
15429
|
-
ClassifierName?: string | null;
|
|
15430
|
-
}
|
|
15431
|
-
interface ExtractionResult {
|
|
15432
|
-
DocumentId?: string | null;
|
|
15433
|
-
ResultsVersion?: number;
|
|
15434
|
-
ResultsDocument?: ResultsDocument;
|
|
15435
|
-
ExtractorPayloads?: ExtractorPayload[] | null;
|
|
15436
|
-
BusinessRulesResults?: RuleSetResult[] | null;
|
|
15437
|
-
}
|
|
15438
|
-
interface ExtractorPayload {
|
|
15439
|
-
Id?: string | null;
|
|
15440
|
-
Payload?: string | null;
|
|
15441
|
-
SavedPayloadId?: string | null;
|
|
15442
|
-
TaxonomySchemaMapping?: string | null;
|
|
15443
|
-
}
|
|
15444
|
-
interface ResultsContentReference {
|
|
15445
|
-
TextStartIndex?: number;
|
|
15446
|
-
TextLength?: number;
|
|
15447
|
-
Tokens?: ResultsValueTokens[] | null;
|
|
15448
|
-
}
|
|
15449
|
-
interface ResultsDataPoint {
|
|
15450
|
-
FieldId?: string | null;
|
|
15451
|
-
FieldName?: string | null;
|
|
15452
|
-
FieldType?: FieldType;
|
|
15453
|
-
IsMissing?: boolean;
|
|
15454
|
-
DataSource?: ResultsDataSource;
|
|
15455
|
-
Values?: ResultsValue[] | null;
|
|
15456
|
-
DataVersion?: number;
|
|
15457
|
-
OperatorConfirmed?: boolean;
|
|
15458
|
-
ValidatorNotes?: string | null;
|
|
15459
|
-
ValidatorNotesInfo?: string | null;
|
|
15460
|
-
}
|
|
15461
|
-
interface ResultsDerivedField {
|
|
15462
|
-
FieldId?: string | null;
|
|
15463
|
-
Value?: string | null;
|
|
15464
|
-
}
|
|
15465
|
-
interface ResultsDocument {
|
|
15466
|
-
Bounds?: ResultsDocumentBounds;
|
|
15467
|
-
Language?: string | null;
|
|
15468
|
-
DocumentGroup?: string | null;
|
|
15469
|
-
DocumentCategory?: string | null;
|
|
15470
|
-
DocumentTypeId?: string | null;
|
|
15471
|
-
DocumentTypeName?: string | null;
|
|
15472
|
-
DocumentTypeDataVersion?: number;
|
|
15473
|
-
DataVersion?: number;
|
|
15474
|
-
DocumentTypeSource?: ResultsDataSource;
|
|
15475
|
-
DocumentTypeField?: ResultsValue;
|
|
15476
|
-
Fields?: ResultsDataPoint[] | null;
|
|
15477
|
-
Tables?: ResultsTable[] | null;
|
|
15478
|
-
}
|
|
15479
|
-
interface ResultsDocumentBounds {
|
|
15480
|
-
PageCount?: number;
|
|
15481
|
-
PageRange?: string | null;
|
|
15482
|
-
}
|
|
15483
|
-
interface ResultsTable {
|
|
15484
|
-
FieldId?: string | null;
|
|
15485
|
-
FieldName?: string | null;
|
|
15486
|
-
IsMissing?: boolean;
|
|
15487
|
-
DataSource?: ResultsDataSource;
|
|
15488
|
-
DataVersion?: number;
|
|
15489
|
-
OperatorConfirmed?: boolean;
|
|
15490
|
-
Values?: ResultsTableValue[] | null;
|
|
15491
|
-
ValidatorNotes?: string | null;
|
|
15492
|
-
ValidatorNotesInfo?: string | null;
|
|
15493
|
-
}
|
|
15494
|
-
interface ResultsTableCell {
|
|
15495
|
-
RowIndex?: number;
|
|
15496
|
-
ColumnIndex?: number;
|
|
15497
|
-
IsHeader?: boolean;
|
|
15498
|
-
IsMissing?: boolean;
|
|
15499
|
-
OperatorConfirmed?: boolean;
|
|
15500
|
-
DataSource?: ResultsDataSource;
|
|
15501
|
-
DataVersion?: number;
|
|
15502
|
-
Values?: ResultsValue[] | null;
|
|
16372
|
+
LastAssignedTime?: string | null;
|
|
16373
|
+
CompletionTime?: string | null;
|
|
16374
|
+
ProcessingTime?: number | null;
|
|
16375
|
+
Type?: DocumentActionType;
|
|
15503
16376
|
}
|
|
15504
|
-
interface
|
|
15505
|
-
|
|
15506
|
-
|
|
15507
|
-
FieldType?:
|
|
16377
|
+
interface ExtractionPrompt {
|
|
16378
|
+
Id?: string | null;
|
|
16379
|
+
Question?: string | null;
|
|
16380
|
+
FieldType?: GptFieldType;
|
|
16381
|
+
MultiValued?: boolean | null;
|
|
15508
16382
|
}
|
|
15509
|
-
interface
|
|
15510
|
-
|
|
15511
|
-
|
|
15512
|
-
|
|
15513
|
-
|
|
15514
|
-
ColumnInfo?: ResultsTableColumnInfo[] | null;
|
|
15515
|
-
NumberOfRows?: number;
|
|
15516
|
-
ValidatorNotes?: string | null;
|
|
15517
|
-
ValidatorNotesInfo?: string | null;
|
|
16383
|
+
interface ExtractionValidationConfigurationV2 {
|
|
16384
|
+
EnableRtlControls?: boolean;
|
|
16385
|
+
DisplayMode?: ValidationDisplayMode;
|
|
16386
|
+
FieldsValidationConfidence?: number | null;
|
|
16387
|
+
AllowChangeOfDocumentType?: boolean | null;
|
|
15518
16388
|
}
|
|
15519
|
-
interface
|
|
15520
|
-
|
|
16389
|
+
interface FieldGroupValueProjection {
|
|
16390
|
+
FieldGroupName?: string | null;
|
|
16391
|
+
FieldValues?: FieldValueProjection[] | null;
|
|
16392
|
+
}
|
|
16393
|
+
interface FieldValueProjection {
|
|
16394
|
+
Id?: string | null;
|
|
16395
|
+
Name?: string | null;
|
|
15521
16396
|
Value?: string | null;
|
|
15522
16397
|
UnformattedValue?: string | null;
|
|
15523
|
-
|
|
15524
|
-
|
|
15525
|
-
|
|
15526
|
-
OperatorConfirmed?: boolean;
|
|
15527
|
-
OcrConfidence?: number;
|
|
15528
|
-
TextType?: TextType;
|
|
15529
|
-
ValidatorNotes?: string | null;
|
|
15530
|
-
ValidatorNotesInfo?: string | null;
|
|
15531
|
-
}
|
|
15532
|
-
interface ResultsValueTokens {
|
|
15533
|
-
TextStartIndex?: number;
|
|
15534
|
-
TextLength?: number;
|
|
15535
|
-
Page?: number;
|
|
15536
|
-
PageWidth?: number;
|
|
15537
|
-
PageHeight?: number;
|
|
15538
|
-
Boxes?: number[][] | null;
|
|
16398
|
+
Confidence?: number | null;
|
|
16399
|
+
OcrConfidence?: number | null;
|
|
16400
|
+
Type?: FieldType;
|
|
15539
16401
|
}
|
|
15540
16402
|
|
|
15541
16403
|
interface ClassificationRequestBody {
|
|
@@ -16455,6 +17317,535 @@ interface GovernanceServiceModel {
|
|
|
16455
17317
|
getOperationSummary(startTime: Date, options?: GovernanceFilterOptions): Promise<GovernanceOperationSummary>;
|
|
16456
17318
|
}
|
|
16457
17319
|
|
|
17320
|
+
/** Status of a span: whether it completed successfully, with an error, or was not set. */
|
|
17321
|
+
declare enum SpanStatus {
|
|
17322
|
+
Unset = "Unset",
|
|
17323
|
+
Ok = "Ok",
|
|
17324
|
+
Error = "Error",
|
|
17325
|
+
/** Span is still in progress. */
|
|
17326
|
+
Running = "Running",
|
|
17327
|
+
/** Span data is hidden from the caller due to tenant/folder permission rules. */
|
|
17328
|
+
Restricted = "Restricted",
|
|
17329
|
+
/** Span was cancelled before completion. */
|
|
17330
|
+
Cancelled = "Cancelled"
|
|
17331
|
+
}
|
|
17332
|
+
/** Platform source that produced the span. */
|
|
17333
|
+
declare enum SpanSource {
|
|
17334
|
+
Testing = "Testing",
|
|
17335
|
+
Agents = "Agents",
|
|
17336
|
+
ProcessOrchestration = "ProcessOrchestration",
|
|
17337
|
+
ApiWorkflows = "ApiWorkflows",
|
|
17338
|
+
Robots = "Robots",
|
|
17339
|
+
ConversationalAgentsService = "ConversationalAgentsService",
|
|
17340
|
+
IntegrationServiceTrigger = "IntegrationServiceTrigger",
|
|
17341
|
+
Playground = "Playground",
|
|
17342
|
+
Governance = "Governance",
|
|
17343
|
+
/** Intelligent Experience Platform — unstructured and complex document processing source. */
|
|
17344
|
+
IXPUnstructuredAndComplexDocuments = "IXPUnstructuredAndComplexDocuments",
|
|
17345
|
+
/** Agents authored in code (as opposed to visual/no-code designers). */
|
|
17346
|
+
CodedAgents = "CodedAgents",
|
|
17347
|
+
/** Intelligent Experience Platform — communications mining source. */
|
|
17348
|
+
IXPCommunicationsMining = "IXPCommunicationsMining",
|
|
17349
|
+
/** UiPath Context Grounding — span produced by the Enterprise Context Service for RAG/knowledge-base operations. */
|
|
17350
|
+
EnterpriseContextService = "EnterpriseContextService",
|
|
17351
|
+
/** Model Context Protocol — span produced by an MCP server integration. */
|
|
17352
|
+
MCP = "MCP",
|
|
17353
|
+
/** Agent-to-Agent — span produced by an A2A protocol call between agents. */
|
|
17354
|
+
A2A = "A2A",
|
|
17355
|
+
/** Serverless — span produced by a serverless function execution. */
|
|
17356
|
+
Serverless = "Serverless"
|
|
17357
|
+
}
|
|
17358
|
+
/** Minimum severity level of events captured in the span. */
|
|
17359
|
+
declare enum SpanVerbosityLevel {
|
|
17360
|
+
Verbose = "Verbose",
|
|
17361
|
+
Trace = "Trace",
|
|
17362
|
+
Information = "Information",
|
|
17363
|
+
Warning = "Warning",
|
|
17364
|
+
Error = "Error",
|
|
17365
|
+
Critical = "Critical",
|
|
17366
|
+
Off = "Off"
|
|
17367
|
+
}
|
|
17368
|
+
/** Whether the span was produced during a debug or production runtime. */
|
|
17369
|
+
declare enum SpanExecutionType {
|
|
17370
|
+
Debug = "Debug",
|
|
17371
|
+
Runtime = "Runtime"
|
|
17372
|
+
}
|
|
17373
|
+
/** Whether the caller has permission to read this span's data. */
|
|
17374
|
+
declare enum SpanPermissionStatus {
|
|
17375
|
+
Allow = "Allow",
|
|
17376
|
+
/** Some span fields are redacted due to permission constraints (e.g. attributes visible but payload hidden). */
|
|
17377
|
+
PartialBlock = "PartialBlock",
|
|
17378
|
+
Block = "Block"
|
|
17379
|
+
}
|
|
17380
|
+
/** Storage provider that created or manages the attachment. */
|
|
17381
|
+
declare enum SpanAttachmentProvider {
|
|
17382
|
+
Orchestrator = "Orchestrator",
|
|
17383
|
+
/** Span attachment stored by the observability platform. */
|
|
17384
|
+
LLMOps = "LLMOps"
|
|
17385
|
+
}
|
|
17386
|
+
/** Whether the attachment is an input, output, or neither. */
|
|
17387
|
+
declare enum SpanAttachmentDirection {
|
|
17388
|
+
None = "None",
|
|
17389
|
+
In = "In",
|
|
17390
|
+
Out = "Out"
|
|
17391
|
+
}
|
|
17392
|
+
/** One level in the reference hierarchy that produced this span. */
|
|
17393
|
+
interface SpanReferenceHierarchyEntry {
|
|
17394
|
+
serviceType: string;
|
|
17395
|
+
referenceId: string;
|
|
17396
|
+
version: string | null;
|
|
17397
|
+
}
|
|
17398
|
+
/** Contextual lineage attached to the span (reference hierarchy). */
|
|
17399
|
+
interface SpanContext {
|
|
17400
|
+
referenceHierarchy: SpanReferenceHierarchyEntry[];
|
|
17401
|
+
}
|
|
17402
|
+
/** File or payload attachment linked to the span. */
|
|
17403
|
+
interface SpanAttachment {
|
|
17404
|
+
provider: SpanAttachmentProvider;
|
|
17405
|
+
id: string;
|
|
17406
|
+
fileName: string;
|
|
17407
|
+
mimeType: string;
|
|
17408
|
+
direction: SpanAttachmentDirection;
|
|
17409
|
+
}
|
|
17410
|
+
/** A single execution span returned by the Traces API. */
|
|
17411
|
+
interface SpanGetResponse {
|
|
17412
|
+
/** Unique identifier of this span (GUID). */
|
|
17413
|
+
id: string;
|
|
17414
|
+
/** Trace this span belongs to (GUID). */
|
|
17415
|
+
traceId: string;
|
|
17416
|
+
/** Parent span ID, or null for root spans. */
|
|
17417
|
+
parentId: string | null;
|
|
17418
|
+
/** Human-readable name of the operation, or null if the span has no name. */
|
|
17419
|
+
name: string | null;
|
|
17420
|
+
/** ISO-8601 UTC timestamp when the span started. */
|
|
17421
|
+
startTime: string;
|
|
17422
|
+
/** ISO-8601 UTC timestamp when the span ended, or null if still running. */
|
|
17423
|
+
endTime: string | null;
|
|
17424
|
+
/**
|
|
17425
|
+
* Span attributes (user-defined schema — do not transform keys).
|
|
17426
|
+
* Values depend on the span type and the agent that produced them.
|
|
17427
|
+
*/
|
|
17428
|
+
attributes: Record<string, unknown>;
|
|
17429
|
+
/** Completion status of the span. */
|
|
17430
|
+
status: SpanStatus;
|
|
17431
|
+
/** Platform source that produced the span. */
|
|
17432
|
+
source: SpanSource | null;
|
|
17433
|
+
/** Span type tag (e.g. `"agentRun"`, `"llmCall"`). */
|
|
17434
|
+
spanType: string | null;
|
|
17435
|
+
/** Minimum verbosity level captured in this span. */
|
|
17436
|
+
verbosityLevel: SpanVerbosityLevel | null;
|
|
17437
|
+
/** Whether this span was from a debug or runtime execution. */
|
|
17438
|
+
executionType: SpanExecutionType | null;
|
|
17439
|
+
/** Folder key (GUID) scoping this span. */
|
|
17440
|
+
folderKey: string | null;
|
|
17441
|
+
/** Identifier of the entity (agent, process, etc.) that produced the span. */
|
|
17442
|
+
referenceId: string | null;
|
|
17443
|
+
/** Version of the entity that produced the span. */
|
|
17444
|
+
referenceVersion: string | null;
|
|
17445
|
+
/** Version of the agent runtime. */
|
|
17446
|
+
agentVersion: string | null;
|
|
17447
|
+
/** Organization (account) GUID. */
|
|
17448
|
+
organizationId: string;
|
|
17449
|
+
/** Tenant GUID. */
|
|
17450
|
+
tenantId: string | null;
|
|
17451
|
+
/** Key of the process associated with this span. */
|
|
17452
|
+
processKey: string | null;
|
|
17453
|
+
/** Key of the job associated with this span. */
|
|
17454
|
+
jobKey: string | null;
|
|
17455
|
+
/** ISO-8601 UTC timestamp of last update. */
|
|
17456
|
+
updatedAt: string;
|
|
17457
|
+
/** Expiry timestamp, or null if the span does not expire. */
|
|
17458
|
+
expiredTime: string | null;
|
|
17459
|
+
/** Reference hierarchy context for this span. */
|
|
17460
|
+
context: SpanContext | null;
|
|
17461
|
+
/** File or payload attachments linked to this span. */
|
|
17462
|
+
attachments: SpanAttachment[] | null;
|
|
17463
|
+
/** Whether the caller can read this span's data. */
|
|
17464
|
+
permissionStatus: SpanPermissionStatus | null;
|
|
17465
|
+
}
|
|
17466
|
+
/** Options for retrieving all spans belonging to a trace. */
|
|
17467
|
+
interface TracesGetByIdOptions {
|
|
17468
|
+
/** Maximum number of spans to return. */
|
|
17469
|
+
pageSize?: number;
|
|
17470
|
+
/** Filter spans to those produced by a specific agent ID. */
|
|
17471
|
+
agentId?: string;
|
|
17472
|
+
/** When true, include expired spans that are outside the default retention window. */
|
|
17473
|
+
includeExpiredSpans?: boolean;
|
|
17474
|
+
}
|
|
17475
|
+
|
|
17476
|
+
/**
|
|
17477
|
+
* Service for querying UiPath execution traces (spans).
|
|
17478
|
+
*
|
|
17479
|
+
* Traces are OpenTelemetry-compatible execution records generated by agents, robots,
|
|
17480
|
+
* Maestro processes, conversational agents, and other UiPath execution sources.
|
|
17481
|
+
* The `source` field on each {@link SpanGetResponse} identifies the originating platform.
|
|
17482
|
+
*
|
|
17483
|
+
* @example
|
|
17484
|
+
* ```typescript
|
|
17485
|
+
* import { UiPath } from '@uipath/uipath-typescript/core';
|
|
17486
|
+
* import { Traces } from '@uipath/uipath-typescript/traces';
|
|
17487
|
+
*
|
|
17488
|
+
* const sdk = new UiPath(config);
|
|
17489
|
+
* await sdk.initialize();
|
|
17490
|
+
*
|
|
17491
|
+
* const traces = new Traces(sdk);
|
|
17492
|
+
* const spans = await traces.getById('<traceId>');
|
|
17493
|
+
* ```
|
|
17494
|
+
*/
|
|
17495
|
+
interface TracesServiceModel {
|
|
17496
|
+
/**
|
|
17497
|
+
* Gets all spans for a specific trace ID.
|
|
17498
|
+
*
|
|
17499
|
+
* Returns up to `pageSize` spans (default 1000) in a single fetch.
|
|
17500
|
+
* Accepts both GUID format and OTEL 32-char hex format — the API normalizes both.
|
|
17501
|
+
*
|
|
17502
|
+
* @param traceId - Trace identifier
|
|
17503
|
+
* @param options - Optional filters {@link TracesGetByIdOptions}
|
|
17504
|
+
* @returns Promise resolving to an array of {@link SpanGetResponse}, each containing span identity, timing, status, source platform, attributes, verbosity, execution type, lineage context, and any file attachments.
|
|
17505
|
+
* @example
|
|
17506
|
+
* ```typescript
|
|
17507
|
+
* import { Traces } from '@uipath/uipath-typescript/traces';
|
|
17508
|
+
*
|
|
17509
|
+
* const traces = new Traces(sdk);
|
|
17510
|
+
* const spans = await traces.getById('<traceId>');
|
|
17511
|
+
* console.log(spans.length, spans[0].spanType, spans[0].status);
|
|
17512
|
+
* ```
|
|
17513
|
+
* @example
|
|
17514
|
+
* ```typescript
|
|
17515
|
+
* // Filter to a specific agent's spans
|
|
17516
|
+
* const agentSpans = await traces.getById('<traceId>', {
|
|
17517
|
+
* agentId: '<agentId>',
|
|
17518
|
+
* pageSize: 500,
|
|
17519
|
+
* });
|
|
17520
|
+
* ```
|
|
17521
|
+
*/
|
|
17522
|
+
getById(traceId: string, options?: TracesGetByIdOptions): Promise<SpanGetResponse[]>;
|
|
17523
|
+
/**
|
|
17524
|
+
* Gets specific spans by trace ID and span IDs.
|
|
17525
|
+
*
|
|
17526
|
+
* Accepts OTEL 16-char hex or GUID format for span IDs.
|
|
17527
|
+
*
|
|
17528
|
+
* @param traceId - Trace identifier
|
|
17529
|
+
* @param spanIds - List of span IDs to retrieve
|
|
17530
|
+
* @returns Promise resolving to an array of matching {@link SpanGetResponse}, each containing span identity, timing, status, source platform, attributes, verbosity, execution type, lineage context, and any file attachments.
|
|
17531
|
+
* @example
|
|
17532
|
+
* ```typescript
|
|
17533
|
+
* import { Traces } from '@uipath/uipath-typescript/traces';
|
|
17534
|
+
*
|
|
17535
|
+
* const traces = new Traces(sdk);
|
|
17536
|
+
*
|
|
17537
|
+
* // First retrieve all spans to find the IDs you want
|
|
17538
|
+
* const allSpans = await traces.getById('<traceId>');
|
|
17539
|
+
* const spanIds = allSpans.slice(0, 3).map(s => s.id);
|
|
17540
|
+
*
|
|
17541
|
+
* const subset = await traces.getSpansByIds('<traceId>', spanIds);
|
|
17542
|
+
* ```
|
|
17543
|
+
*/
|
|
17544
|
+
getSpansByIds(traceId: string, spanIds: string[]): Promise<SpanGetResponse[]>;
|
|
17545
|
+
}
|
|
17546
|
+
|
|
17547
|
+
/**
|
|
17548
|
+
* Filter fields shared by the trace-level agent endpoints
|
|
17549
|
+
*/
|
|
17550
|
+
interface AgentTraceFilterOptions {
|
|
17551
|
+
/** Inclusive lower bound for the query window. Omit to use the server default (1 year ago). */
|
|
17552
|
+
startTime?: Date;
|
|
17553
|
+
/** Exclusive upper bound for the query window. Omit to use the server default (now). */
|
|
17554
|
+
endTime?: Date;
|
|
17555
|
+
/** Folder keys to scope the query. Intersected with the user's accessible folders. */
|
|
17556
|
+
folderKeys?: string[];
|
|
17557
|
+
/** Filter to a single agent by ID. */
|
|
17558
|
+
agentId?: string;
|
|
17559
|
+
/** Filter to a specific agent version. */
|
|
17560
|
+
agentVersion?: string;
|
|
17561
|
+
/** Filter to a specific execution type. */
|
|
17562
|
+
executionType?: SpanExecutionType;
|
|
17563
|
+
}
|
|
17564
|
+
/**
|
|
17565
|
+
* One point on the trace-level errors timeline — error count for a single
|
|
17566
|
+
* (error name, time bucket).
|
|
17567
|
+
*/
|
|
17568
|
+
interface AgentTraceGetErrorsTimelineResponse {
|
|
17569
|
+
/** Error name / category for this time-slice. */
|
|
17570
|
+
name: string;
|
|
17571
|
+
/** Count of errors in this time bucket for this name. */
|
|
17572
|
+
value: number;
|
|
17573
|
+
/** Bucket timestamp. */
|
|
17574
|
+
date: string;
|
|
17575
|
+
}
|
|
17576
|
+
/**
|
|
17577
|
+
* Options for the trace-level errors timeline.
|
|
17578
|
+
*/
|
|
17579
|
+
interface AgentTraceGetErrorsTimelineOptions extends AgentTraceFilterOptions {
|
|
17580
|
+
}
|
|
17581
|
+
/**
|
|
17582
|
+
* One point on the trace-level latency timeline — a latency value for a single
|
|
17583
|
+
* (series, time bucket).
|
|
17584
|
+
*/
|
|
17585
|
+
interface AgentTraceGetLatencyTimelineResponse {
|
|
17586
|
+
/** Series/grouping name for this latency point. */
|
|
17587
|
+
name: string;
|
|
17588
|
+
/** Latency value in decimal seconds for this series and time bucket. */
|
|
17589
|
+
value: number;
|
|
17590
|
+
/** Bucket timestamp. */
|
|
17591
|
+
date: string;
|
|
17592
|
+
}
|
|
17593
|
+
/**
|
|
17594
|
+
* Options for the trace-level latency timeline.
|
|
17595
|
+
*/
|
|
17596
|
+
interface AgentTraceGetLatencyTimelineOptions extends AgentTraceFilterOptions {
|
|
17597
|
+
}
|
|
17598
|
+
/**
|
|
17599
|
+
* Per-agent unit consumption totals over the requested window (trace-level) —
|
|
17600
|
+
* a flat per-(agent, version, folder) breakdown of AGU and PLTU consumed.
|
|
17601
|
+
*/
|
|
17602
|
+
interface AgentTraceGetUnitConsumptionResponse {
|
|
17603
|
+
/** Agent ID these totals belong to. */
|
|
17604
|
+
agentId: string;
|
|
17605
|
+
/** Folder key (GUID) the consumption was recorded in. */
|
|
17606
|
+
folderKey: string;
|
|
17607
|
+
/** Agent version these totals belong to. */
|
|
17608
|
+
agentVersion: string;
|
|
17609
|
+
/** Agent units consumed over the window. */
|
|
17610
|
+
agentUnitsConsumed: number;
|
|
17611
|
+
/** Platform units consumed over the window. */
|
|
17612
|
+
platformUnitsConsumed: number;
|
|
17613
|
+
}
|
|
17614
|
+
/**
|
|
17615
|
+
* Options for the trace-level per-agent unit consumption.
|
|
17616
|
+
*/
|
|
17617
|
+
interface AgentTraceGetUnitConsumptionOptions extends AgentTraceFilterOptions {
|
|
17618
|
+
}
|
|
17619
|
+
/**
|
|
17620
|
+
* A single span record from the trace store.
|
|
17621
|
+
*/
|
|
17622
|
+
interface AgentSpanGetResponse {
|
|
17623
|
+
/** Span ID. */
|
|
17624
|
+
id: string;
|
|
17625
|
+
/** ID of the trace this span belongs to. */
|
|
17626
|
+
traceId: string;
|
|
17627
|
+
/** Parent span ID. `null` for a root span. */
|
|
17628
|
+
parentId: string | null;
|
|
17629
|
+
/** Span name. */
|
|
17630
|
+
name: string;
|
|
17631
|
+
/** Span start time. */
|
|
17632
|
+
startTime: string;
|
|
17633
|
+
/** Span end time. `null` while the span is in progress. */
|
|
17634
|
+
endTime: string | null;
|
|
17635
|
+
/** Raw span attributes as a JSON string. */
|
|
17636
|
+
attributes: string;
|
|
17637
|
+
/** Span status. */
|
|
17638
|
+
status: string;
|
|
17639
|
+
/** Organization ID (GUID). */
|
|
17640
|
+
organizationId: string;
|
|
17641
|
+
/** Tenant ID (GUID). May be `null`. */
|
|
17642
|
+
tenantId: string | null;
|
|
17643
|
+
/** Span retention expiry time. May be `null`. */
|
|
17644
|
+
expiredTime: string | null;
|
|
17645
|
+
/** Folder key (GUID) the span was recorded in. May be `null`. */
|
|
17646
|
+
folderKey: string | null;
|
|
17647
|
+
/** Span source. May be `null`. */
|
|
17648
|
+
source: string | null;
|
|
17649
|
+
/** Span type. May be `null`. */
|
|
17650
|
+
spanType: string | null;
|
|
17651
|
+
/** Process key (GUID). May be `null`. */
|
|
17652
|
+
processKey: string | null;
|
|
17653
|
+
/** Job key (GUID). May be `null`. */
|
|
17654
|
+
jobKey: string | null;
|
|
17655
|
+
/** Reference ID (GUID). May be `null`. */
|
|
17656
|
+
referenceId: string | null;
|
|
17657
|
+
/** Verbosity level. May be `null`. */
|
|
17658
|
+
verbosityLevel: string | null;
|
|
17659
|
+
/** Record last-updated time. */
|
|
17660
|
+
updatedAt: string;
|
|
17661
|
+
/** Whether the span payload is stored as a large payload. */
|
|
17662
|
+
isLargePayload: boolean;
|
|
17663
|
+
/** Payload compression type. May be `null`. */
|
|
17664
|
+
compressionType: string | null;
|
|
17665
|
+
/** Agent version that produced the span. May be `null`. */
|
|
17666
|
+
agentVersion: string | null;
|
|
17667
|
+
/** Raw span context as a JSON string. May be `null`. */
|
|
17668
|
+
context: string | null;
|
|
17669
|
+
}
|
|
17670
|
+
/**
|
|
17671
|
+
* Options for the spans-by-reference query.
|
|
17672
|
+
*
|
|
17673
|
+
* Composes the optional hierarchy/time filters with pagination options.
|
|
17674
|
+
*/
|
|
17675
|
+
type AgentTraceGetSpansByReferenceOptions = PaginationOptions & {
|
|
17676
|
+
/** Optional trace scope — narrows the scan to a single trace. */
|
|
17677
|
+
traceId?: string;
|
|
17678
|
+
/** Restrict matches to hierarchy entries with this service type. */
|
|
17679
|
+
serviceType?: string;
|
|
17680
|
+
/** Restrict matches to hierarchy entries with this version. */
|
|
17681
|
+
version?: string;
|
|
17682
|
+
/** Inclusive lower bound on span start time. */
|
|
17683
|
+
startTime?: Date;
|
|
17684
|
+
/** Exclusive upper bound on span end time. */
|
|
17685
|
+
endTime?: Date;
|
|
17686
|
+
/** Execution type filter */
|
|
17687
|
+
executionType?: SpanExecutionType;
|
|
17688
|
+
};
|
|
17689
|
+
|
|
17690
|
+
/**
|
|
17691
|
+
* Service for retrieving UiPath Agent trace metrics.
|
|
17692
|
+
*/
|
|
17693
|
+
interface AgentTracesServiceModel {
|
|
17694
|
+
/**
|
|
17695
|
+
* Retrieves a trace-level time-series of error counts grouped by error name.
|
|
17696
|
+
*
|
|
17697
|
+
* @param options - Optional window and filters
|
|
17698
|
+
* @returns Promise resolving to an array of {@link AgentTraceGetErrorsTimelineResponse}
|
|
17699
|
+
* @example
|
|
17700
|
+
* ```typescript
|
|
17701
|
+
* import { AgentTraces } from '@uipath/uipath-typescript/traces';
|
|
17702
|
+
*
|
|
17703
|
+
* const trace = new AgentTraces(sdk);
|
|
17704
|
+
*
|
|
17705
|
+
* // Get the errors timeline
|
|
17706
|
+
* const result = await trace.getErrorsTimeline();
|
|
17707
|
+
* result.forEach((point) => {
|
|
17708
|
+
* console.log(`${point.date} ${point.name}: ${point.value} errors`);
|
|
17709
|
+
* });
|
|
17710
|
+
* ```
|
|
17711
|
+
* @example
|
|
17712
|
+
* ```typescript
|
|
17713
|
+
* import { AgentTraceExecutionType } from '@uipath/uipath-typescript/traces';
|
|
17714
|
+
*
|
|
17715
|
+
* // Get the errors timeline for an agent version within a time window
|
|
17716
|
+
* const filtered = await trace.getErrorsTimeline({
|
|
17717
|
+
* startTime: new Date('2025-05-01T00:00:00Z'),
|
|
17718
|
+
* endTime: new Date('2025-06-01T00:00:00Z'),
|
|
17719
|
+
* agentId: '<agentId>',
|
|
17720
|
+
* agentVersion: '1.0.0',
|
|
17721
|
+
* executionType: AgentTraceExecutionType.Runtime,
|
|
17722
|
+
* });
|
|
17723
|
+
* ```
|
|
17724
|
+
*/
|
|
17725
|
+
getErrorsTimeline(options?: AgentTraceGetErrorsTimelineOptions): Promise<AgentTraceGetErrorsTimelineResponse[]>;
|
|
17726
|
+
/**
|
|
17727
|
+
* Retrieves a trace-level time-series of latency.
|
|
17728
|
+
*
|
|
17729
|
+
* @param options - Optional window and filters
|
|
17730
|
+
* @returns Promise resolving to an array of {@link AgentTraceGetLatencyTimelineResponse}
|
|
17731
|
+
* @example
|
|
17732
|
+
* ```typescript
|
|
17733
|
+
* import { AgentTraces } from '@uipath/uipath-typescript/traces';
|
|
17734
|
+
*
|
|
17735
|
+
* const trace = new AgentTraces(sdk);
|
|
17736
|
+
*
|
|
17737
|
+
* // Get the latency timeline
|
|
17738
|
+
* const result = await trace.getLatencyTimeline();
|
|
17739
|
+
* result.forEach((point) => {
|
|
17740
|
+
* console.log(`${point.date} ${point.name}: ${point.value}s`);
|
|
17741
|
+
* });
|
|
17742
|
+
* ```
|
|
17743
|
+
* @example
|
|
17744
|
+
* ```typescript
|
|
17745
|
+
* import { AgentTraceExecutionType } from '@uipath/uipath-typescript/traces';
|
|
17746
|
+
*
|
|
17747
|
+
* // Get the latency timeline for an agent version within a time window
|
|
17748
|
+
* const filtered = await trace.getLatencyTimeline({
|
|
17749
|
+
* startTime: new Date('2025-05-01T00:00:00Z'),
|
|
17750
|
+
* endTime: new Date('2025-06-01T00:00:00Z'),
|
|
17751
|
+
* agentId: '<agentId>',
|
|
17752
|
+
* agentVersion: '1.0.0',
|
|
17753
|
+
* executionType: AgentTraceExecutionType.Runtime,
|
|
17754
|
+
* });
|
|
17755
|
+
* ```
|
|
17756
|
+
*/
|
|
17757
|
+
getLatencyTimeline(options?: AgentTraceGetLatencyTimelineOptions): Promise<AgentTraceGetLatencyTimelineResponse[]>;
|
|
17758
|
+
/**
|
|
17759
|
+
* Retrieves trace-level per-agent unit consumption totals.
|
|
17760
|
+
*
|
|
17761
|
+
* @param options - Optional window and filters
|
|
17762
|
+
* @returns Promise resolving to an array of {@link AgentTraceGetUnitConsumptionResponse}
|
|
17763
|
+
* @example
|
|
17764
|
+
* ```typescript
|
|
17765
|
+
* import { AgentTraces } from '@uipath/uipath-typescript/traces';
|
|
17766
|
+
*
|
|
17767
|
+
* const trace = new AgentTraces(sdk);
|
|
17768
|
+
*
|
|
17769
|
+
* // Get per-agent unit consumption
|
|
17770
|
+
* const result = await trace.getUnitConsumption();
|
|
17771
|
+
* result.forEach((row) => {
|
|
17772
|
+
* console.log(`${row.agentId}: ${row.agentUnitsConsumed} AGU, ${row.platformUnitsConsumed} PLTU`);
|
|
17773
|
+
* });
|
|
17774
|
+
* ```
|
|
17775
|
+
* @example
|
|
17776
|
+
* ```typescript
|
|
17777
|
+
* import { AgentTraceExecutionType } from '@uipath/uipath-typescript/traces';
|
|
17778
|
+
*
|
|
17779
|
+
* // Get per-agent unit consumption for an agent version within a time window
|
|
17780
|
+
* const filtered = await trace.getUnitConsumption({
|
|
17781
|
+
* startTime: new Date('2025-05-01T00:00:00Z'),
|
|
17782
|
+
* endTime: new Date('2025-06-01T00:00:00Z'),
|
|
17783
|
+
* agentId: '<agentId>',
|
|
17784
|
+
* agentVersion: '1.0.0',
|
|
17785
|
+
* executionType: AgentTraceExecutionType.Runtime,
|
|
17786
|
+
* });
|
|
17787
|
+
* ```
|
|
17788
|
+
*/
|
|
17789
|
+
getUnitConsumption(options?: AgentTraceGetUnitConsumptionOptions): Promise<AgentTraceGetUnitConsumptionResponse[]>;
|
|
17790
|
+
/**
|
|
17791
|
+
* Retrieves every span belonging to a single trace.
|
|
17792
|
+
*
|
|
17793
|
+
* @param traceId - Identifier of the trace whose spans should be returned
|
|
17794
|
+
* @returns Promise resolving to an array of {@link AgentSpanGetResponse}
|
|
17795
|
+
* @example
|
|
17796
|
+
* ```typescript
|
|
17797
|
+
* import { AgentTraces } from '@uipath/uipath-typescript/traces';
|
|
17798
|
+
*
|
|
17799
|
+
* const trace = new AgentTraces(sdk);
|
|
17800
|
+
*
|
|
17801
|
+
* const spans = await trace.getSpansByTraceId('<traceId>');
|
|
17802
|
+
* spans.forEach((span) => {
|
|
17803
|
+
* console.log(`${span.name} (${span.startTime} → ${span.endTime ?? 'in progress'})`);
|
|
17804
|
+
* });
|
|
17805
|
+
* ```
|
|
17806
|
+
*/
|
|
17807
|
+
getSpansByTraceId(traceId: string): Promise<AgentSpanGetResponse[]>;
|
|
17808
|
+
/**
|
|
17809
|
+
* Retrieves spans whose reference hierarchy contains the given reference id.
|
|
17810
|
+
*
|
|
17811
|
+
* Returns a {@link PaginatedResponse} when pagination options (`pageSize`,
|
|
17812
|
+
* `cursor`, or `jumpToPage`) are provided, otherwise a
|
|
17813
|
+
* {@link NonPaginatedResponse}.
|
|
17814
|
+
*
|
|
17815
|
+
* @param referenceId - Reference id matched against each span's reference hierarchy
|
|
17816
|
+
* @param options - Optional pagination and hierarchy/time filters
|
|
17817
|
+
* @returns Promise resolving to a paginated or non-paginated list of {@link AgentSpanGetResponse}
|
|
17818
|
+
* @example
|
|
17819
|
+
* ```typescript
|
|
17820
|
+
* import { AgentTraces } from '@uipath/uipath-typescript/traces';
|
|
17821
|
+
*
|
|
17822
|
+
* const trace = new AgentTraces(sdk);
|
|
17823
|
+
*
|
|
17824
|
+
* // Get spans by referenceId
|
|
17825
|
+
* const result = await trace.getSpansByReference('<referenceId>');
|
|
17826
|
+
* result.items.forEach((span) => console.log(span.name));
|
|
17827
|
+
* ```
|
|
17828
|
+
* @example
|
|
17829
|
+
* ```typescript
|
|
17830
|
+
* import { AgentTraceExecutionType } from '@uipath/uipath-typescript/traces';
|
|
17831
|
+
*
|
|
17832
|
+
* // Get spans by referenceId within a trace and time window
|
|
17833
|
+
* const page = await trace.getSpansByReference('<referenceId>', {
|
|
17834
|
+
* traceId: '<traceId>',
|
|
17835
|
+
* executionType: AgentTraceExecutionType.Runtime,
|
|
17836
|
+
* startTime: new Date('2025-05-01T00:00:00Z'),
|
|
17837
|
+
* endTime: new Date('2025-06-01T00:00:00Z'),
|
|
17838
|
+
* pageSize: 25,
|
|
17839
|
+
* });
|
|
17840
|
+
*
|
|
17841
|
+
* if (page.hasNextPage && page.nextCursor) {
|
|
17842
|
+
* const next = await trace.getSpansByReference('<referenceId>', { cursor: page.nextCursor });
|
|
17843
|
+
* }
|
|
17844
|
+
* ```
|
|
17845
|
+
*/
|
|
17846
|
+
getSpansByReference<T extends AgentTraceGetSpansByReferenceOptions = AgentTraceGetSpansByReferenceOptions>(referenceId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<AgentSpanGetResponse> : NonPaginatedResponse<AgentSpanGetResponse>>;
|
|
17847
|
+
}
|
|
17848
|
+
|
|
16458
17849
|
/**
|
|
16459
17850
|
* Error thrown when authorization fails (403 errors)
|
|
16460
17851
|
* Common scenarios:
|
|
@@ -16728,5 +18119,5 @@ declare const telemetryClient: {
|
|
|
16728
18119
|
setUserId(userId: string): void;
|
|
16729
18120
|
};
|
|
16730
18121
|
|
|
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,
|
|
18122
|
+
export { AgentErrorSortColumn, AgentListSortColumn, AgentMap, AgentMemoryExecutionType, SpanExecutionType as AgentTraceExecutionType, 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, SpanAttachmentDirection, SpanAttachmentProvider, SpanExecutionType, SpanPermissionStatus, SpanSource, SpanStatus, SpanVerbosityLevel, StageTaskType, StartStrategy, StopStrategy, TargetFramework, TaskActivityType, TaskAssignmentCriteria, 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 };
|
|
18123
|
+
export type { AgentAppearance, AgentConversationServiceModel, AgentCreateConversationOptions, AgentError, AgentErrorOrderBy, AgentFilterOptions, AgentGetAllOptions, AgentGetByIdResponse, AgentGetConsumptionTimelineOptions, AgentGetConsumptionTimelineResponse, AgentGetErrorsOptions, AgentGetErrorsTimelineOptions, AgentGetErrorsTimelineResponse, AgentGetLatencyTimelineOptions, AgentGetLatencyTimelineResponse, AgentGetResponse, AgentInput, AgentJobInfo, AgentListItem, AgentListOrderBy, AgentMemoryFilterOptions, AgentMemoryGetCallsTimelineOptions, AgentMemoryGetCallsTimelineResponse, AgentMemoryGetTimelineOptions, AgentMemoryGetTimelineResponse, AgentMemoryGetTopSpacesOptions, AgentMemoryGetTopSpacesResponse, AgentMemoryServiceModel, AgentMethods, AgentServiceModel, AgentSpanGetResponse, AgentStartingPrompt, AgentTraceFilterOptions, AgentTraceGetErrorsTimelineOptions, AgentTraceGetErrorsTimelineResponse, AgentTraceGetLatencyTimelineOptions, AgentTraceGetLatencyTimelineResponse, AgentTraceGetSpansByReferenceOptions, AgentTraceGetUnitConsumptionOptions, AgentTraceGetUnitConsumptionResponse, AgentTracesServiceModel, 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, BucketGetReadUriRequestOptions, BucketGetResponse, BucketGetUriOptions, BucketGetUriResponse, BucketServiceModel, BucketUploadFileOptions, BucketUploadFileRequestOptions, 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, ChoiceSetDeleteByIdOptions, ChoiceSetGetAllOptions, ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, ChoiceSetUpdateOptions, ChoiceSetValueDeleteOptions, ChoiceSetValueInsertOptions, ChoiceSetValueInsertResponse, ChoiceSetValueUpdateOptions, 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, EntityGetAllOptions, 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, ExceptionReportSubmitResult, 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, OrchestratorDuModuleServiceModel, PaginatedResponse, PaginationCursor, PaginationMetadata, PaginationMethodUnion, PaginationOptions, PartialUiPathConfig, ProcessExtractedDataOptions, ProcessExtractedDataRequest, 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, SpanAttachment, SpanContext, SpanGetResponse, SpanReferenceHierarchyEntry, SqlType, StageSLA, StageTask, SubmitExceptionReportOptions, SubmitExceptionReportResponse, 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, TracesGetByIdOptions, TracesServiceModel, UiPathSDKConfig, UserLoginInfo, UserSettingsGetResponse, UserSettingsServiceModel, UserSettingsUpdateOptions, UserSettingsUpdateResponse };
|