@uipath/uipath-typescript 1.4.2 → 1.5.1
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/README.md +7 -1
- package/dist/agent-memory/index.d.ts +4 -1
- package/dist/agents/index.cjs +341 -6
- package/dist/agents/index.d.ts +717 -16
- package/dist/agents/index.mjs +342 -7
- package/dist/assets/index.cjs +132 -15
- package/dist/assets/index.d.ts +12 -1
- package/dist/assets/index.mjs +132 -15
- package/dist/attachments/index.cjs +120 -12
- package/dist/attachments/index.mjs +120 -12
- package/dist/buckets/index.cjs +136 -15
- package/dist/buckets/index.d.ts +12 -1
- package/dist/buckets/index.mjs +136 -15
- package/dist/cases/index.cjs +1203 -938
- package/dist/cases/index.d.ts +325 -45
- package/dist/cases/index.mjs +1203 -938
- package/dist/conversational-agent/index.cjs +48 -10
- package/dist/conversational-agent/index.d.ts +117 -6
- package/dist/conversational-agent/index.mjs +48 -10
- package/dist/core/index.cjs +1 -1
- package/dist/core/index.mjs +1 -1
- package/dist/entities/index.cjs +448 -9
- package/dist/entities/index.d.ts +441 -1
- package/dist/entities/index.mjs +447 -10
- package/dist/feedback/index.cjs +25 -9
- package/dist/feedback/index.mjs +25 -9
- package/dist/index.cjs +1281 -330
- package/dist/index.d.ts +1988 -143
- package/dist/index.mjs +1282 -331
- package/dist/index.umd.js +1230 -279
- package/dist/jobs/index.cjs +141 -19
- package/dist/jobs/index.d.ts +22 -6
- package/dist/jobs/index.mjs +141 -19
- package/dist/maestro-processes/index.cjs +553 -354
- package/dist/maestro-processes/index.d.ts +376 -47
- package/dist/maestro-processes/index.mjs +553 -354
- package/dist/notifications/index.cjs +2012 -0
- package/dist/notifications/index.d.ts +615 -0
- package/dist/notifications/index.mjs +2010 -0
- package/dist/processes/index.cjs +118 -18
- package/dist/processes/index.d.ts +18 -2
- package/dist/processes/index.mjs +118 -18
- package/dist/queues/index.cjs +131 -14
- package/dist/queues/index.d.ts +12 -1
- package/dist/queues/index.mjs +131 -14
- package/dist/tasks/index.cjs +125 -13
- package/dist/tasks/index.d.ts +4 -1
- package/dist/tasks/index.mjs +125 -13
- package/dist/traces/index.cjs +220 -6
- package/dist/traces/index.d.ts +360 -25
- package/dist/traces/index.mjs +221 -7
- package/package.json +14 -4
package/dist/index.d.ts
CHANGED
|
@@ -3312,6 +3312,446 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
|
|
|
3312
3312
|
private resolveChoiceSetName;
|
|
3313
3313
|
}
|
|
3314
3314
|
|
|
3315
|
+
/**
|
|
3316
|
+
* @internal
|
|
3317
|
+
*/
|
|
3318
|
+
declare enum DataFabricRoleType {
|
|
3319
|
+
System = "System",
|
|
3320
|
+
UserDefined = "UserDefined"
|
|
3321
|
+
}
|
|
3322
|
+
/**
|
|
3323
|
+
* @internal
|
|
3324
|
+
*/
|
|
3325
|
+
interface DataFabricRole {
|
|
3326
|
+
id: string;
|
|
3327
|
+
name: string;
|
|
3328
|
+
type: DataFabricRoleType;
|
|
3329
|
+
directoryEntityCount?: number | null;
|
|
3330
|
+
folderId?: string;
|
|
3331
|
+
}
|
|
3332
|
+
/**
|
|
3333
|
+
* @internal
|
|
3334
|
+
*/
|
|
3335
|
+
interface DataFabricRoleGetAllOptions {
|
|
3336
|
+
/**
|
|
3337
|
+
* Include role statistics in the response.
|
|
3338
|
+
*
|
|
3339
|
+
* Defaults to true to match the Data Fabric UI and CLI role-list flow.
|
|
3340
|
+
*/
|
|
3341
|
+
stats?: boolean;
|
|
3342
|
+
/**
|
|
3343
|
+
* Optional folder key for folder-aware Role V2 requests.
|
|
3344
|
+
*
|
|
3345
|
+
* Forwarded on the wire as the `X-UIPATH-FolderKey` header.
|
|
3346
|
+
*/
|
|
3347
|
+
folderKey?: string;
|
|
3348
|
+
}
|
|
3349
|
+
|
|
3350
|
+
/**
|
|
3351
|
+
* @internal
|
|
3352
|
+
*/
|
|
3353
|
+
interface DataFabricRoleServiceModel {
|
|
3354
|
+
/**
|
|
3355
|
+
* Lists Data Fabric access roles.
|
|
3356
|
+
*
|
|
3357
|
+
* Returns tenant Data Fabric roles such as Admin, Designer, DataWriter, and
|
|
3358
|
+
* DataReader. Role IDs from this method can be passed to
|
|
3359
|
+
* `DataFabricDirectoryService.assignRoles()`.
|
|
3360
|
+
*
|
|
3361
|
+
* @param options - Optional query options
|
|
3362
|
+
* @returns Promise resolving to an array of {@link DataFabricRole}
|
|
3363
|
+
*
|
|
3364
|
+
* @example
|
|
3365
|
+
* ```typescript
|
|
3366
|
+
* import { DataFabricRoleService } from '@uipath/uipath-typescript/entities';
|
|
3367
|
+
*
|
|
3368
|
+
* const roles = new DataFabricRoleService(sdk);
|
|
3369
|
+
* const allRoles = await roles.getAll();
|
|
3370
|
+
* const dataWriter = allRoles.find(role => role.name === 'DataWriter');
|
|
3371
|
+
* ```
|
|
3372
|
+
*
|
|
3373
|
+
* @example
|
|
3374
|
+
* ```typescript
|
|
3375
|
+
* const rolesWithoutStats = await roles.getAll({ stats: false });
|
|
3376
|
+
* ```
|
|
3377
|
+
*
|
|
3378
|
+
* @example
|
|
3379
|
+
* ```typescript
|
|
3380
|
+
* const folderRoles = await roles.getAll({ folderKey: '<folder-key>' });
|
|
3381
|
+
* ```
|
|
3382
|
+
*
|
|
3383
|
+
* @internal
|
|
3384
|
+
*/
|
|
3385
|
+
getAll(options?: DataFabricRoleGetAllOptions): Promise<DataFabricRole[]>;
|
|
3386
|
+
}
|
|
3387
|
+
|
|
3388
|
+
/**
|
|
3389
|
+
* @internal
|
|
3390
|
+
*/
|
|
3391
|
+
declare class DataFabricRoleService extends BaseService implements DataFabricRoleServiceModel {
|
|
3392
|
+
/**
|
|
3393
|
+
* Lists Data Fabric access roles.
|
|
3394
|
+
*
|
|
3395
|
+
* Returns tenant Data Fabric roles such as Admin, Designer, DataWriter, and
|
|
3396
|
+
* DataReader. Role IDs from this method can be passed to
|
|
3397
|
+
* `DataFabricDirectoryService.assignRoles()`.
|
|
3398
|
+
*
|
|
3399
|
+
* @param options - Optional query options
|
|
3400
|
+
* @returns Promise resolving to an array of {@link DataFabricRole}
|
|
3401
|
+
*
|
|
3402
|
+
* @example
|
|
3403
|
+
* ```typescript
|
|
3404
|
+
* import { DataFabricRoleService } from '@uipath/uipath-typescript/entities';
|
|
3405
|
+
*
|
|
3406
|
+
* const roles = new DataFabricRoleService(sdk);
|
|
3407
|
+
* const allRoles = await roles.getAll();
|
|
3408
|
+
* const dataWriter = allRoles.find(role => role.name === 'DataWriter');
|
|
3409
|
+
* ```
|
|
3410
|
+
*
|
|
3411
|
+
* @example
|
|
3412
|
+
* ```typescript
|
|
3413
|
+
* const rolesWithoutStats = await roles.getAll({ stats: false });
|
|
3414
|
+
* ```
|
|
3415
|
+
*
|
|
3416
|
+
* @example
|
|
3417
|
+
* ```typescript
|
|
3418
|
+
* const folderRoles = await roles.getAll({ folderKey: '<folder-key>' });
|
|
3419
|
+
* ```
|
|
3420
|
+
*
|
|
3421
|
+
* @internal
|
|
3422
|
+
*/
|
|
3423
|
+
getAll(options?: DataFabricRoleGetAllOptions): Promise<DataFabricRole[]>;
|
|
3424
|
+
}
|
|
3425
|
+
|
|
3426
|
+
/**
|
|
3427
|
+
* @internal
|
|
3428
|
+
*/
|
|
3429
|
+
declare enum DataFabricDirectoryEntityType {
|
|
3430
|
+
/** Identity user, robot user, or directory robot principal. */
|
|
3431
|
+
User = 0,
|
|
3432
|
+
/** Identity group principal. */
|
|
3433
|
+
Group = 1,
|
|
3434
|
+
/** External application principal. */
|
|
3435
|
+
Application = 2
|
|
3436
|
+
}
|
|
3437
|
+
/**
|
|
3438
|
+
* @internal
|
|
3439
|
+
*/
|
|
3440
|
+
declare enum DataFabricDirectoryEntityTypeName {
|
|
3441
|
+
User = "User",
|
|
3442
|
+
Group = "Group",
|
|
3443
|
+
Application = "Application"
|
|
3444
|
+
}
|
|
3445
|
+
/**
|
|
3446
|
+
* @internal
|
|
3447
|
+
*/
|
|
3448
|
+
type DataFabricDirectoryEntityTypeInput = DataFabricDirectoryEntityType | DataFabricDirectoryEntityTypeName;
|
|
3449
|
+
/**
|
|
3450
|
+
* @internal
|
|
3451
|
+
*/
|
|
3452
|
+
interface DataFabricDirectoryRole {
|
|
3453
|
+
id: string;
|
|
3454
|
+
name: string;
|
|
3455
|
+
}
|
|
3456
|
+
/**
|
|
3457
|
+
* @internal
|
|
3458
|
+
*/
|
|
3459
|
+
interface DataFabricDirectoryEntry {
|
|
3460
|
+
externalId: string;
|
|
3461
|
+
name: string;
|
|
3462
|
+
email?: string | null;
|
|
3463
|
+
type: DataFabricDirectoryEntityTypeName;
|
|
3464
|
+
roles: DataFabricDirectoryRole[];
|
|
3465
|
+
objectType?: string | null;
|
|
3466
|
+
isUIEnabled: boolean;
|
|
3467
|
+
}
|
|
3468
|
+
/**
|
|
3469
|
+
* @internal
|
|
3470
|
+
*/
|
|
3471
|
+
interface DataFabricDirectoryListOptions {
|
|
3472
|
+
skip?: number;
|
|
3473
|
+
top?: number;
|
|
3474
|
+
}
|
|
3475
|
+
/**
|
|
3476
|
+
* @internal
|
|
3477
|
+
*/
|
|
3478
|
+
interface DataFabricDirectoryGetAllOptions {
|
|
3479
|
+
pageSize?: number;
|
|
3480
|
+
}
|
|
3481
|
+
/**
|
|
3482
|
+
* @internal
|
|
3483
|
+
*/
|
|
3484
|
+
interface DataFabricDirectoryListResponse {
|
|
3485
|
+
totalCount: number;
|
|
3486
|
+
results: DataFabricDirectoryEntry[];
|
|
3487
|
+
}
|
|
3488
|
+
/**
|
|
3489
|
+
* @internal
|
|
3490
|
+
*/
|
|
3491
|
+
interface DataFabricDirectoryAssignOptions {
|
|
3492
|
+
/**
|
|
3493
|
+
* Preserve the principal's current Data Fabric roles.
|
|
3494
|
+
*
|
|
3495
|
+
* Defaults to true because the Data Fabric role assignment endpoint replaces
|
|
3496
|
+
* the role set for each principal.
|
|
3497
|
+
*/
|
|
3498
|
+
preserveExisting?: boolean;
|
|
3499
|
+
/**
|
|
3500
|
+
* Enables Data Fabric UI access for the assigned principal.
|
|
3501
|
+
*
|
|
3502
|
+
* Defaults to true.
|
|
3503
|
+
*/
|
|
3504
|
+
uiEnabled?: boolean;
|
|
3505
|
+
}
|
|
3506
|
+
/**
|
|
3507
|
+
* @internal
|
|
3508
|
+
*/
|
|
3509
|
+
interface DataFabricDirectoryAssignmentResult {
|
|
3510
|
+
principalId: string;
|
|
3511
|
+
roleIds: string[];
|
|
3512
|
+
}
|
|
3513
|
+
|
|
3514
|
+
/**
|
|
3515
|
+
* @internal
|
|
3516
|
+
*/
|
|
3517
|
+
interface DataFabricDirectoryServiceModel {
|
|
3518
|
+
/**
|
|
3519
|
+
* Lists one page of Data Fabric directory principals and their current roles.
|
|
3520
|
+
*
|
|
3521
|
+
* Returns directory entries with external IDs, principal metadata, and
|
|
3522
|
+
* assigned Data Fabric roles.
|
|
3523
|
+
*
|
|
3524
|
+
* @param options - Optional offset paging options
|
|
3525
|
+
* @returns Promise resolving to {@link DataFabricDirectoryListResponse}
|
|
3526
|
+
*
|
|
3527
|
+
* @example
|
|
3528
|
+
* ```typescript
|
|
3529
|
+
* import { DataFabricDirectoryService } from '@uipath/uipath-typescript/entities';
|
|
3530
|
+
*
|
|
3531
|
+
* const directory = new DataFabricDirectoryService(sdk);
|
|
3532
|
+
* const page = await directory.list({ skip: 0, top: 50 });
|
|
3533
|
+
* const firstPrincipal = page.results[0];
|
|
3534
|
+
* ```
|
|
3535
|
+
*
|
|
3536
|
+
* @internal
|
|
3537
|
+
*/
|
|
3538
|
+
list(options?: DataFabricDirectoryListOptions): Promise<DataFabricDirectoryListResponse>;
|
|
3539
|
+
/**
|
|
3540
|
+
* Lists all Data Fabric directory principals and their current roles.
|
|
3541
|
+
*
|
|
3542
|
+
* Follows the Data Fabric directory top/skip pagination and returns
|
|
3543
|
+
* normalized entries. Entries without assigned roles include an empty
|
|
3544
|
+
* `roles` array.
|
|
3545
|
+
*
|
|
3546
|
+
* @param options - Optional page-size options
|
|
3547
|
+
* @returns Promise resolving to an array of {@link DataFabricDirectoryEntry}
|
|
3548
|
+
*
|
|
3549
|
+
* @example
|
|
3550
|
+
* ```typescript
|
|
3551
|
+
* import { DataFabricDirectoryService } from '@uipath/uipath-typescript/entities';
|
|
3552
|
+
*
|
|
3553
|
+
* const directory = new DataFabricDirectoryService(sdk);
|
|
3554
|
+
* const principals = await directory.getAll({ pageSize: 100 });
|
|
3555
|
+
* ```
|
|
3556
|
+
*
|
|
3557
|
+
* @internal
|
|
3558
|
+
*/
|
|
3559
|
+
getAll(options?: DataFabricDirectoryGetAllOptions): Promise<DataFabricDirectoryEntry[]>;
|
|
3560
|
+
/**
|
|
3561
|
+
* Assigns Data Fabric roles to one or more principals.
|
|
3562
|
+
*
|
|
3563
|
+
* The Data Fabric API replaces the role set for each principal, so this
|
|
3564
|
+
* method preserves existing roles by default and posts the union of current
|
|
3565
|
+
* and requested role IDs.
|
|
3566
|
+
*
|
|
3567
|
+
* Role IDs can be discovered with `DataFabricRoleService.getAll()`. Set
|
|
3568
|
+
* `preserveExisting: false` only when intentionally replacing a principal's
|
|
3569
|
+
* Data Fabric role set.
|
|
3570
|
+
*
|
|
3571
|
+
* @param principalIds - Principal external ID or IDs
|
|
3572
|
+
* @param principalType - Principal type
|
|
3573
|
+
* @param roleIds - Data Fabric role IDs to assign
|
|
3574
|
+
* @param options - Optional assignment behavior
|
|
3575
|
+
* @returns Promise resolving to an array of {@link DataFabricDirectoryAssignmentResult}
|
|
3576
|
+
*
|
|
3577
|
+
* @example
|
|
3578
|
+
* ```typescript
|
|
3579
|
+
* import { DataFabricDirectoryEntityTypeName, DataFabricDirectoryService, DataFabricRoleService } from '@uipath/uipath-typescript/entities';
|
|
3580
|
+
*
|
|
3581
|
+
* const roles = new DataFabricRoleService(sdk);
|
|
3582
|
+
* const directory = new DataFabricDirectoryService(sdk);
|
|
3583
|
+
*
|
|
3584
|
+
* const dataWriter = (await roles.getAll()).find(role => role.name === 'DataWriter');
|
|
3585
|
+
* if (!dataWriter) {
|
|
3586
|
+
* throw new Error('DataWriter role not found');
|
|
3587
|
+
* }
|
|
3588
|
+
*
|
|
3589
|
+
* await directory.assignRoles('<identity-group-id>', DataFabricDirectoryEntityTypeName.Group, [dataWriter.id]);
|
|
3590
|
+
* ```
|
|
3591
|
+
*
|
|
3592
|
+
* @example
|
|
3593
|
+
* ```typescript
|
|
3594
|
+
* await directory.assignRoles('<identity-user-id>', DataFabricDirectoryEntityTypeName.User, ['<role-id>'], {
|
|
3595
|
+
* preserveExisting: false,
|
|
3596
|
+
* });
|
|
3597
|
+
* ```
|
|
3598
|
+
*
|
|
3599
|
+
* @internal
|
|
3600
|
+
*/
|
|
3601
|
+
assignRoles(principalIds: string | string[], principalType: DataFabricDirectoryEntityTypeInput, roleIds: string[], options?: DataFabricDirectoryAssignOptions): Promise<DataFabricDirectoryAssignmentResult[]>;
|
|
3602
|
+
/**
|
|
3603
|
+
* Revokes all direct Data Fabric roles from one or more principals.
|
|
3604
|
+
*
|
|
3605
|
+
* The Data Fabric API removes all role assignments for each supplied external
|
|
3606
|
+
* ID. Use this when a principal should no longer have direct Data Fabric
|
|
3607
|
+
* access. Inherited access through groups is not changed.
|
|
3608
|
+
*
|
|
3609
|
+
* @param principalIds - Principal external ID or IDs
|
|
3610
|
+
* @returns Promise resolving when the roles are revoked
|
|
3611
|
+
*
|
|
3612
|
+
* @example
|
|
3613
|
+
* ```typescript
|
|
3614
|
+
* import { DataFabricDirectoryService } from '@uipath/uipath-typescript/entities';
|
|
3615
|
+
*
|
|
3616
|
+
* const directory = new DataFabricDirectoryService(sdk);
|
|
3617
|
+
*
|
|
3618
|
+
* await directory.revokeRoles('<identity-user-id>');
|
|
3619
|
+
* ```
|
|
3620
|
+
*
|
|
3621
|
+
* @example
|
|
3622
|
+
* ```typescript
|
|
3623
|
+
* await directory.revokeRoles([
|
|
3624
|
+
* '<identity-user-id>',
|
|
3625
|
+
* '<identity-group-id>',
|
|
3626
|
+
* ]);
|
|
3627
|
+
* ```
|
|
3628
|
+
*
|
|
3629
|
+
* @internal
|
|
3630
|
+
*/
|
|
3631
|
+
revokeRoles(principalIds: string | string[]): Promise<void>;
|
|
3632
|
+
}
|
|
3633
|
+
|
|
3634
|
+
/**
|
|
3635
|
+
* @internal
|
|
3636
|
+
*/
|
|
3637
|
+
declare class DataFabricDirectoryService extends BaseService implements DataFabricDirectoryServiceModel {
|
|
3638
|
+
private fetchAllEntries;
|
|
3639
|
+
/**
|
|
3640
|
+
* Lists one page of Data Fabric directory principals and their current roles.
|
|
3641
|
+
*
|
|
3642
|
+
* Returns directory entries with external IDs, principal metadata, and
|
|
3643
|
+
* assigned Data Fabric roles.
|
|
3644
|
+
*
|
|
3645
|
+
* @param options - Optional offset paging options
|
|
3646
|
+
* @returns Promise resolving to {@link DataFabricDirectoryListResponse}
|
|
3647
|
+
*
|
|
3648
|
+
* @example
|
|
3649
|
+
* ```typescript
|
|
3650
|
+
* import { DataFabricDirectoryService } from '@uipath/uipath-typescript/entities';
|
|
3651
|
+
*
|
|
3652
|
+
* const directory = new DataFabricDirectoryService(sdk);
|
|
3653
|
+
* const page = await directory.list({ skip: 0, top: 50 });
|
|
3654
|
+
* const firstPrincipal = page.results[0];
|
|
3655
|
+
* ```
|
|
3656
|
+
*
|
|
3657
|
+
* @internal
|
|
3658
|
+
*/
|
|
3659
|
+
list(options?: DataFabricDirectoryListOptions): Promise<DataFabricDirectoryListResponse>;
|
|
3660
|
+
/**
|
|
3661
|
+
* Lists all Data Fabric directory principals and their current roles.
|
|
3662
|
+
*
|
|
3663
|
+
* Follows the Data Fabric directory top/skip pagination and returns
|
|
3664
|
+
* normalized entries. Entries without assigned roles include an empty
|
|
3665
|
+
* `roles` array.
|
|
3666
|
+
*
|
|
3667
|
+
* @param options - Optional page-size options
|
|
3668
|
+
* @returns Promise resolving to an array of {@link DataFabricDirectoryEntry}
|
|
3669
|
+
*
|
|
3670
|
+
* @example
|
|
3671
|
+
* ```typescript
|
|
3672
|
+
* import { DataFabricDirectoryService } from '@uipath/uipath-typescript/entities';
|
|
3673
|
+
*
|
|
3674
|
+
* const directory = new DataFabricDirectoryService(sdk);
|
|
3675
|
+
* const principals = await directory.getAll({ pageSize: 100 });
|
|
3676
|
+
* ```
|
|
3677
|
+
*
|
|
3678
|
+
* @internal
|
|
3679
|
+
*/
|
|
3680
|
+
getAll(options?: DataFabricDirectoryGetAllOptions): Promise<DataFabricDirectoryEntry[]>;
|
|
3681
|
+
/**
|
|
3682
|
+
* Assigns Data Fabric roles to one or more principals.
|
|
3683
|
+
*
|
|
3684
|
+
* The Data Fabric API replaces the role set for each principal, so this
|
|
3685
|
+
* method preserves existing roles by default and posts the union of current
|
|
3686
|
+
* and requested role IDs.
|
|
3687
|
+
*
|
|
3688
|
+
* Role IDs can be discovered with `DataFabricRoleService.getAll()`. Set
|
|
3689
|
+
* `preserveExisting: false` only when intentionally replacing a principal's
|
|
3690
|
+
* Data Fabric role set.
|
|
3691
|
+
*
|
|
3692
|
+
* @param principalIds - Principal external ID or IDs
|
|
3693
|
+
* @param principalType - Principal type
|
|
3694
|
+
* @param roleIds - Data Fabric role IDs to assign
|
|
3695
|
+
* @param options - Optional assignment behavior
|
|
3696
|
+
* @returns Promise resolving to an array of {@link DataFabricDirectoryAssignmentResult}
|
|
3697
|
+
*
|
|
3698
|
+
* @example
|
|
3699
|
+
* ```typescript
|
|
3700
|
+
* import { DataFabricDirectoryEntityTypeName, DataFabricDirectoryService, DataFabricRoleService } from '@uipath/uipath-typescript/entities';
|
|
3701
|
+
*
|
|
3702
|
+
* const roles = new DataFabricRoleService(sdk);
|
|
3703
|
+
* const directory = new DataFabricDirectoryService(sdk);
|
|
3704
|
+
*
|
|
3705
|
+
* const dataWriter = (await roles.getAll()).find(role => role.name === 'DataWriter');
|
|
3706
|
+
* if (!dataWriter) {
|
|
3707
|
+
* throw new Error('DataWriter role not found');
|
|
3708
|
+
* }
|
|
3709
|
+
*
|
|
3710
|
+
* await directory.assignRoles('<identity-group-id>', DataFabricDirectoryEntityTypeName.Group, [dataWriter.id]);
|
|
3711
|
+
* ```
|
|
3712
|
+
*
|
|
3713
|
+
* @example
|
|
3714
|
+
* ```typescript
|
|
3715
|
+
* await directory.assignRoles('<identity-user-id>', DataFabricDirectoryEntityTypeName.User, ['<role-id>'], {
|
|
3716
|
+
* preserveExisting: false,
|
|
3717
|
+
* });
|
|
3718
|
+
* ```
|
|
3719
|
+
*
|
|
3720
|
+
* @internal
|
|
3721
|
+
*/
|
|
3722
|
+
assignRoles(principalIds: string | string[], principalType: DataFabricDirectoryEntityTypeInput, roleIds: string[], options?: DataFabricDirectoryAssignOptions): Promise<DataFabricDirectoryAssignmentResult[]>;
|
|
3723
|
+
/**
|
|
3724
|
+
* Revokes all direct Data Fabric roles from one or more principals.
|
|
3725
|
+
*
|
|
3726
|
+
* The Data Fabric API removes all role assignments for each supplied external
|
|
3727
|
+
* ID. Use this when a principal should no longer have direct Data Fabric
|
|
3728
|
+
* access. Inherited access through groups is not changed.
|
|
3729
|
+
*
|
|
3730
|
+
* @param principalIds - Principal external ID or IDs
|
|
3731
|
+
* @returns Promise resolving when the roles are revoked
|
|
3732
|
+
*
|
|
3733
|
+
* @example
|
|
3734
|
+
* ```typescript
|
|
3735
|
+
* import { DataFabricDirectoryService } from '@uipath/uipath-typescript/entities';
|
|
3736
|
+
*
|
|
3737
|
+
* const directory = new DataFabricDirectoryService(sdk);
|
|
3738
|
+
*
|
|
3739
|
+
* await directory.revokeRoles('<identity-user-id>');
|
|
3740
|
+
* ```
|
|
3741
|
+
*
|
|
3742
|
+
* @example
|
|
3743
|
+
* ```typescript
|
|
3744
|
+
* await directory.revokeRoles([
|
|
3745
|
+
* '<identity-user-id>',
|
|
3746
|
+
* '<identity-group-id>',
|
|
3747
|
+
* ]);
|
|
3748
|
+
* ```
|
|
3749
|
+
*
|
|
3750
|
+
* @internal
|
|
3751
|
+
*/
|
|
3752
|
+
revokeRoles(principalIds: string | string[]): Promise<void>;
|
|
3753
|
+
}
|
|
3754
|
+
|
|
3315
3755
|
/**
|
|
3316
3756
|
* Insights Types
|
|
3317
3757
|
* Shared types for Maestro insights analytics endpoints
|
|
@@ -3387,6 +3827,12 @@ interface TimelineOptions {
|
|
|
3387
3827
|
* @default TimeInterval.Day
|
|
3388
3828
|
*/
|
|
3389
3829
|
groupBy?: TimeInterval;
|
|
3830
|
+
/** Filter by package identifier */
|
|
3831
|
+
packageId?: string;
|
|
3832
|
+
/** Filter by package version */
|
|
3833
|
+
version?: string;
|
|
3834
|
+
/** Filter by one or more process keys. Pass `['<processKey>']` for a single process. */
|
|
3835
|
+
processKeys?: string[];
|
|
3390
3836
|
}
|
|
3391
3837
|
/**
|
|
3392
3838
|
* Final instance statuses returned by the instance status timeline endpoint.
|
|
@@ -3415,16 +3861,89 @@ interface InstanceStatusTimelineResponse {
|
|
|
3415
3861
|
count: number;
|
|
3416
3862
|
}
|
|
3417
3863
|
/**
|
|
3418
|
-
*
|
|
3864
|
+
* Incident count within a specific time bucket.
|
|
3865
|
+
*/
|
|
3866
|
+
interface IncidentTimelineResponse {
|
|
3867
|
+
/** Start of the time bucket in local timezone (ISO 8601, e.g. `"2026-05-04T00:00:00"`) */
|
|
3868
|
+
startTime: string;
|
|
3869
|
+
/** End of the time bucket in local timezone (ISO 8601, e.g. `"2026-05-11T00:00:00"`) */
|
|
3870
|
+
endTime: string;
|
|
3871
|
+
/** Number of incidents that occurred within this time bucket */
|
|
3872
|
+
count: number;
|
|
3873
|
+
}
|
|
3874
|
+
/**
|
|
3875
|
+
* Response for the top duration Insights endpoint
|
|
3876
|
+
*/
|
|
3877
|
+
interface GetTopDurationResponse extends GetTopBaseResponse {
|
|
3878
|
+
/** Total execution duration in milliseconds */
|
|
3879
|
+
duration: number;
|
|
3880
|
+
}
|
|
3881
|
+
/**
|
|
3882
|
+
* Duration percentile stats shared by Insights aggregate endpoints (per-element and per-process/case).
|
|
3883
|
+
*
|
|
3884
|
+
* For instance-level stats, durations are computed over terminal instances only
|
|
3885
|
+
* (Completed, Cancelled, Deleted) and default to `0` when no terminal instances exist.
|
|
3886
|
+
*/
|
|
3887
|
+
interface DurationStats {
|
|
3888
|
+
/** Minimum duration in milliseconds */
|
|
3889
|
+
minDurationMs: number;
|
|
3890
|
+
/** Maximum duration in milliseconds */
|
|
3891
|
+
maxDurationMs: number;
|
|
3892
|
+
/** Average duration in milliseconds */
|
|
3893
|
+
avgDurationMs: number;
|
|
3894
|
+
/** 50th percentile (median) duration in milliseconds */
|
|
3895
|
+
p50DurationMs: number;
|
|
3896
|
+
/** 95th percentile duration in milliseconds */
|
|
3897
|
+
p95DurationMs: number;
|
|
3898
|
+
/** 99th percentile duration in milliseconds */
|
|
3899
|
+
p99DurationMs: number;
|
|
3900
|
+
}
|
|
3901
|
+
/**
|
|
3902
|
+
* Instance count and duration stats aggregated by status for a process or case within a time range.
|
|
3903
|
+
*
|
|
3904
|
+
* Duration fields are computed over terminal instances only (Completed, Cancelled, Deleted)
|
|
3905
|
+
* and default to `0` when no terminal instances exist in the time range.
|
|
3906
|
+
*/
|
|
3907
|
+
interface InstanceStats extends DurationStats {
|
|
3908
|
+
/** Total number of instances across all statuses */
|
|
3909
|
+
totalCount: number;
|
|
3910
|
+
/** Number of currently running instances */
|
|
3911
|
+
runningCount: number;
|
|
3912
|
+
/** Number of instances in transitioning state */
|
|
3913
|
+
transitioningCount: number;
|
|
3914
|
+
/** Number of paused instances */
|
|
3915
|
+
pausedCount: number;
|
|
3916
|
+
/** Number of faulted instances */
|
|
3917
|
+
faultedCount: number;
|
|
3918
|
+
/** Number of completed instances */
|
|
3919
|
+
completedCount: number;
|
|
3920
|
+
/** Number of cancelled instances */
|
|
3921
|
+
cancelledCount: number;
|
|
3922
|
+
/** Number of deleted instances */
|
|
3923
|
+
deletedCount: number;
|
|
3924
|
+
}
|
|
3925
|
+
/**
|
|
3926
|
+
* Required request parameters for process-scoped insights stats endpoints
|
|
3927
|
+
* (`getElementStats`, `getInstanceStats`).
|
|
3928
|
+
*
|
|
3929
|
+
* Identifies a single process+package+version and the time range to aggregate over.
|
|
3419
3930
|
*/
|
|
3420
|
-
interface
|
|
3421
|
-
/**
|
|
3422
|
-
|
|
3931
|
+
interface MaestroProcessStatsRequest {
|
|
3932
|
+
/** Process key to filter by */
|
|
3933
|
+
processKey: string;
|
|
3934
|
+
/** Package identifier */
|
|
3935
|
+
packageId: string;
|
|
3936
|
+
/** Package version to filter by */
|
|
3937
|
+
packageVersion: string;
|
|
3938
|
+
/** Start of the time range to query */
|
|
3939
|
+
startTime: Date;
|
|
3940
|
+
/** End of the time range to query */
|
|
3941
|
+
endTime: Date;
|
|
3423
3942
|
}
|
|
3424
3943
|
/**
|
|
3425
|
-
*
|
|
3944
|
+
* Per-element execution counts and duration percentiles for a BPMN element within a process or case.
|
|
3426
3945
|
*/
|
|
3427
|
-
interface ElementStats {
|
|
3946
|
+
interface ElementStats extends DurationStats {
|
|
3428
3947
|
/** BPMN element identifier */
|
|
3429
3948
|
elementId: string;
|
|
3430
3949
|
/** Number of successful executions */
|
|
@@ -3437,18 +3956,6 @@ interface ElementStats {
|
|
|
3437
3956
|
pausedCount: number;
|
|
3438
3957
|
/** Number of in-progress executions */
|
|
3439
3958
|
inProgressCount: number;
|
|
3440
|
-
/** Minimum duration in milliseconds */
|
|
3441
|
-
minDurationMs: number;
|
|
3442
|
-
/** Maximum duration in milliseconds */
|
|
3443
|
-
maxDurationMs: number;
|
|
3444
|
-
/** Average duration in milliseconds */
|
|
3445
|
-
avgDurationMs: number;
|
|
3446
|
-
/** 50th percentile (median) duration in milliseconds */
|
|
3447
|
-
p50DurationMs: number;
|
|
3448
|
-
/** 95th percentile duration in milliseconds */
|
|
3449
|
-
p95DurationMs: number;
|
|
3450
|
-
/** 99th percentile duration in milliseconds */
|
|
3451
|
-
p99DurationMs: number;
|
|
3452
3959
|
}
|
|
3453
3960
|
|
|
3454
3961
|
/**
|
|
@@ -3766,7 +4273,7 @@ interface MaestroProcessesServiceModel {
|
|
|
3766
4273
|
*
|
|
3767
4274
|
* @param startTime - Start of the time range to query
|
|
3768
4275
|
* @param endTime - End of the time range to query
|
|
3769
|
-
* @param options - Optional settings for time
|
|
4276
|
+
* @param options - Optional settings for filtering and time bucket granularity
|
|
3770
4277
|
* @returns Promise resolving to an array of {@link InstanceStatusTimelineResponse}
|
|
3771
4278
|
*
|
|
3772
4279
|
* @example
|
|
@@ -3793,11 +4300,62 @@ interface MaestroProcessesServiceModel {
|
|
|
3793
4300
|
*
|
|
3794
4301
|
* @example
|
|
3795
4302
|
* ```typescript
|
|
4303
|
+
* // Filter to a specific process
|
|
4304
|
+
* const filtered = await maestroProcesses.getInstanceStatusTimeline(startTime, endTime, {
|
|
4305
|
+
* processKeys: ['<processKey>'],
|
|
4306
|
+
* });
|
|
4307
|
+
* ```
|
|
4308
|
+
*
|
|
4309
|
+
* @example
|
|
4310
|
+
* ```typescript
|
|
3796
4311
|
* // Get all-time data (from Unix epoch to now)
|
|
3797
4312
|
* const allTime = await maestroProcesses.getInstanceStatusTimeline(new Date(0), new Date());
|
|
3798
4313
|
* ```
|
|
3799
4314
|
*/
|
|
3800
4315
|
getInstanceStatusTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<InstanceStatusTimelineResponse[]>;
|
|
4316
|
+
/**
|
|
4317
|
+
* Get incident counts aggregated by time bucket for maestro processes.
|
|
4318
|
+
*
|
|
4319
|
+
* Returns time-grouped counts of incidents that occurred within each bucket,
|
|
4320
|
+
* useful for rendering incident time-series charts. Use `groupBy` to control
|
|
4321
|
+
* the time bucket size (hour, day, or week) — defaults to day if not provided.
|
|
4322
|
+
*
|
|
4323
|
+
* @param startTime - Start of the time range to query
|
|
4324
|
+
* @param endTime - End of the time range to query
|
|
4325
|
+
* @param options - Optional settings for filtering and time bucket granularity
|
|
4326
|
+
* @returns Promise resolving to an array of {@link IncidentTimelineResponse}
|
|
4327
|
+
*
|
|
4328
|
+
* @example
|
|
4329
|
+
* ```typescript
|
|
4330
|
+
* // Get daily incident counts for the last 7 days
|
|
4331
|
+
* const now = new Date();
|
|
4332
|
+
* const sevenDaysAgo = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
|
|
4333
|
+
* const incidents = await maestroProcesses.getIncidentsTimeline(sevenDaysAgo, now);
|
|
4334
|
+
*
|
|
4335
|
+
* for (const incident of incidents) {
|
|
4336
|
+
* console.log(`${incident.startTime} → ${incident.endTime}: ${incident.count} incidents`);
|
|
4337
|
+
* }
|
|
4338
|
+
* ```
|
|
4339
|
+
*
|
|
4340
|
+
* @example
|
|
4341
|
+
* ```typescript
|
|
4342
|
+
* import { TimeInterval } from '@uipath/uipath-typescript/maestro-processes';
|
|
4343
|
+
*
|
|
4344
|
+
* // Get weekly breakdown
|
|
4345
|
+
* const incidents = await maestroProcesses.getIncidentsTimeline(startTime, endTime, {
|
|
4346
|
+
* groupBy: TimeInterval.Week,
|
|
4347
|
+
* });
|
|
4348
|
+
* ```
|
|
4349
|
+
*
|
|
4350
|
+
* @example
|
|
4351
|
+
* ```typescript
|
|
4352
|
+
* // Filter to a specific process
|
|
4353
|
+
* const filtered = await maestroProcesses.getIncidentsTimeline(startTime, endTime, {
|
|
4354
|
+
* processKeys: ['<processKey>'],
|
|
4355
|
+
* });
|
|
4356
|
+
* ```
|
|
4357
|
+
*/
|
|
4358
|
+
getIncidentsTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<IncidentTimelineResponse[]>;
|
|
3801
4359
|
/**
|
|
3802
4360
|
* Get the top 5 processes ranked by total duration within a time range.
|
|
3803
4361
|
*
|
|
@@ -3842,22 +4400,22 @@ interface MaestroProcessesServiceModel {
|
|
|
3842
4400
|
* Returns per-element execution counts (success, fail, terminated, paused, in-progress) and
|
|
3843
4401
|
* duration percentile metrics (min, max, avg, p50, p95, p99) for BPMN elements within a process.
|
|
3844
4402
|
*
|
|
3845
|
-
* @param
|
|
3846
|
-
* @param packageId - Package identifier
|
|
3847
|
-
* @param startTime - Start of the time range to query
|
|
3848
|
-
* @param endTime - End of the time range to query
|
|
3849
|
-
* @param packageVersion - Package version to filter by
|
|
4403
|
+
* @param request - Process scope + time range to aggregate over
|
|
3850
4404
|
* @returns Promise resolving to an array of {@link ElementStats}
|
|
3851
4405
|
* @example
|
|
3852
4406
|
* ```typescript
|
|
3853
|
-
* //
|
|
3854
|
-
* const
|
|
3855
|
-
*
|
|
3856
|
-
*
|
|
3857
|
-
*
|
|
3858
|
-
*
|
|
3859
|
-
*
|
|
3860
|
-
*
|
|
4407
|
+
* // First, list processes to find the processKey, packageId, and available versions
|
|
4408
|
+
* const processes = await maestroProcesses.getAll();
|
|
4409
|
+
* const process = processes[0];
|
|
4410
|
+
*
|
|
4411
|
+
* // Get element metrics for that process
|
|
4412
|
+
* const elements = await maestroProcesses.getElementStats({
|
|
4413
|
+
* processKey: process.processKey,
|
|
4414
|
+
* packageId: process.packageId,
|
|
4415
|
+
* packageVersion: process.packageVersions[0],
|
|
4416
|
+
* startTime: new Date('2026-04-01'),
|
|
4417
|
+
* endTime: new Date(),
|
|
4418
|
+
* });
|
|
3861
4419
|
*
|
|
3862
4420
|
* // Analyze element performance
|
|
3863
4421
|
* for (const element of elements) {
|
|
@@ -3865,9 +4423,52 @@ interface MaestroProcessesServiceModel {
|
|
|
3865
4423
|
* console.log(` Success: ${element.successCount}, Failed: ${element.failCount}`);
|
|
3866
4424
|
* console.log(` Avg duration: ${element.avgDurationMs}ms, P95: ${element.p95DurationMs}ms`);
|
|
3867
4425
|
* }
|
|
4426
|
+
*
|
|
4427
|
+
* // Using bound method on a process — auto-fills processKey and packageId
|
|
4428
|
+
* const boundElements = await process.getElementStats(
|
|
4429
|
+
* new Date('2026-04-01'),
|
|
4430
|
+
* new Date(),
|
|
4431
|
+
* process.packageVersions[0]
|
|
4432
|
+
* );
|
|
4433
|
+
* ```
|
|
4434
|
+
*/
|
|
4435
|
+
getElementStats(request: MaestroProcessStatsRequest): Promise<ElementStats[]>;
|
|
4436
|
+
/**
|
|
4437
|
+
* Get instance stats for a process.
|
|
4438
|
+
*
|
|
4439
|
+
* Returns total instance counts broken down by status (running, completed, faulted, etc.)
|
|
4440
|
+
* and the average execution duration for all instances of a process within a time range.
|
|
4441
|
+
*
|
|
4442
|
+
* @param request - Process scope + time range to aggregate over
|
|
4443
|
+
* @returns Promise resolving to {@link InstanceStats}
|
|
4444
|
+
* @example
|
|
4445
|
+
* ```typescript
|
|
4446
|
+
* // First, list processes to find the processKey, packageId, and available versions
|
|
4447
|
+
* const processes = await maestroProcesses.getAll();
|
|
4448
|
+
* const process = processes[0];
|
|
4449
|
+
*
|
|
4450
|
+
* // Get instance status breakdown for that process
|
|
4451
|
+
* const counts = await maestroProcesses.getInstanceStats({
|
|
4452
|
+
* processKey: process.processKey,
|
|
4453
|
+
* packageId: process.packageId,
|
|
4454
|
+
* packageVersion: process.packageVersions[0],
|
|
4455
|
+
* startTime: new Date('2026-04-01'),
|
|
4456
|
+
* endTime: new Date(),
|
|
4457
|
+
* });
|
|
4458
|
+
*
|
|
4459
|
+
* console.log(`Total: ${counts.totalCount}`);
|
|
4460
|
+
* console.log(`Running: ${counts.runningCount}, Completed: ${counts.completedCount}`);
|
|
4461
|
+
* console.log(`Faulted: ${counts.faultedCount}, Avg duration: ${counts.avgDurationMs}ms`);
|
|
4462
|
+
*
|
|
4463
|
+
* // Using bound method on a process — auto-fills processKey and packageId
|
|
4464
|
+
* const boundCounts = await process.getInstanceStats(
|
|
4465
|
+
* new Date('2026-04-01'),
|
|
4466
|
+
* new Date(),
|
|
4467
|
+
* process.packageVersions[0]
|
|
4468
|
+
* );
|
|
3868
4469
|
* ```
|
|
3869
4470
|
*/
|
|
3870
|
-
|
|
4471
|
+
getInstanceStats(request: MaestroProcessStatsRequest): Promise<InstanceStats>;
|
|
3871
4472
|
}
|
|
3872
4473
|
interface ProcessMethods {
|
|
3873
4474
|
/**
|
|
@@ -3885,6 +4486,33 @@ interface ProcessMethods {
|
|
|
3885
4486
|
* @returns Promise resolving to an array of {@link ElementStats}
|
|
3886
4487
|
*/
|
|
3887
4488
|
getElementStats(startTime: Date, endTime: Date, packageVersion: string): Promise<ElementStats[]>;
|
|
4489
|
+
/**
|
|
4490
|
+
* Get instance stats for this process
|
|
4491
|
+
*
|
|
4492
|
+
* @param startTime - Start of the time range to query
|
|
4493
|
+
* @param endTime - End of the time range to query
|
|
4494
|
+
* @param packageVersion - Package version to filter by
|
|
4495
|
+
* @returns Promise resolving to {@link InstanceStats}
|
|
4496
|
+
*/
|
|
4497
|
+
getInstanceStats(startTime: Date, endTime: Date, packageVersion: string): Promise<InstanceStats>;
|
|
4498
|
+
/**
|
|
4499
|
+
* Get instance status counts aggregated by date for this process.
|
|
4500
|
+
*
|
|
4501
|
+
* @param startTime - Start of the time range to query
|
|
4502
|
+
* @param endTime - End of the time range to query
|
|
4503
|
+
* @param options - Optional settings for filtering and time bucket granularity (processKey is auto-captured from this process)
|
|
4504
|
+
* @returns Promise resolving to an array of {@link InstanceStatusTimelineResponse}
|
|
4505
|
+
*/
|
|
4506
|
+
getInstanceStatusTimeline(startTime: Date, endTime: Date, options?: Omit<TimelineOptions, 'processKeys'>): Promise<InstanceStatusTimelineResponse[]>;
|
|
4507
|
+
/**
|
|
4508
|
+
* Get incident counts aggregated by time bucket for this process.
|
|
4509
|
+
*
|
|
4510
|
+
* @param startTime - Start of the time range to query
|
|
4511
|
+
* @param endTime - End of the time range to query
|
|
4512
|
+
* @param options - Optional settings for filtering and time bucket granularity (processKey is auto-captured from this process)
|
|
4513
|
+
* @returns Promise resolving to an array of {@link IncidentTimelineResponse}
|
|
4514
|
+
*/
|
|
4515
|
+
getIncidentsTimeline(startTime: Date, endTime: Date, options?: Omit<TimelineOptions, 'processKeys'>): Promise<IncidentTimelineResponse[]>;
|
|
3888
4516
|
}
|
|
3889
4517
|
type MaestroProcessGetAllResponse = RawMaestroProcessGetAllResponse & ProcessMethods;
|
|
3890
4518
|
/**
|
|
@@ -4062,7 +4690,10 @@ declare enum JobState {
|
|
|
4062
4690
|
Successful = "Successful",
|
|
4063
4691
|
Stopped = "Stopped",
|
|
4064
4692
|
Suspended = "Suspended",
|
|
4065
|
-
Resumed = "Resumed"
|
|
4693
|
+
Resumed = "Resumed",
|
|
4694
|
+
Cancelled = "Cancelled",
|
|
4695
|
+
/** Server-side fallback for an unrecognized or missing job state. */
|
|
4696
|
+
Unknown = "Unknown"
|
|
4066
4697
|
}
|
|
4067
4698
|
interface BaseOptions {
|
|
4068
4699
|
expand?: string;
|
|
@@ -4145,7 +4776,7 @@ interface ProcessInstancesServiceModel {
|
|
|
4145
4776
|
*/
|
|
4146
4777
|
getAll<T extends ProcessInstanceGetAllWithPaginationOptions = ProcessInstanceGetAllWithPaginationOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ProcessInstanceGetResponse> : NonPaginatedResponse<ProcessInstanceGetResponse>>;
|
|
4147
4778
|
/**
|
|
4148
|
-
* Get a process instance by ID with operation methods (cancel, pause, resume)
|
|
4779
|
+
* Get a process instance by ID with operation methods (cancel, pause, resume, retry)
|
|
4149
4780
|
* @param id The ID of the instance to retrieve
|
|
4150
4781
|
* @param folderKey The folder key for authorization
|
|
4151
4782
|
* @returns Promise resolving to a process instance
|
|
@@ -4264,6 +4895,35 @@ interface ProcessInstancesServiceModel {
|
|
|
4264
4895
|
* @returns Promise resolving to operation result with instance data
|
|
4265
4896
|
*/
|
|
4266
4897
|
resume(instanceId: string, folderKey: string, options?: ProcessInstanceOperationOptions): Promise<OperationResponse<ProcessInstanceOperationResponse>>;
|
|
4898
|
+
/**
|
|
4899
|
+
* Retry a faulted process instance
|
|
4900
|
+
*
|
|
4901
|
+
* Re-runs the failed elements of the instance (and the elements that follow) within the
|
|
4902
|
+
* same instance, spawning new jobs. Use to recover from transient/flaky failures.
|
|
4903
|
+
* @param instanceId The ID of the instance to retry
|
|
4904
|
+
* @param folderKey The folder key for authorization
|
|
4905
|
+
* @param options Optional retry options with comment
|
|
4906
|
+
* @returns Promise resolving to operation result with instance data
|
|
4907
|
+
* @example
|
|
4908
|
+
* ```typescript
|
|
4909
|
+
* // Retry a faulted process instance
|
|
4910
|
+
* const result = await processInstances.retry(
|
|
4911
|
+
* <instanceId>,
|
|
4912
|
+
* <folderKey>
|
|
4913
|
+
* );
|
|
4914
|
+
*
|
|
4915
|
+
* // Or using instance method
|
|
4916
|
+
* const instance = await processInstances.getById(
|
|
4917
|
+
* <instanceId>,
|
|
4918
|
+
* <folderKey>
|
|
4919
|
+
* );
|
|
4920
|
+
* if (instance.latestRunStatus === 'Faulted') {
|
|
4921
|
+
* const result = await instance.retry({ comment: 'Retrying flaky failure' });
|
|
4922
|
+
* console.log(`Retried: ${result.success}`);
|
|
4923
|
+
* }
|
|
4924
|
+
* ```
|
|
4925
|
+
*/
|
|
4926
|
+
retry(instanceId: string, folderKey: string, options?: ProcessInstanceOperationOptions): Promise<OperationResponse<ProcessInstanceOperationResponse>>;
|
|
4267
4927
|
/**
|
|
4268
4928
|
* Get global variables for a process instance
|
|
4269
4929
|
*
|
|
@@ -4344,6 +5004,13 @@ interface ProcessInstanceMethods {
|
|
|
4344
5004
|
* @returns Promise resolving to operation result
|
|
4345
5005
|
*/
|
|
4346
5006
|
resume(options?: ProcessInstanceOperationOptions): Promise<OperationResponse<ProcessInstanceOperationResponse>>;
|
|
5007
|
+
/**
|
|
5008
|
+
* Retries this faulted process instance
|
|
5009
|
+
*
|
|
5010
|
+
* @param options - Optional retry options with comment
|
|
5011
|
+
* @returns Promise resolving to operation result
|
|
5012
|
+
*/
|
|
5013
|
+
retry(options?: ProcessInstanceOperationOptions): Promise<OperationResponse<ProcessInstanceOperationResponse>>;
|
|
4347
5014
|
/**
|
|
4348
5015
|
* Gets incidents for this process instance
|
|
4349
5016
|
*
|
|
@@ -4639,7 +5306,7 @@ interface CasesServiceModel {
|
|
|
4639
5306
|
*
|
|
4640
5307
|
* @param startTime - Start of the time range to query
|
|
4641
5308
|
* @param endTime - End of the time range to query
|
|
4642
|
-
* @param options - Optional settings for time
|
|
5309
|
+
* @param options - Optional settings for filtering and time bucket granularity
|
|
4643
5310
|
* @returns Promise resolving to an array of {@link InstanceStatusTimelineResponse}
|
|
4644
5311
|
*
|
|
4645
5312
|
* @example
|
|
@@ -4666,11 +5333,62 @@ interface CasesServiceModel {
|
|
|
4666
5333
|
*
|
|
4667
5334
|
* @example
|
|
4668
5335
|
* ```typescript
|
|
5336
|
+
* // Filter to a specific case process
|
|
5337
|
+
* const filtered = await cases.getInstanceStatusTimeline(startTime, endTime, {
|
|
5338
|
+
* processKeys: ['<processKey>'],
|
|
5339
|
+
* });
|
|
5340
|
+
* ```
|
|
5341
|
+
*
|
|
5342
|
+
* @example
|
|
5343
|
+
* ```typescript
|
|
4669
5344
|
* // Get all-time data (from Unix epoch to now)
|
|
4670
5345
|
* const allTime = await cases.getInstanceStatusTimeline(new Date(0), new Date());
|
|
4671
5346
|
* ```
|
|
4672
5347
|
*/
|
|
4673
5348
|
getInstanceStatusTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<InstanceStatusTimelineResponse[]>;
|
|
5349
|
+
/**
|
|
5350
|
+
* Get incident counts aggregated by time bucket for case management processes.
|
|
5351
|
+
*
|
|
5352
|
+
* Returns time-grouped counts of incidents that occurred within each bucket,
|
|
5353
|
+
* useful for rendering incident time-series charts. Use `groupBy` to control
|
|
5354
|
+
* the time bucket size (hour, day, or week) — defaults to day if not provided.
|
|
5355
|
+
*
|
|
5356
|
+
* @param startTime - Start of the time range to query
|
|
5357
|
+
* @param endTime - End of the time range to query
|
|
5358
|
+
* @param options - Optional settings for filtering and time bucket granularity
|
|
5359
|
+
* @returns Promise resolving to an array of {@link IncidentTimelineResponse}
|
|
5360
|
+
*
|
|
5361
|
+
* @example
|
|
5362
|
+
* ```typescript
|
|
5363
|
+
* // Get daily incident counts for the last 7 days
|
|
5364
|
+
* const now = new Date();
|
|
5365
|
+
* const sevenDaysAgo = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
|
|
5366
|
+
* const incidents = await cases.getIncidentsTimeline(sevenDaysAgo, now);
|
|
5367
|
+
*
|
|
5368
|
+
* for (const incident of incidents) {
|
|
5369
|
+
* console.log(`${incident.startTime} → ${incident.endTime}: ${incident.count} incidents`);
|
|
5370
|
+
* }
|
|
5371
|
+
* ```
|
|
5372
|
+
*
|
|
5373
|
+
* @example
|
|
5374
|
+
* ```typescript
|
|
5375
|
+
* import { TimeInterval } from '@uipath/uipath-typescript/cases';
|
|
5376
|
+
*
|
|
5377
|
+
* // Get weekly breakdown
|
|
5378
|
+
* const incidents = await cases.getIncidentsTimeline(startTime, endTime, {
|
|
5379
|
+
* groupBy: TimeInterval.Week,
|
|
5380
|
+
* });
|
|
5381
|
+
* ```
|
|
5382
|
+
*
|
|
5383
|
+
* @example
|
|
5384
|
+
* ```typescript
|
|
5385
|
+
* // Filter to a specific case process
|
|
5386
|
+
* const filtered = await cases.getIncidentsTimeline(startTime, endTime, {
|
|
5387
|
+
* processKeys: ['<processKey>'],
|
|
5388
|
+
* });
|
|
5389
|
+
* ```
|
|
5390
|
+
*/
|
|
5391
|
+
getIncidentsTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<IncidentTimelineResponse[]>;
|
|
4674
5392
|
/**
|
|
4675
5393
|
* Get the top 5 case processes ranked by total duration within a time range.
|
|
4676
5394
|
*
|
|
@@ -4715,31 +5433,73 @@ interface CasesServiceModel {
|
|
|
4715
5433
|
* Returns per-element execution counts (success, fail, terminated, paused, in-progress) and
|
|
4716
5434
|
* duration percentile metrics (min, max, avg, p50, p95, p99) for BPMN elements within a case.
|
|
4717
5435
|
*
|
|
4718
|
-
* @param
|
|
4719
|
-
* @param packageId - Package identifier
|
|
4720
|
-
* @param startTime - Start of the time range to query
|
|
4721
|
-
* @param endTime - End of the time range to query
|
|
4722
|
-
* @param packageVersion - Package version to filter by
|
|
5436
|
+
* @param request - Process scope + time range to aggregate over
|
|
4723
5437
|
* @returns Promise resolving to an array of {@link ElementStats}
|
|
4724
5438
|
* @example
|
|
4725
5439
|
* ```typescript
|
|
4726
|
-
* //
|
|
4727
|
-
* const
|
|
4728
|
-
*
|
|
4729
|
-
*
|
|
4730
|
-
*
|
|
4731
|
-
*
|
|
4732
|
-
*
|
|
4733
|
-
*
|
|
5440
|
+
* // First, list cases to find the processKey, packageId, and available versions
|
|
5441
|
+
* const allCases = await cases.getAll();
|
|
5442
|
+
* const caseItem = allCases[0];
|
|
5443
|
+
*
|
|
5444
|
+
* // Get element metrics for that case
|
|
5445
|
+
* const elements = await cases.getElementStats({
|
|
5446
|
+
* processKey: caseItem.processKey,
|
|
5447
|
+
* packageId: caseItem.packageId,
|
|
5448
|
+
* packageVersion: caseItem.packageVersions[0],
|
|
5449
|
+
* startTime: new Date('2026-04-01'),
|
|
5450
|
+
* endTime: new Date(),
|
|
5451
|
+
* });
|
|
4734
5452
|
*
|
|
4735
5453
|
* // Find elements with failures
|
|
4736
5454
|
* const failedElements = elements.filter(e => e.failCount > 0);
|
|
4737
5455
|
* for (const element of failedElements) {
|
|
4738
5456
|
* console.log(`Failed element: ${element.elementId}, failures: ${element.failCount}`);
|
|
4739
5457
|
* }
|
|
5458
|
+
*
|
|
5459
|
+
* // Using bound method on a case — auto-fills processKey and packageId
|
|
5460
|
+
* const boundElements = await caseItem.getElementStats(
|
|
5461
|
+
* new Date('2026-04-01'),
|
|
5462
|
+
* new Date(),
|
|
5463
|
+
* caseItem.packageVersions[0]
|
|
5464
|
+
* );
|
|
5465
|
+
* ```
|
|
5466
|
+
*/
|
|
5467
|
+
getElementStats(request: MaestroProcessStatsRequest): Promise<ElementStats[]>;
|
|
5468
|
+
/**
|
|
5469
|
+
* Get instance stats for a case.
|
|
5470
|
+
*
|
|
5471
|
+
* Returns total instance counts broken down by status (running, completed, faulted, etc.)
|
|
5472
|
+
* and the average execution duration for all instances of a case within a time range.
|
|
5473
|
+
*
|
|
5474
|
+
* @param request - Process scope + time range to aggregate over
|
|
5475
|
+
* @returns Promise resolving to {@link InstanceStats}
|
|
5476
|
+
* @example
|
|
5477
|
+
* ```typescript
|
|
5478
|
+
* // First, list cases to find the processKey, packageId, and available versions
|
|
5479
|
+
* const allCases = await cases.getAll();
|
|
5480
|
+
* const caseItem = allCases[0];
|
|
5481
|
+
*
|
|
5482
|
+
* // Get instance status breakdown for that case
|
|
5483
|
+
* const counts = await cases.getInstanceStats({
|
|
5484
|
+
* processKey: caseItem.processKey,
|
|
5485
|
+
* packageId: caseItem.packageId,
|
|
5486
|
+
* packageVersion: caseItem.packageVersions[0],
|
|
5487
|
+
* startTime: new Date('2026-04-01'),
|
|
5488
|
+
* endTime: new Date(),
|
|
5489
|
+
* });
|
|
5490
|
+
*
|
|
5491
|
+
* console.log(`Total: ${counts.totalCount}`);
|
|
5492
|
+
* console.log(`Completed: ${counts.completedCount}, Faulted: ${counts.faultedCount}`);
|
|
5493
|
+
*
|
|
5494
|
+
* // Using bound method on a case — auto-fills processKey and packageId
|
|
5495
|
+
* const boundCounts = await caseItem.getInstanceStats(
|
|
5496
|
+
* new Date('2026-04-01'),
|
|
5497
|
+
* new Date(),
|
|
5498
|
+
* caseItem.packageVersions[0]
|
|
5499
|
+
* );
|
|
4740
5500
|
* ```
|
|
4741
5501
|
*/
|
|
4742
|
-
|
|
5502
|
+
getInstanceStats(request: MaestroProcessStatsRequest): Promise<InstanceStats>;
|
|
4743
5503
|
}
|
|
4744
5504
|
interface CaseMethods {
|
|
4745
5505
|
/**
|
|
@@ -4751,6 +5511,33 @@ interface CaseMethods {
|
|
|
4751
5511
|
* @returns Promise resolving to an array of {@link ElementStats}
|
|
4752
5512
|
*/
|
|
4753
5513
|
getElementStats(startTime: Date, endTime: Date, packageVersion: string): Promise<ElementStats[]>;
|
|
5514
|
+
/**
|
|
5515
|
+
* Get instance stats for this case
|
|
5516
|
+
*
|
|
5517
|
+
* @param startTime - Start of the time range to query
|
|
5518
|
+
* @param endTime - End of the time range to query
|
|
5519
|
+
* @param packageVersion - Package version to filter by
|
|
5520
|
+
* @returns Promise resolving to {@link InstanceStats}
|
|
5521
|
+
*/
|
|
5522
|
+
getInstanceStats(startTime: Date, endTime: Date, packageVersion: string): Promise<InstanceStats>;
|
|
5523
|
+
/**
|
|
5524
|
+
* Get instance status counts aggregated by date for this case process.
|
|
5525
|
+
*
|
|
5526
|
+
* @param startTime - Start of the time range to query
|
|
5527
|
+
* @param endTime - End of the time range to query
|
|
5528
|
+
* @param options - Optional settings for filtering and time bucket granularity (processKey is auto-captured from this case)
|
|
5529
|
+
* @returns Promise resolving to an array of {@link InstanceStatusTimelineResponse}
|
|
5530
|
+
*/
|
|
5531
|
+
getInstanceStatusTimeline(startTime: Date, endTime: Date, options?: Omit<TimelineOptions, 'processKeys'>): Promise<InstanceStatusTimelineResponse[]>;
|
|
5532
|
+
/**
|
|
5533
|
+
* Get incident counts aggregated by time bucket for this case process.
|
|
5534
|
+
*
|
|
5535
|
+
* @param startTime - Start of the time range to query
|
|
5536
|
+
* @param endTime - End of the time range to query
|
|
5537
|
+
* @param options - Optional settings for filtering and time bucket granularity (processKey is auto-captured from this case)
|
|
5538
|
+
* @returns Promise resolving to an array of {@link IncidentTimelineResponse}
|
|
5539
|
+
*/
|
|
5540
|
+
getIncidentsTimeline(startTime: Date, endTime: Date, options?: Omit<TimelineOptions, 'processKeys'>): Promise<IncidentTimelineResponse[]>;
|
|
4754
5541
|
}
|
|
4755
5542
|
type CaseGetAllWithMethodsResponse = CaseGetAllResponse & CaseMethods;
|
|
4756
5543
|
/**
|
|
@@ -6240,7 +7027,7 @@ declare class MaestroProcessesService extends BaseService implements MaestroProc
|
|
|
6240
7027
|
*
|
|
6241
7028
|
* @param startTime - Start of the time range to query
|
|
6242
7029
|
* @param endTime - End of the time range to query
|
|
6243
|
-
* @param options - Optional settings for time
|
|
7030
|
+
* @param options - Optional settings for filtering and time bucket granularity
|
|
6244
7031
|
* @returns Promise resolving to an array of {@link InstanceStatusTimelineResponse}
|
|
6245
7032
|
*
|
|
6246
7033
|
* @example
|
|
@@ -6267,11 +7054,62 @@ declare class MaestroProcessesService extends BaseService implements MaestroProc
|
|
|
6267
7054
|
*
|
|
6268
7055
|
* @example
|
|
6269
7056
|
* ```typescript
|
|
7057
|
+
* // Filter to a specific process
|
|
7058
|
+
* const filtered = await maestroProcesses.getInstanceStatusTimeline(startTime, endTime, {
|
|
7059
|
+
* processKeys: ['<processKey>'],
|
|
7060
|
+
* });
|
|
7061
|
+
* ```
|
|
7062
|
+
*
|
|
7063
|
+
* @example
|
|
7064
|
+
* ```typescript
|
|
6270
7065
|
* // Get all-time data (from Unix epoch to now)
|
|
6271
7066
|
* const allTime = await maestroProcesses.getInstanceStatusTimeline(new Date(0), new Date());
|
|
6272
7067
|
* ```
|
|
6273
7068
|
*/
|
|
6274
7069
|
getInstanceStatusTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<InstanceStatusTimelineResponse[]>;
|
|
7070
|
+
/**
|
|
7071
|
+
* Get incident counts aggregated by time bucket for maestro processes.
|
|
7072
|
+
*
|
|
7073
|
+
* Returns time-grouped counts of incidents that occurred within each bucket,
|
|
7074
|
+
* useful for rendering incident time-series charts. Use `groupBy` to control
|
|
7075
|
+
* the time bucket size (hour, day, or week) — defaults to day if not provided.
|
|
7076
|
+
*
|
|
7077
|
+
* @param startTime - Start of the time range to query
|
|
7078
|
+
* @param endTime - End of the time range to query
|
|
7079
|
+
* @param options - Optional settings for filtering and time bucket granularity
|
|
7080
|
+
* @returns Promise resolving to an array of {@link IncidentTimelineResponse}
|
|
7081
|
+
*
|
|
7082
|
+
* @example
|
|
7083
|
+
* ```typescript
|
|
7084
|
+
* // Get daily incident counts for the last 7 days
|
|
7085
|
+
* const now = new Date();
|
|
7086
|
+
* const sevenDaysAgo = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
|
|
7087
|
+
* const incidents = await maestroProcesses.getIncidentsTimeline(sevenDaysAgo, now);
|
|
7088
|
+
*
|
|
7089
|
+
* for (const incident of incidents) {
|
|
7090
|
+
* console.log(`${incident.startTime} → ${incident.endTime}: ${incident.count} incidents`);
|
|
7091
|
+
* }
|
|
7092
|
+
* ```
|
|
7093
|
+
*
|
|
7094
|
+
* @example
|
|
7095
|
+
* ```typescript
|
|
7096
|
+
* import { TimeInterval } from '@uipath/uipath-typescript/maestro-processes';
|
|
7097
|
+
*
|
|
7098
|
+
* // Get weekly breakdown
|
|
7099
|
+
* const incidents = await maestroProcesses.getIncidentsTimeline(startTime, endTime, {
|
|
7100
|
+
* groupBy: TimeInterval.Week,
|
|
7101
|
+
* });
|
|
7102
|
+
* ```
|
|
7103
|
+
*
|
|
7104
|
+
* @example
|
|
7105
|
+
* ```typescript
|
|
7106
|
+
* // Filter to a specific process
|
|
7107
|
+
* const filtered = await maestroProcesses.getIncidentsTimeline(startTime, endTime, {
|
|
7108
|
+
* processKeys: ['<processKey>'],
|
|
7109
|
+
* });
|
|
7110
|
+
* ```
|
|
7111
|
+
*/
|
|
7112
|
+
getIncidentsTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<IncidentTimelineResponse[]>;
|
|
6275
7113
|
/**
|
|
6276
7114
|
* Get the top 10 processes ranked by failure count within a time range.
|
|
6277
7115
|
*
|
|
@@ -6354,32 +7192,75 @@ declare class MaestroProcessesService extends BaseService implements MaestroProc
|
|
|
6354
7192
|
* Returns per-element execution counts (success, fail, terminated, paused, in-progress) and
|
|
6355
7193
|
* duration percentile metrics (min, max, avg, p50, p95, p99) for BPMN elements within a process.
|
|
6356
7194
|
*
|
|
6357
|
-
* @param
|
|
6358
|
-
* @param packageId - Package identifier
|
|
6359
|
-
* @param startTime - Start of the time range to query
|
|
6360
|
-
* @param endTime - End of the time range to query
|
|
6361
|
-
* @param packageVersion - Package version to filter by
|
|
7195
|
+
* @param request - Process scope + time range to aggregate over
|
|
6362
7196
|
* @returns Promise resolving to an array of {@link ElementStats}
|
|
6363
7197
|
* @example
|
|
6364
7198
|
* ```typescript
|
|
6365
|
-
* //
|
|
6366
|
-
* const
|
|
6367
|
-
*
|
|
6368
|
-
*
|
|
7199
|
+
* // First, list processes to find the processKey, packageId, and available versions
|
|
7200
|
+
* const processes = await maestroProcesses.getAll();
|
|
7201
|
+
* const process = processes[0];
|
|
7202
|
+
*
|
|
7203
|
+
* // Get element metrics for that process
|
|
7204
|
+
* const elements = await maestroProcesses.getElementStats({
|
|
7205
|
+
* processKey: process.processKey,
|
|
7206
|
+
* packageId: process.packageId,
|
|
7207
|
+
* packageVersion: process.packageVersions[0],
|
|
7208
|
+
* startTime: new Date('2026-04-01'),
|
|
7209
|
+
* endTime: new Date(),
|
|
7210
|
+
* });
|
|
7211
|
+
*
|
|
7212
|
+
* // Analyze element performance
|
|
7213
|
+
* for (const element of elements) {
|
|
7214
|
+
* console.log(`Element: ${element.elementId}`);
|
|
7215
|
+
* console.log(` Success: ${element.successCount}, Failed: ${element.failCount}`);
|
|
7216
|
+
* console.log(` Avg duration: ${element.avgDurationMs}ms, P95: ${element.p95DurationMs}ms`);
|
|
7217
|
+
* }
|
|
7218
|
+
*
|
|
7219
|
+
* // Using bound method on a process — auto-fills processKey and packageId
|
|
7220
|
+
* const boundElements = await process.getElementStats(
|
|
7221
|
+
* new Date('2026-04-01'),
|
|
7222
|
+
* new Date(),
|
|
7223
|
+
* process.packageVersions[0]
|
|
7224
|
+
* );
|
|
7225
|
+
* ```
|
|
7226
|
+
*/
|
|
7227
|
+
getElementStats(request: MaestroProcessStatsRequest): Promise<ElementStats[]>;
|
|
7228
|
+
/**
|
|
7229
|
+
* Get instance stats for a process.
|
|
7230
|
+
*
|
|
7231
|
+
* Returns total instance counts broken down by status (running, completed, faulted, etc.)
|
|
7232
|
+
* and the average execution duration for all instances of a process within a time range.
|
|
7233
|
+
*
|
|
7234
|
+
* @param request - Process scope + time range to aggregate over
|
|
7235
|
+
* @returns Promise resolving to {@link InstanceStats}
|
|
7236
|
+
* @example
|
|
7237
|
+
* ```typescript
|
|
7238
|
+
* // First, list processes to find the processKey, packageId, and available versions
|
|
7239
|
+
* const processes = await maestroProcesses.getAll();
|
|
7240
|
+
* const process = processes[0];
|
|
7241
|
+
*
|
|
7242
|
+
* // Get instance status breakdown for that process
|
|
7243
|
+
* const counts = await maestroProcesses.getInstanceStats({
|
|
7244
|
+
* processKey: process.processKey,
|
|
7245
|
+
* packageId: process.packageId,
|
|
7246
|
+
* packageVersion: process.packageVersions[0],
|
|
7247
|
+
* startTime: new Date('2026-04-01'),
|
|
7248
|
+
* endTime: new Date(),
|
|
7249
|
+
* });
|
|
7250
|
+
*
|
|
7251
|
+
* console.log(`Total: ${counts.totalCount}`);
|
|
7252
|
+
* console.log(`Running: ${counts.runningCount}, Completed: ${counts.completedCount}`);
|
|
7253
|
+
* console.log(`Faulted: ${counts.faultedCount}, Avg duration: ${counts.avgDurationMs}ms`);
|
|
7254
|
+
*
|
|
7255
|
+
* // Using bound method on a process — auto-fills processKey and packageId
|
|
7256
|
+
* const boundCounts = await process.getInstanceStats(
|
|
6369
7257
|
* new Date('2026-04-01'),
|
|
6370
7258
|
* new Date(),
|
|
6371
|
-
*
|
|
7259
|
+
* process.packageVersions[0]
|
|
6372
7260
|
* );
|
|
6373
|
-
*
|
|
6374
|
-
* // Analyze element performance
|
|
6375
|
-
* for (const element of elements) {
|
|
6376
|
-
* console.log(`Element: ${element.elementId}`);
|
|
6377
|
-
* console.log(` Success: ${element.successCount}, Failed: ${element.failCount}`);
|
|
6378
|
-
* console.log(` Avg duration: ${element.avgDurationMs}ms, P95: ${element.p95DurationMs}ms`);
|
|
6379
|
-
* }
|
|
6380
7261
|
* ```
|
|
6381
7262
|
*/
|
|
6382
|
-
|
|
7263
|
+
getInstanceStats(request: MaestroProcessStatsRequest): Promise<InstanceStats>;
|
|
6383
7264
|
}
|
|
6384
7265
|
|
|
6385
7266
|
declare class ProcessInstancesService extends BaseService implements ProcessInstancesServiceModel {
|
|
@@ -6425,7 +7306,7 @@ declare class ProcessInstancesService extends BaseService implements ProcessInst
|
|
|
6425
7306
|
*/
|
|
6426
7307
|
getAll<T extends ProcessInstanceGetAllWithPaginationOptions = ProcessInstanceGetAllWithPaginationOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ProcessInstanceGetResponse> : NonPaginatedResponse<ProcessInstanceGetResponse>>;
|
|
6427
7308
|
/**
|
|
6428
|
-
* Get a process instance by ID with operation methods (cancel, pause, resume)
|
|
7309
|
+
* Get a process instance by ID with operation methods (cancel, pause, resume, retry)
|
|
6429
7310
|
* @param id The ID of the instance to retrieve
|
|
6430
7311
|
* @param folderKey The folder key for authorization
|
|
6431
7312
|
* @returns Promise<ProcessInstanceGetResponse>
|
|
@@ -6486,6 +7367,17 @@ declare class ProcessInstancesService extends BaseService implements ProcessInst
|
|
|
6486
7367
|
* @returns Promise resolving to operation result with updated instance data
|
|
6487
7368
|
*/
|
|
6488
7369
|
resume(instanceId: string, folderKey: string, options?: ProcessInstanceOperationOptions): Promise<OperationResponse<ProcessInstanceOperationResponse>>;
|
|
7370
|
+
/**
|
|
7371
|
+
* Retry a faulted process instance
|
|
7372
|
+
*
|
|
7373
|
+
* Re-runs the failed elements of the instance (and the elements that follow) within
|
|
7374
|
+
* the same instance, spawning new jobs. Use to recover from transient/flaky failures.
|
|
7375
|
+
* @param instanceId The ID of the instance to retry
|
|
7376
|
+
* @param folderKey The folder key for authorization
|
|
7377
|
+
* @param options Optional retry options with comment
|
|
7378
|
+
* @returns Promise resolving to operation result with updated instance data
|
|
7379
|
+
*/
|
|
7380
|
+
retry(instanceId: string, folderKey: string, options?: ProcessInstanceOperationOptions): Promise<OperationResponse<ProcessInstanceOperationResponse>>;
|
|
6489
7381
|
/**
|
|
6490
7382
|
* Parses BPMN XML to extract variable metadata from uipath:inputOutput elements
|
|
6491
7383
|
* @private
|
|
@@ -6662,7 +7554,7 @@ declare class CasesService extends BaseService implements CasesServiceModel {
|
|
|
6662
7554
|
*
|
|
6663
7555
|
* @param startTime - Start of the time range to query
|
|
6664
7556
|
* @param endTime - End of the time range to query
|
|
6665
|
-
* @param options - Optional settings for time
|
|
7557
|
+
* @param options - Optional settings for filtering and time bucket granularity
|
|
6666
7558
|
* @returns Promise resolving to an array of {@link InstanceStatusTimelineResponse}
|
|
6667
7559
|
*
|
|
6668
7560
|
* @example
|
|
@@ -6689,11 +7581,62 @@ declare class CasesService extends BaseService implements CasesServiceModel {
|
|
|
6689
7581
|
*
|
|
6690
7582
|
* @example
|
|
6691
7583
|
* ```typescript
|
|
7584
|
+
* // Filter to a specific case process
|
|
7585
|
+
* const filtered = await cases.getInstanceStatusTimeline(startTime, endTime, {
|
|
7586
|
+
* processKeys: ['<processKey>'],
|
|
7587
|
+
* });
|
|
7588
|
+
* ```
|
|
7589
|
+
*
|
|
7590
|
+
* @example
|
|
7591
|
+
* ```typescript
|
|
6692
7592
|
* // Get all-time data (from Unix epoch to now)
|
|
6693
7593
|
* const allTime = await cases.getInstanceStatusTimeline(new Date(0), new Date());
|
|
6694
7594
|
* ```
|
|
6695
7595
|
*/
|
|
6696
7596
|
getInstanceStatusTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<InstanceStatusTimelineResponse[]>;
|
|
7597
|
+
/**
|
|
7598
|
+
* Get incident counts aggregated by time bucket for case management processes.
|
|
7599
|
+
*
|
|
7600
|
+
* Returns time-grouped counts of incidents that occurred within each bucket,
|
|
7601
|
+
* useful for rendering incident time-series charts. Use `groupBy` to control
|
|
7602
|
+
* the time bucket size (hour, day, or week) — defaults to day if not provided.
|
|
7603
|
+
*
|
|
7604
|
+
* @param startTime - Start of the time range to query
|
|
7605
|
+
* @param endTime - End of the time range to query
|
|
7606
|
+
* @param options - Optional settings for filtering and time bucket granularity
|
|
7607
|
+
* @returns Promise resolving to an array of {@link IncidentTimelineResponse}
|
|
7608
|
+
*
|
|
7609
|
+
* @example
|
|
7610
|
+
* ```typescript
|
|
7611
|
+
* // Get daily incident counts for the last 7 days
|
|
7612
|
+
* const now = new Date();
|
|
7613
|
+
* const sevenDaysAgo = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
|
|
7614
|
+
* const incidents = await cases.getIncidentsTimeline(sevenDaysAgo, now);
|
|
7615
|
+
*
|
|
7616
|
+
* for (const incident of incidents) {
|
|
7617
|
+
* console.log(`${incident.startTime} → ${incident.endTime}: ${incident.count} incidents`);
|
|
7618
|
+
* }
|
|
7619
|
+
* ```
|
|
7620
|
+
*
|
|
7621
|
+
* @example
|
|
7622
|
+
* ```typescript
|
|
7623
|
+
* import { TimeInterval } from '@uipath/uipath-typescript/cases';
|
|
7624
|
+
*
|
|
7625
|
+
* // Get weekly breakdown
|
|
7626
|
+
* const incidents = await cases.getIncidentsTimeline(startTime, endTime, {
|
|
7627
|
+
* groupBy: TimeInterval.Week,
|
|
7628
|
+
* });
|
|
7629
|
+
* ```
|
|
7630
|
+
*
|
|
7631
|
+
* @example
|
|
7632
|
+
* ```typescript
|
|
7633
|
+
* // Filter to a specific case process
|
|
7634
|
+
* const filtered = await cases.getIncidentsTimeline(startTime, endTime, {
|
|
7635
|
+
* processKeys: ['<processKey>'],
|
|
7636
|
+
* });
|
|
7637
|
+
* ```
|
|
7638
|
+
*/
|
|
7639
|
+
getIncidentsTimeline(startTime: Date, endTime: Date, options?: TimelineOptions): Promise<IncidentTimelineResponse[]>;
|
|
6697
7640
|
/**
|
|
6698
7641
|
* Get the top 10 case processes ranked by failure count within a time range.
|
|
6699
7642
|
*
|
|
@@ -6776,31 +7719,73 @@ declare class CasesService extends BaseService implements CasesServiceModel {
|
|
|
6776
7719
|
* Returns per-element execution counts (success, fail, terminated, paused, in-progress) and
|
|
6777
7720
|
* duration percentile metrics (min, max, avg, p50, p95, p99) for BPMN elements within a case.
|
|
6778
7721
|
*
|
|
6779
|
-
* @param
|
|
6780
|
-
* @param packageId - Package identifier
|
|
6781
|
-
* @param startTime - Start of the time range to query
|
|
6782
|
-
* @param endTime - End of the time range to query
|
|
6783
|
-
* @param packageVersion - Package version to filter by
|
|
7722
|
+
* @param request - Process scope + time range to aggregate over
|
|
6784
7723
|
* @returns Promise resolving to an array of {@link ElementStats}
|
|
6785
7724
|
* @example
|
|
6786
7725
|
* ```typescript
|
|
6787
|
-
* //
|
|
6788
|
-
* const
|
|
6789
|
-
*
|
|
6790
|
-
*
|
|
6791
|
-
*
|
|
6792
|
-
*
|
|
6793
|
-
*
|
|
6794
|
-
*
|
|
7726
|
+
* // First, list cases to find the processKey, packageId, and available versions
|
|
7727
|
+
* const allCases = await cases.getAll();
|
|
7728
|
+
* const caseItem = allCases[0];
|
|
7729
|
+
*
|
|
7730
|
+
* // Get element metrics for that case
|
|
7731
|
+
* const elements = await cases.getElementStats({
|
|
7732
|
+
* processKey: caseItem.processKey,
|
|
7733
|
+
* packageId: caseItem.packageId,
|
|
7734
|
+
* packageVersion: caseItem.packageVersions[0],
|
|
7735
|
+
* startTime: new Date('2026-04-01'),
|
|
7736
|
+
* endTime: new Date(),
|
|
7737
|
+
* });
|
|
6795
7738
|
*
|
|
6796
7739
|
* // Find elements with failures
|
|
6797
7740
|
* const failedElements = elements.filter(e => e.failCount > 0);
|
|
6798
7741
|
* for (const element of failedElements) {
|
|
6799
7742
|
* console.log(`Failed element: ${element.elementId}, failures: ${element.failCount}`);
|
|
6800
7743
|
* }
|
|
7744
|
+
*
|
|
7745
|
+
* // Using bound method on a case — auto-fills processKey and packageId
|
|
7746
|
+
* const boundElements = await caseItem.getElementStats(
|
|
7747
|
+
* new Date('2026-04-01'),
|
|
7748
|
+
* new Date(),
|
|
7749
|
+
* caseItem.packageVersions[0]
|
|
7750
|
+
* );
|
|
6801
7751
|
* ```
|
|
6802
7752
|
*/
|
|
6803
|
-
getElementStats(
|
|
7753
|
+
getElementStats(request: MaestroProcessStatsRequest): Promise<ElementStats[]>;
|
|
7754
|
+
/**
|
|
7755
|
+
* Get instance stats for a case.
|
|
7756
|
+
*
|
|
7757
|
+
* Returns total instance counts broken down by status (running, completed, faulted, etc.)
|
|
7758
|
+
* and the average execution duration for all instances of a case within a time range.
|
|
7759
|
+
*
|
|
7760
|
+
* @param request - Process scope + time range to aggregate over
|
|
7761
|
+
* @returns Promise resolving to {@link InstanceStats}
|
|
7762
|
+
* @example
|
|
7763
|
+
* ```typescript
|
|
7764
|
+
* // First, list cases to find the processKey, packageId, and available versions
|
|
7765
|
+
* const allCases = await cases.getAll();
|
|
7766
|
+
* const caseItem = allCases[0];
|
|
7767
|
+
*
|
|
7768
|
+
* // Get instance status breakdown for that case
|
|
7769
|
+
* const counts = await cases.getInstanceStats({
|
|
7770
|
+
* processKey: caseItem.processKey,
|
|
7771
|
+
* packageId: caseItem.packageId,
|
|
7772
|
+
* packageVersion: caseItem.packageVersions[0],
|
|
7773
|
+
* startTime: new Date('2026-04-01'),
|
|
7774
|
+
* endTime: new Date(),
|
|
7775
|
+
* });
|
|
7776
|
+
*
|
|
7777
|
+
* console.log(`Total: ${counts.totalCount}`);
|
|
7778
|
+
* console.log(`Completed: ${counts.completedCount}, Faulted: ${counts.faultedCount}`);
|
|
7779
|
+
*
|
|
7780
|
+
* // Using bound method on a case — auto-fills processKey and packageId
|
|
7781
|
+
* const boundCounts = await caseItem.getInstanceStats(
|
|
7782
|
+
* new Date('2026-04-01'),
|
|
7783
|
+
* new Date(),
|
|
7784
|
+
* caseItem.packageVersions[0]
|
|
7785
|
+
* );
|
|
7786
|
+
* ```
|
|
7787
|
+
*/
|
|
7788
|
+
getInstanceStats(request: MaestroProcessStatsRequest): Promise<InstanceStats>;
|
|
6804
7789
|
/**
|
|
6805
7790
|
* Extract a readable case name from the packageId
|
|
6806
7791
|
* @param packageId - The full package identifier
|
|
@@ -7058,6 +8043,14 @@ declare class CaseInstancesService extends BaseService implements CaseInstancesS
|
|
|
7058
8043
|
getStagesSlaSummary(options?: CaseInstanceStageSLAOptions): Promise<CaseInstanceStageSLAResponse[]>;
|
|
7059
8044
|
}
|
|
7060
8045
|
|
|
8046
|
+
/**
|
|
8047
|
+
* Type for field mapping configuration
|
|
8048
|
+
* Maps source field names to target field names
|
|
8049
|
+
*/
|
|
8050
|
+
type FieldMapping = {
|
|
8051
|
+
[sourceField: string]: string;
|
|
8052
|
+
};
|
|
8053
|
+
|
|
7061
8054
|
/**
|
|
7062
8055
|
* Base service for services that need folder-specific functionality.
|
|
7063
8056
|
*
|
|
@@ -7099,9 +8092,12 @@ declare class FolderScopedService extends BaseService {
|
|
|
7099
8092
|
* @param name - Resource name to search for
|
|
7100
8093
|
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) + OData query options (`expand`, `select`)
|
|
7101
8094
|
* @param transform - Maps a raw OData item to the typed response (e.g. PascalCase → camelCase via field map)
|
|
8095
|
+
* @param responseFieldMap - Optional response field map (API → SDK), reversed internally by
|
|
8096
|
+
* `transformOptions` to rewrite SDK field names back to API names in user-supplied
|
|
8097
|
+
* `expand` / `select` (symmetric counterpart to `transform`)
|
|
7102
8098
|
* @throws ValidationError when inputs are malformed; NotFoundError when no match
|
|
7103
8099
|
*/
|
|
7104
|
-
protected getByNameLookup<TRaw extends object, T>(resourceType: string, endpoint: string, name: string, options: FolderScopedOptions, transform: (raw: TRaw) => T): Promise<T>;
|
|
8100
|
+
protected getByNameLookup<TRaw extends object, T>(resourceType: string, endpoint: string, name: string, options: FolderScopedOptions, transform: (raw: TRaw) => T, responseFieldMap?: FieldMapping): Promise<T>;
|
|
7105
8101
|
}
|
|
7106
8102
|
|
|
7107
8103
|
/**
|
|
@@ -8525,6 +9521,8 @@ interface ProcessStartResponse extends ProcessProperties, FolderProperties {
|
|
|
8525
9521
|
createdTime: string;
|
|
8526
9522
|
startingScheduleId: number | null;
|
|
8527
9523
|
processName: string;
|
|
9524
|
+
/** Key of the process this job was started from. */
|
|
9525
|
+
processKey: string;
|
|
8528
9526
|
type: JobType;
|
|
8529
9527
|
inputFile: string | null;
|
|
8530
9528
|
outputArguments: string | null;
|
|
@@ -8824,8 +9822,9 @@ interface JobServiceModel {
|
|
|
8824
9822
|
* const folderJobs = await jobs.getAll({ folderId: <folderId> });
|
|
8825
9823
|
*
|
|
8826
9824
|
* // With filtering
|
|
8827
|
-
* const
|
|
8828
|
-
* filter: "
|
|
9825
|
+
* const recentInvoiceJobs = await jobs.getAll({
|
|
9826
|
+
* filter: "processName eq 'InvoiceBot'",
|
|
9827
|
+
* orderby: 'createdTime desc',
|
|
8829
9828
|
* });
|
|
8830
9829
|
*
|
|
8831
9830
|
* // First page with pagination
|
|
@@ -9974,6 +10973,18 @@ declare class UiPath extends UiPath$1 {
|
|
|
9974
10973
|
* Access to ChoiceSet service for managing choice sets
|
|
9975
10974
|
*/
|
|
9976
10975
|
choicesets: ChoiceSetService;
|
|
10976
|
+
/**
|
|
10977
|
+
* Access to Data Fabric roles for manage-access flows
|
|
10978
|
+
*
|
|
10979
|
+
* @internal
|
|
10980
|
+
*/
|
|
10981
|
+
roles: DataFabricRoleService;
|
|
10982
|
+
/**
|
|
10983
|
+
* Access to Data Fabric directory principals and role assignments
|
|
10984
|
+
*
|
|
10985
|
+
* @internal
|
|
10986
|
+
*/
|
|
10987
|
+
directory: DataFabricDirectoryService;
|
|
9977
10988
|
};
|
|
9978
10989
|
/**
|
|
9979
10990
|
* Access to Tasks service
|
|
@@ -11104,6 +12115,16 @@ interface SessionEndingEvent {
|
|
|
11104
12115
|
*/
|
|
11105
12116
|
timeToLiveMS: number;
|
|
11106
12117
|
}
|
|
12118
|
+
/**
|
|
12119
|
+
* A client-side tool that the client supports, declared during exchange start
|
|
12120
|
+
* so the server knows which tools to route client-side.
|
|
12121
|
+
* @internal
|
|
12122
|
+
*/
|
|
12123
|
+
interface ClientSideTool {
|
|
12124
|
+
name: string;
|
|
12125
|
+
inputSchema?: JSONValue;
|
|
12126
|
+
outputSchema?: JSONValue;
|
|
12127
|
+
}
|
|
11107
12128
|
/**
|
|
11108
12129
|
* Signals the start of an exchange of messages within a conversation.
|
|
11109
12130
|
*/
|
|
@@ -11120,6 +12141,12 @@ interface ExchangeStartEvent {
|
|
|
11120
12141
|
* The time the exchange started.
|
|
11121
12142
|
*/
|
|
11122
12143
|
timestamp?: string;
|
|
12144
|
+
/**
|
|
12145
|
+
* Optional list of client-side tools the client supports. The server validates these against the agent's
|
|
12146
|
+
* design-time definitions and forwards them to the runtime so it knows which tools to route client-side.
|
|
12147
|
+
* @internal
|
|
12148
|
+
*/
|
|
12149
|
+
clientSideTools?: ClientSideTool[];
|
|
11123
12150
|
}
|
|
11124
12151
|
/**
|
|
11125
12152
|
* Signals the end of an exchange of messages within a conversation.
|
|
@@ -11373,6 +12400,16 @@ interface ToolCallStartEvent {
|
|
|
11373
12400
|
* `requireConfirmation` is true so the client can render an editable form.
|
|
11374
12401
|
*/
|
|
11375
12402
|
inputSchema?: JSONValue;
|
|
12403
|
+
/**
|
|
12404
|
+
* Output schema — used by the client to render the result form for client-side tools.
|
|
12405
|
+
* @internal
|
|
12406
|
+
*/
|
|
12407
|
+
outputSchema?: JSONValue;
|
|
12408
|
+
/**
|
|
12409
|
+
* Indicates this tool call should be executed client-side rather than server-side.
|
|
12410
|
+
* @internal
|
|
12411
|
+
*/
|
|
12412
|
+
isClientSideTool?: boolean;
|
|
11376
12413
|
}
|
|
11377
12414
|
/**
|
|
11378
12415
|
* Sent by the client to approve or reject a tool call that was emitted with
|
|
@@ -11415,6 +12452,20 @@ interface ToolCallEndEvent {
|
|
|
11415
12452
|
*/
|
|
11416
12453
|
metaData?: MetaData;
|
|
11417
12454
|
}
|
|
12455
|
+
/**
|
|
12456
|
+
* Signals to the client that the tool is about to be executed. Emitted in all scenarios
|
|
12457
|
+
* (server-side and client-side tools). For client-side tools, the client should begin
|
|
12458
|
+
* executing its registered handler upon receiving this event.
|
|
12459
|
+
* @internal
|
|
12460
|
+
*/
|
|
12461
|
+
interface ExecutingToolCallEvent {
|
|
12462
|
+
/**
|
|
12463
|
+
* The time the tool call began executing.
|
|
12464
|
+
*/
|
|
12465
|
+
timestamp?: string;
|
|
12466
|
+
/** The final tool input, reflecting any modifications made during tool-call confirmation. */
|
|
12467
|
+
input?: ToolCallInputValue;
|
|
12468
|
+
}
|
|
11418
12469
|
/**
|
|
11419
12470
|
* Allows additional events to be sent in the context of the enclosing event stream.
|
|
11420
12471
|
*/
|
|
@@ -11455,6 +12506,12 @@ interface ToolCallEvent {
|
|
|
11455
12506
|
* emitted with `requireConfirmation: true`.
|
|
11456
12507
|
*/
|
|
11457
12508
|
confirmToolCall?: ToolCallConfirmationEvent;
|
|
12509
|
+
/**
|
|
12510
|
+
* Signals that the tool is about to be executed. For client-side tools,
|
|
12511
|
+
* the client should begin executing its handler upon receiving this event.
|
|
12512
|
+
* @internal
|
|
12513
|
+
*/
|
|
12514
|
+
executingToolCall?: ExecutingToolCallEvent;
|
|
11458
12515
|
/**
|
|
11459
12516
|
* Allows additional events to be sent in the context of the enclosing event stream.
|
|
11460
12517
|
*/
|
|
@@ -12133,6 +13190,19 @@ type CompletedToolCall = ToolCallStartEvent & ToolCallEndEvent & {
|
|
|
12133
13190
|
* }
|
|
12134
13191
|
* });
|
|
12135
13192
|
* ```
|
|
13193
|
+
*
|
|
13194
|
+
* @example Handling client-side tool execution
|
|
13195
|
+
* ```typescript
|
|
13196
|
+
* message.onToolCallStart((toolCall) => {
|
|
13197
|
+
* const { isClientSideTool, toolName } = toolCall.startEvent;
|
|
13198
|
+
* if (!isClientSideTool) return;
|
|
13199
|
+
*
|
|
13200
|
+
* toolCall.onExecutingToolCall(async (event) => {
|
|
13201
|
+
* const result = await runLocalProcess(toolName, event.input);
|
|
13202
|
+
* toolCall.sendToolCallEnd({ output: result });
|
|
13203
|
+
* });
|
|
13204
|
+
* });
|
|
13205
|
+
* ```
|
|
12136
13206
|
*/
|
|
12137
13207
|
interface ToolCallStream {
|
|
12138
13208
|
/** Unique identifier for this tool call */
|
|
@@ -12204,6 +13274,24 @@ interface ToolCallStream {
|
|
|
12204
13274
|
* ```
|
|
12205
13275
|
*/
|
|
12206
13276
|
onToolCallConfirm(callback: (confirmToolCall: ToolCallConfirmationEvent) => void): () => void;
|
|
13277
|
+
/**
|
|
13278
|
+
* Registers a handler for executingToolCall events. Fired when the tool is about
|
|
13279
|
+
* to be executed. For client-side tools, the client should begin executing its
|
|
13280
|
+
* handler upon receiving this event.
|
|
13281
|
+
*
|
|
13282
|
+
* @param cb - Callback receiving the executing event
|
|
13283
|
+
* @returns Cleanup function to remove the handler
|
|
13284
|
+
*
|
|
13285
|
+
* @example Handling client-side tool execution
|
|
13286
|
+
* ```typescript
|
|
13287
|
+
* toolCall.onExecutingToolCall(async (event) => {
|
|
13288
|
+
* const result = await executeLocally(toolCall.startEvent.toolName, event.input);
|
|
13289
|
+
* toolCall.sendToolCallEnd({ output: result });
|
|
13290
|
+
* });
|
|
13291
|
+
* ```
|
|
13292
|
+
* @internal
|
|
13293
|
+
*/
|
|
13294
|
+
onExecutingToolCall(cb: (event: ExecutingToolCallEvent) => void): () => void;
|
|
12207
13295
|
/**
|
|
12208
13296
|
* Ends the tool call
|
|
12209
13297
|
*
|
|
@@ -13235,12 +14323,23 @@ interface ExchangeStream {
|
|
|
13235
14323
|
*/
|
|
13236
14324
|
getMessage(messageId: string): MessageStream | undefined;
|
|
13237
14325
|
/**
|
|
13238
|
-
* Ends the exchange
|
|
14326
|
+
* Ends the exchange. Stops further events for that exchange from being received.
|
|
14327
|
+
* Use this to stop an in-progress agent response from the client side.
|
|
13239
14328
|
*
|
|
13240
14329
|
* @param endExchange - Optional end event data
|
|
13241
14330
|
*
|
|
13242
|
-
* @example Manually ending an exchange
|
|
14331
|
+
* @example Manually ending an exchange and stopping a response mid-stream
|
|
14332
|
+
* ```typescript
|
|
14333
|
+
* session.onExchangeStart((exchange) => {
|
|
14334
|
+
* stopButton.addEventListener('click', () => exchange.sendExchangeEnd());
|
|
14335
|
+
* });
|
|
14336
|
+
* ```
|
|
14337
|
+
*
|
|
14338
|
+
* @example End an exchange after sending a message
|
|
13243
14339
|
* ```typescript
|
|
14340
|
+
* const exchange = session.startExchange();
|
|
14341
|
+
* exchange.sendMessageWithContentPart({ data: 'Hello!' });
|
|
14342
|
+
* // Later, stop the response
|
|
13244
14343
|
* exchange.sendExchangeEnd();
|
|
13245
14344
|
* ```
|
|
13246
14345
|
*/
|
|
@@ -15047,6 +16146,7 @@ type FeatureFlags = Record<string, unknown>;
|
|
|
15047
16146
|
* S -->|onExchangeStart| E["ExchangeStream"]
|
|
15048
16147
|
* S -->|onSessionEnd| SE(["session closed"])
|
|
15049
16148
|
* E -->|onMessageStart| M["MessageStream"]
|
|
16149
|
+
* E -->|sendExchangeEnd| STOP(["stop response"])
|
|
15050
16150
|
* E -->|onExchangeEnd| EE(["exchange complete"])
|
|
15051
16151
|
* M -->|onContentPartStart| CP["ContentPartStream"]
|
|
15052
16152
|
* M -->|onToolCallStart| TC["ToolCallStream"]
|
|
@@ -15090,10 +16190,20 @@ type FeatureFlags = Record<string, unknown>;
|
|
|
15090
16190
|
* exchange.sendMessageWithContentPart({ data: 'Hello!' });
|
|
15091
16191
|
* });
|
|
15092
16192
|
*
|
|
15093
|
-
* // 5.
|
|
16193
|
+
* // 5. Stop a response mid-stream
|
|
16194
|
+
* // Use sendExchangeEnd() on any active exchange to stop the agent
|
|
16195
|
+
* session.onSessionStarted(() => {
|
|
16196
|
+
* const exchange = session.startExchange();
|
|
16197
|
+
* exchange.sendMessageWithContentPart({ data: 'Tell me a long story' });
|
|
16198
|
+
*
|
|
16199
|
+
* // Stop after 5 seconds
|
|
16200
|
+
* setTimeout(() => exchange.sendExchangeEnd(), 5000);
|
|
16201
|
+
* });
|
|
16202
|
+
*
|
|
16203
|
+
* // 6. End session when done
|
|
15094
16204
|
* conversation.endSession();
|
|
15095
16205
|
*
|
|
15096
|
-
* //
|
|
16206
|
+
* // 7. Retrieve conversation history (offline)
|
|
15097
16207
|
* const exchanges = await conversation.exchanges.getAll();
|
|
15098
16208
|
* ```
|
|
15099
16209
|
*/
|
|
@@ -15638,9 +16748,9 @@ declare enum AgentListSortColumn {
|
|
|
15638
16748
|
HealthScore = "HealthScore",
|
|
15639
16749
|
LastIncident = "LastIncident",
|
|
15640
16750
|
FolderName = "FolderName",
|
|
15641
|
-
/** Quantity of
|
|
16751
|
+
/** Quantity of Agent Units consumed */
|
|
15642
16752
|
QuantityAGU = "QuantityAGU",
|
|
15643
|
-
/** Quantity of
|
|
16753
|
+
/** Quantity of Platform Units consumed */
|
|
15644
16754
|
QuantityPLTU = "QuantityPLTU",
|
|
15645
16755
|
FolderPath = "FolderPath"
|
|
15646
16756
|
}
|
|
@@ -15650,7 +16760,10 @@ declare enum AgentListSortColumn {
|
|
|
15650
16760
|
interface AgentListOrderBy {
|
|
15651
16761
|
/** Column to sort by */
|
|
15652
16762
|
column: AgentListSortColumn;
|
|
15653
|
-
/**
|
|
16763
|
+
/**
|
|
16764
|
+
* Sort descending.
|
|
16765
|
+
* @default false
|
|
16766
|
+
*/
|
|
15654
16767
|
desc?: boolean;
|
|
15655
16768
|
}
|
|
15656
16769
|
/**
|
|
@@ -15684,9 +16797,9 @@ interface AgentListItem {
|
|
|
15684
16797
|
unitsQuantity: number;
|
|
15685
16798
|
/** Display name of the units (if any). May be `null` or `""`. */
|
|
15686
16799
|
unitsName: string | null;
|
|
15687
|
-
/** Quantity of
|
|
16800
|
+
/** Quantity of Agent Units consumed by this agent */
|
|
15688
16801
|
quantityAGU: number;
|
|
15689
|
-
/** Quantity of
|
|
16802
|
+
/** Quantity of Platform Units consumed by this agent */
|
|
15690
16803
|
quantityPLTU: number;
|
|
15691
16804
|
}
|
|
15692
16805
|
/**
|
|
@@ -15741,7 +16854,10 @@ declare enum AgentErrorSortColumn {
|
|
|
15741
16854
|
interface AgentErrorOrderBy {
|
|
15742
16855
|
/** Column to sort by */
|
|
15743
16856
|
column: AgentErrorSortColumn;
|
|
15744
|
-
/**
|
|
16857
|
+
/**
|
|
16858
|
+
* Sort descending.
|
|
16859
|
+
* @default false
|
|
16860
|
+
*/
|
|
15745
16861
|
desc?: boolean;
|
|
15746
16862
|
}
|
|
15747
16863
|
/**
|
|
@@ -15802,40 +16918,333 @@ interface AgentGetErrorsTimelineResponse {
|
|
|
15802
16918
|
* Options for getting the agent errors timeline.
|
|
15803
16919
|
*/
|
|
15804
16920
|
interface AgentGetErrorsTimelineOptions extends AgentFilterOptions {
|
|
15805
|
-
/**
|
|
16921
|
+
/**
|
|
16922
|
+
* Max number of agents to return.
|
|
16923
|
+
* @default 10
|
|
16924
|
+
*/
|
|
16925
|
+
limit?: number;
|
|
16926
|
+
}
|
|
16927
|
+
/**
|
|
16928
|
+
* A single point on the agent consumption timeline
|
|
16929
|
+
*/
|
|
16930
|
+
interface AgentGetConsumptionTimelineResponse {
|
|
16931
|
+
/** Bucket timestamp (ISO 8601, UTC) */
|
|
16932
|
+
timeSlice: string;
|
|
16933
|
+
/** Agent Units quantity consumed in this time bucket */
|
|
16934
|
+
aguConsumption: number;
|
|
16935
|
+
}
|
|
16936
|
+
/**
|
|
16937
|
+
* Options for getting the agent consumption timeline.
|
|
16938
|
+
*/
|
|
16939
|
+
interface AgentGetConsumptionTimelineOptions extends AgentFilterOptions {
|
|
16940
|
+
}
|
|
16941
|
+
/**
|
|
16942
|
+
* A single point on the agent latency timeline
|
|
16943
|
+
*/
|
|
16944
|
+
interface AgentGetLatencyTimelineResponse {
|
|
16945
|
+
/**
|
|
16946
|
+
* Percentile label for this point — observed values: `"P50"`, `"P95"`.
|
|
16947
|
+
*/
|
|
16948
|
+
name: string;
|
|
16949
|
+
/** Latency value in milliseconds. */
|
|
16950
|
+
value: number;
|
|
16951
|
+
/** Bucket timestamp (ISO 8601, UTC) */
|
|
16952
|
+
date: string;
|
|
16953
|
+
}
|
|
16954
|
+
/**
|
|
16955
|
+
* Options for getting the agent latency timeline.
|
|
16956
|
+
*/
|
|
16957
|
+
interface AgentGetLatencyTimelineOptions extends AgentFilterOptions {
|
|
16958
|
+
}
|
|
16959
|
+
/**
|
|
16960
|
+
* A single agent's error count over the requested window, with the first and
|
|
16961
|
+
* last jobs where errors were observed.
|
|
16962
|
+
*/
|
|
16963
|
+
interface AgentTopErrorCount {
|
|
16964
|
+
/** Agent name */
|
|
16965
|
+
name: string;
|
|
16966
|
+
/** Error count for this agent over the requested window */
|
|
16967
|
+
count: number;
|
|
16968
|
+
/** Agent ID (GUID) */
|
|
16969
|
+
agentId: string;
|
|
16970
|
+
/** First job in the window where this agent reported errors */
|
|
16971
|
+
firstSeenJob: AgentJobInfo;
|
|
16972
|
+
/** Last job in the window where this agent reported errors */
|
|
16973
|
+
lastSeenJob: AgentJobInfo;
|
|
16974
|
+
}
|
|
16975
|
+
/**
|
|
16976
|
+
* Response from getting the top agents by error count.
|
|
16977
|
+
*/
|
|
16978
|
+
interface AgentGetTopErrorCountResponse {
|
|
16979
|
+
/** Total error count across all agents in the window. */
|
|
16980
|
+
totalErrors: number;
|
|
16981
|
+
/** Top-N agents ranked by error count. */
|
|
16982
|
+
data: AgentTopErrorCount[];
|
|
16983
|
+
}
|
|
16984
|
+
/**
|
|
16985
|
+
* Options for getting the top agents by error count.
|
|
16986
|
+
*/
|
|
16987
|
+
interface AgentGetTopErrorCountOptions extends AgentFilterOptions {
|
|
16988
|
+
/**
|
|
16989
|
+
* Max number of agents to return. Defaults to 10 server-side.
|
|
16990
|
+
* @default 10
|
|
16991
|
+
*/
|
|
16992
|
+
limit?: number;
|
|
16993
|
+
}
|
|
16994
|
+
/**
|
|
16995
|
+
* Agent type, used to filter consumption results.
|
|
16996
|
+
*
|
|
16997
|
+
* Wire format is the string name, per the API's `StringEnumConverter` serialization.
|
|
16998
|
+
*/
|
|
16999
|
+
declare enum AgentType {
|
|
17000
|
+
Autonomous = "Autonomous",
|
|
17001
|
+
Conversational = "Conversational",
|
|
17002
|
+
Coded = "Coded"
|
|
17003
|
+
}
|
|
17004
|
+
/**
|
|
17005
|
+
* A single agent's unit consumption over the requested window, with the first
|
|
17006
|
+
* and last jobs where consumption was recorded.
|
|
17007
|
+
*/
|
|
17008
|
+
interface AgentConsumption {
|
|
17009
|
+
/** Agent ID (GUID) */
|
|
17010
|
+
agentId: string;
|
|
17011
|
+
/** Agent display name */
|
|
17012
|
+
agentName: string;
|
|
17013
|
+
/** Total quantity consumed by this agent. `null` if no consumption is recorded. */
|
|
17014
|
+
consumedQuantity: number | null;
|
|
17015
|
+
/** Agent Units quantity consumed. `null` if no consumption is recorded. */
|
|
17016
|
+
consumedAGUQuantity: number | null;
|
|
17017
|
+
/** Platform Units quantity consumed. `null` if no consumption is recorded. */
|
|
17018
|
+
consumedPLTUQuantity: number | null;
|
|
17019
|
+
/** First job in the window where this agent recorded consumption */
|
|
17020
|
+
firstSeenJob: AgentJobInfo;
|
|
17021
|
+
/** Last job in the window where this agent recorded consumption */
|
|
17022
|
+
lastSeenJob: AgentJobInfo;
|
|
17023
|
+
}
|
|
17024
|
+
/**
|
|
17025
|
+
* Response from getting the top agents by consumption.
|
|
17026
|
+
*/
|
|
17027
|
+
interface AgentGetTopConsumptionResponse {
|
|
17028
|
+
/** Window start date. */
|
|
17029
|
+
startDate: string;
|
|
17030
|
+
/** Window end date. */
|
|
17031
|
+
endDate: string;
|
|
17032
|
+
/** Total quantity consumed across all matching agents in the window. */
|
|
17033
|
+
totalConsumed: number;
|
|
17034
|
+
/** Total Agent Units quantity consumed. */
|
|
17035
|
+
totalAGUConsumed: number;
|
|
17036
|
+
/** Total Platform Units quantity consumed. */
|
|
17037
|
+
totalPLTUConsumed: number;
|
|
17038
|
+
/** Limit applied (echoed from the request). */
|
|
17039
|
+
limit: number;
|
|
17040
|
+
/** Top-N agents ranked by consumption. Empty array when no agents matched. */
|
|
17041
|
+
agents: AgentConsumption[];
|
|
17042
|
+
}
|
|
17043
|
+
/**
|
|
17044
|
+
* Options for getting the top agents by consumption.
|
|
17045
|
+
*/
|
|
17046
|
+
interface AgentGetTopConsumptionOptions extends AgentFilterOptions {
|
|
17047
|
+
/**
|
|
17048
|
+
* Max number of agents to return. Defaults to 10 server-side.
|
|
17049
|
+
* @default 10
|
|
17050
|
+
*/
|
|
15806
17051
|
limit?: number;
|
|
17052
|
+
/**
|
|
17053
|
+
* Health-based filter. `true` returns only healthy agents, `false` only
|
|
17054
|
+
* unhealthy. Omit to include both.
|
|
17055
|
+
*/
|
|
17056
|
+
healthy?: boolean;
|
|
17057
|
+
/**
|
|
17058
|
+
* Health-score cutoff used when `healthy` is set. Defaults to 75.0
|
|
17059
|
+
* server-side.
|
|
17060
|
+
* @default 75.0
|
|
17061
|
+
*/
|
|
17062
|
+
healthThreshold?: number;
|
|
17063
|
+
/**
|
|
17064
|
+
* Filter to specific agent types. Multiple types are combined with `OR` and
|
|
17065
|
+
* sent to the API as a comma-separated string.
|
|
17066
|
+
*/
|
|
17067
|
+
agentTypes?: AgentType[];
|
|
17068
|
+
}
|
|
17069
|
+
/**
|
|
17070
|
+
* Distribution of incidents across types over the requested window.
|
|
17071
|
+
*/
|
|
17072
|
+
interface AgentGetIncidentDistributionResponse {
|
|
17073
|
+
/** Number of error-type incidents in the window */
|
|
17074
|
+
errorCount: number;
|
|
17075
|
+
/** Number of escalation-type incidents in the window */
|
|
17076
|
+
escalationCount: number;
|
|
17077
|
+
/** Number of policy-type incidents in the window */
|
|
17078
|
+
policyCount: number;
|
|
17079
|
+
}
|
|
17080
|
+
/**
|
|
17081
|
+
* Options for getting the incident distribution.
|
|
17082
|
+
*
|
|
17083
|
+
* Currently identical to {@link AgentFilterOptions}; named distinctly so that
|
|
17084
|
+
* future per-method filters can be added without a breaking change.
|
|
17085
|
+
*/
|
|
17086
|
+
interface AgentGetIncidentDistributionOptions extends AgentFilterOptions {
|
|
17087
|
+
}
|
|
17088
|
+
/**
|
|
17089
|
+
* Per-agent (process + folder) stats within an {@link AgentSummaryPeriod}.
|
|
17090
|
+
*/
|
|
17091
|
+
interface AgentSummaryEntry {
|
|
17092
|
+
/** Process key (GUID) */
|
|
17093
|
+
processKey: string;
|
|
17094
|
+
/** Folder key (GUID) the agent ran in */
|
|
17095
|
+
folderKey: string;
|
|
17096
|
+
/** Process version */
|
|
17097
|
+
processVersion: string;
|
|
17098
|
+
/** Total job runs in the period */
|
|
17099
|
+
totalJobs: number;
|
|
17100
|
+
/** Number of successful runs in the period */
|
|
17101
|
+
successfulJobs: number;
|
|
17102
|
+
/** Success rate as a percentage (0-100) */
|
|
17103
|
+
successRate: number;
|
|
17104
|
+
/** Average run duration in seconds */
|
|
17105
|
+
averageDurationSeconds: number;
|
|
17106
|
+
/** First job completion timestamp (ISO 8601, UTC) */
|
|
17107
|
+
firstJobFinished: string;
|
|
17108
|
+
/** Last job completion timestamp (ISO 8601, UTC) */
|
|
17109
|
+
lastJobFinished: string;
|
|
17110
|
+
/**
|
|
17111
|
+
* Status of the most recent run, normalized to {@link JobState}. The API's
|
|
17112
|
+
* `Success` label maps to {@link JobState.Successful}; any unrecognized value
|
|
17113
|
+
* becomes {@link JobState.Unknown}.
|
|
17114
|
+
*/
|
|
17115
|
+
lastJobStatus: JobState;
|
|
17116
|
+
}
|
|
17117
|
+
/**
|
|
17118
|
+
* Aggregate stats for a single period within an {@link AgentGetSummaryResponse}
|
|
17119
|
+
* — covers the requested window for either the current period or an optional
|
|
17120
|
+
* lookback period.
|
|
17121
|
+
*/
|
|
17122
|
+
interface AgentSummaryPeriod {
|
|
17123
|
+
/** Total job runs across all agents in the period */
|
|
17124
|
+
totalJobs: number;
|
|
17125
|
+
/** Number of successful runs across all agents in the period */
|
|
17126
|
+
successfulJobs: number;
|
|
17127
|
+
/** Overall success rate as a percentage (0-100) */
|
|
17128
|
+
successRate: number;
|
|
17129
|
+
/** Average run duration in seconds across all agents in the period */
|
|
17130
|
+
averageDurationSeconds: number;
|
|
17131
|
+
/** Period start time (ISO 8601, UTC) */
|
|
17132
|
+
startTime: string;
|
|
17133
|
+
/** Period end time (ISO 8601, UTC) */
|
|
17134
|
+
endTime: string;
|
|
17135
|
+
/** Per-agent breakdown */
|
|
17136
|
+
agents: AgentSummaryEntry[];
|
|
17137
|
+
}
|
|
17138
|
+
/**
|
|
17139
|
+
* Response from getting the agent summary.
|
|
17140
|
+
*/
|
|
17141
|
+
interface AgentGetSummaryResponse {
|
|
17142
|
+
/** Aggregate stats for the requested window. Always present. */
|
|
17143
|
+
currentPeriodSummary: AgentSummaryPeriod;
|
|
17144
|
+
/** Aggregate stats for the prior window of equal length. Only present when `lookbackPeriodAnalysis: true` was sent. */
|
|
17145
|
+
lookbackPeriodSummary?: AgentSummaryPeriod;
|
|
17146
|
+
}
|
|
17147
|
+
/**
|
|
17148
|
+
* Job execution mode filter accepted by the summary endpoints.
|
|
17149
|
+
*
|
|
17150
|
+
* Wire format is the string name (`"Debug"` / `"Runtime"`), per the API's
|
|
17151
|
+
* `StringEnumConverter` serialization.
|
|
17152
|
+
*/
|
|
17153
|
+
declare enum AgentExecutionType {
|
|
17154
|
+
/** Test runs */
|
|
17155
|
+
Debug = "Debug",
|
|
17156
|
+
/** Production runs */
|
|
17157
|
+
Runtime = "Runtime"
|
|
17158
|
+
}
|
|
17159
|
+
/**
|
|
17160
|
+
* Options for getting the agent summary.
|
|
17161
|
+
*/
|
|
17162
|
+
interface AgentGetSummaryOptions extends AgentFilterOptions {
|
|
17163
|
+
/**
|
|
17164
|
+
* When `true`, it also computes a `lookbackPeriodSummary` for the
|
|
17165
|
+
* prior window of equal length. Defaults to `false` server-side.
|
|
17166
|
+
* @default false
|
|
17167
|
+
*/
|
|
17168
|
+
lookbackPeriodAnalysis?: boolean;
|
|
17169
|
+
/** Filter to a specific process by key (GUID). */
|
|
17170
|
+
processKey?: string;
|
|
17171
|
+
/**
|
|
17172
|
+
* Filter to a specific folder by key (GUID).
|
|
17173
|
+
*
|
|
17174
|
+
* The summary endpoint accepts both — `folderKey` selects a
|
|
17175
|
+
* single folder, `folderKeys` filters the lookup to a list of folders.
|
|
17176
|
+
*/
|
|
17177
|
+
folderKey?: string;
|
|
17178
|
+
/**
|
|
17179
|
+
* Filter to a specific execution type — `Debug` (test runs) or
|
|
17180
|
+
* `Runtime` (production runs).
|
|
17181
|
+
*/
|
|
17182
|
+
executionType?: AgentExecutionType;
|
|
15807
17183
|
}
|
|
15808
17184
|
/**
|
|
15809
|
-
*
|
|
17185
|
+
* Job-type breakdown of unit consumption — completed jobs vs jobs still in
|
|
17186
|
+
* progress at query time.
|
|
15810
17187
|
*/
|
|
15811
|
-
interface
|
|
15812
|
-
/**
|
|
15813
|
-
|
|
15814
|
-
/**
|
|
15815
|
-
|
|
17188
|
+
interface AgentJobConsumptionSummary {
|
|
17189
|
+
/** Units consumed by jobs that have completed in the period */
|
|
17190
|
+
completeJobs: number;
|
|
17191
|
+
/** Units consumed by jobs still in progress at query time */
|
|
17192
|
+
incompleteJobs: number;
|
|
15816
17193
|
}
|
|
15817
17194
|
/**
|
|
15818
|
-
*
|
|
17195
|
+
* Per-agent (process + folder) unit consumption entry within an
|
|
17196
|
+
* {@link AgentUnitConsumptionPeriod}.
|
|
15819
17197
|
*/
|
|
15820
|
-
interface
|
|
17198
|
+
interface AgentUnitConsumptionEntry {
|
|
17199
|
+
/** Folder key (GUID) the agent ran in */
|
|
17200
|
+
folderKey: string;
|
|
17201
|
+
/** Process key (GUID) */
|
|
17202
|
+
processKey: string;
|
|
17203
|
+
/** Process version */
|
|
17204
|
+
processVersion: string;
|
|
17205
|
+
/** First job completion timestamp (ISO 8601). `"0001-01-01T00:00:00"` if no completion in the period. */
|
|
17206
|
+
firstJobFinished: string;
|
|
17207
|
+
/** Last job completion timestamp (ISO 8601). `"0001-01-01T00:00:00"` if no completion in the period. */
|
|
17208
|
+
lastJobFinished: string;
|
|
17209
|
+
/** Agent Units consumption for this agent, split by job completion status */
|
|
17210
|
+
agentUnitConsumption: AgentJobConsumptionSummary;
|
|
17211
|
+
/** Platform Units consumption for this agent, split by job completion status */
|
|
17212
|
+
platformUnitConsumption: AgentJobConsumptionSummary;
|
|
17213
|
+
}
|
|
17214
|
+
/**
|
|
17215
|
+
* Aggregate Agent Units and Platform Units consumption for a single period within an
|
|
17216
|
+
* {@link AgentGetUnitConsumptionSummaryResponse} — covers the requested window
|
|
17217
|
+
* for either the current period or an optional lookback period.
|
|
17218
|
+
*/
|
|
17219
|
+
interface AgentUnitConsumptionPeriod {
|
|
17220
|
+
/** Total Agent Units consumed across all agents in the period, split by job completion */
|
|
17221
|
+
totalAgentUnitConsumption: AgentJobConsumptionSummary;
|
|
17222
|
+
/** Total Platform Units consumed across all agents in the period, split by job completion */
|
|
17223
|
+
totalPlatformUnitConsumption: AgentJobConsumptionSummary;
|
|
17224
|
+
/** Period start time (ISO 8601, UTC) */
|
|
17225
|
+
startTime: string;
|
|
17226
|
+
/** Period end time (ISO 8601, UTC) */
|
|
17227
|
+
endTime: string;
|
|
17228
|
+
/** Per-agent consumption breakdown */
|
|
17229
|
+
agentConsumption: AgentUnitConsumptionEntry[];
|
|
15821
17230
|
}
|
|
15822
17231
|
/**
|
|
15823
|
-
*
|
|
17232
|
+
* Response from getting the agent unit consumption summary.
|
|
15824
17233
|
*/
|
|
15825
|
-
interface
|
|
15826
|
-
/**
|
|
15827
|
-
|
|
15828
|
-
|
|
15829
|
-
|
|
15830
|
-
/** Latency value in milliseconds. */
|
|
15831
|
-
value: number;
|
|
15832
|
-
/** Bucket timestamp (ISO 8601, UTC) */
|
|
15833
|
-
date: string;
|
|
17234
|
+
interface AgentGetUnitConsumptionSummaryResponse {
|
|
17235
|
+
/** Aggregate consumption for the requested window. Always present. */
|
|
17236
|
+
currentPeriodSummary: AgentUnitConsumptionPeriod;
|
|
17237
|
+
/** Aggregate consumption for the prior window of equal length. Only present when `lookbackPeriodAnalysis: true` was sent. */
|
|
17238
|
+
lookbackPeriodSummary?: AgentUnitConsumptionPeriod;
|
|
15834
17239
|
}
|
|
15835
17240
|
/**
|
|
15836
|
-
* Options for getting the agent
|
|
17241
|
+
* Options for getting the agent unit consumption summary.
|
|
17242
|
+
*
|
|
17243
|
+
* Currently identical to {@link AgentGetSummaryOptions} (the API uses the same
|
|
17244
|
+
* `AgentsSummaryRequest` schema for both endpoints); named distinctly so that
|
|
17245
|
+
* future per-method filters can be added without a breaking change.
|
|
15837
17246
|
*/
|
|
15838
|
-
interface
|
|
17247
|
+
interface AgentGetUnitConsumptionSummaryOptions extends AgentGetSummaryOptions {
|
|
15839
17248
|
}
|
|
15840
17249
|
|
|
15841
17250
|
/**
|
|
@@ -15978,7 +17387,7 @@ interface AgentServiceModel {
|
|
|
15978
17387
|
*/
|
|
15979
17388
|
getErrorsTimeline(startTime: Date, endTime: Date, options?: AgentGetErrorsTimelineOptions): Promise<AgentGetErrorsTimelineResponse[]>;
|
|
15980
17389
|
/**
|
|
15981
|
-
* Retrieves a time-series of
|
|
17390
|
+
* Retrieves a time-series of Agent Units consumption over the requested window.
|
|
15982
17391
|
*
|
|
15983
17392
|
* @param startTime - Inclusive lower bound for the query window
|
|
15984
17393
|
* @param endTime - Exclusive upper bound for the query window
|
|
@@ -15990,13 +17399,13 @@ interface AgentServiceModel {
|
|
|
15990
17399
|
*
|
|
15991
17400
|
* const agents = new Agents(sdk);
|
|
15992
17401
|
*
|
|
15993
|
-
* //
|
|
17402
|
+
* // Agent Units consumption timeline in May 2025
|
|
15994
17403
|
* const result = await agents.getConsumptionTimeline(
|
|
15995
17404
|
* new Date('2025-05-01T00:00:00Z'),
|
|
15996
17405
|
* new Date('2025-06-01T00:00:00Z'),
|
|
15997
17406
|
* );
|
|
15998
17407
|
* result.forEach((point) => {
|
|
15999
|
-
* console.log(`${point.timeSlice}: ${point.aguConsumption}
|
|
17408
|
+
* console.log(`${point.timeSlice}: ${point.aguConsumption} Agent Units`);
|
|
16000
17409
|
* });
|
|
16001
17410
|
* ```
|
|
16002
17411
|
* @example
|
|
@@ -16050,6 +17459,198 @@ interface AgentServiceModel {
|
|
|
16050
17459
|
* ```
|
|
16051
17460
|
*/
|
|
16052
17461
|
getLatencyTimeline(startTime: Date, endTime: Date, options?: AgentGetLatencyTimelineOptions): Promise<AgentGetLatencyTimelineResponse[]>;
|
|
17462
|
+
/**
|
|
17463
|
+
* Retrieves the top-N agents ranked by error count over the requested window.
|
|
17464
|
+
*
|
|
17465
|
+
* @param startTime - Inclusive lower bound for the query window
|
|
17466
|
+
* @param endTime - Exclusive upper bound for the query window
|
|
17467
|
+
* @param options - Optional filters
|
|
17468
|
+
* @returns Promise resolving to {@link AgentGetTopErrorCountResponse}
|
|
17469
|
+
* @example
|
|
17470
|
+
* ```typescript
|
|
17471
|
+
* import { Agents } from '@uipath/uipath-typescript/agents';
|
|
17472
|
+
*
|
|
17473
|
+
* const agents = new Agents(sdk);
|
|
17474
|
+
*
|
|
17475
|
+
* // Top agents by error count in May 2025
|
|
17476
|
+
* const result = await agents.getTopErrorCount(
|
|
17477
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
17478
|
+
* new Date('2025-06-01T00:00:00Z'),
|
|
17479
|
+
* );
|
|
17480
|
+
* result.data.forEach((agent) => {
|
|
17481
|
+
* console.log(`${agent.name}: ${agent.count} errors`);
|
|
17482
|
+
* });
|
|
17483
|
+
* ```
|
|
17484
|
+
* @example
|
|
17485
|
+
* ```typescript
|
|
17486
|
+
* // Scope to specific folders and top 5 agents
|
|
17487
|
+
* const result = await agents.getTopErrorCount(
|
|
17488
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
17489
|
+
* new Date('2025-06-01T00:00:00Z'),
|
|
17490
|
+
* {
|
|
17491
|
+
* folderKeys: ['<folderKey1>'],
|
|
17492
|
+
* limit: 5,
|
|
17493
|
+
* },
|
|
17494
|
+
* );
|
|
17495
|
+
* ```
|
|
17496
|
+
*/
|
|
17497
|
+
getTopErrorCount(startTime: Date, endTime: Date, options?: AgentGetTopErrorCountOptions): Promise<AgentGetTopErrorCountResponse>;
|
|
17498
|
+
/**
|
|
17499
|
+
* Retrieves the top-N agents ranked by unit consumption over the requested window.
|
|
17500
|
+
*
|
|
17501
|
+
* @param startTime - Inclusive lower bound for the query window
|
|
17502
|
+
* @param endTime - Exclusive upper bound for the query window
|
|
17503
|
+
* @param options - Optional filters
|
|
17504
|
+
* @returns Promise resolving to {@link AgentGetTopConsumptionResponse}
|
|
17505
|
+
* @example
|
|
17506
|
+
* ```typescript
|
|
17507
|
+
* import { Agents } from '@uipath/uipath-typescript/agents';
|
|
17508
|
+
*
|
|
17509
|
+
* const agents = new Agents(sdk);
|
|
17510
|
+
*
|
|
17511
|
+
* // Top agents by consumption in May 2025
|
|
17512
|
+
* const result = await agents.getTopConsumption(
|
|
17513
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
17514
|
+
* new Date('2025-06-01T00:00:00Z'),
|
|
17515
|
+
* );
|
|
17516
|
+
* console.log(`Total consumed: ${result.totalConsumed}`);
|
|
17517
|
+
* result.agents.forEach((agent) => {
|
|
17518
|
+
* console.log(`${agent.agentName}: ${agent.consumedQuantity}`);
|
|
17519
|
+
* });
|
|
17520
|
+
* ```
|
|
17521
|
+
* @example
|
|
17522
|
+
* ```typescript
|
|
17523
|
+
* import { Agents, AgentType } from '@uipath/uipath-typescript/agents';
|
|
17524
|
+
*
|
|
17525
|
+
* const agents = new Agents(sdk);
|
|
17526
|
+
*
|
|
17527
|
+
* // Top 5 healthy autonomous agents by consumption
|
|
17528
|
+
* const result = await agents.getTopConsumption(
|
|
17529
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
17530
|
+
* new Date('2025-06-01T00:00:00Z'),
|
|
17531
|
+
* {
|
|
17532
|
+
* limit: 5,
|
|
17533
|
+
* healthy: true,
|
|
17534
|
+
* agentTypes: [AgentType.Autonomous],
|
|
17535
|
+
* },
|
|
17536
|
+
* );
|
|
17537
|
+
* ```
|
|
17538
|
+
*/
|
|
17539
|
+
getTopConsumption(startTime: Date, endTime: Date, options?: AgentGetTopConsumptionOptions): Promise<AgentGetTopConsumptionResponse>;
|
|
17540
|
+
/**
|
|
17541
|
+
* Retrieves breakdown of agent incidents count — errors, escalations,
|
|
17542
|
+
* and policy violations over a requested window.
|
|
17543
|
+
*
|
|
17544
|
+
* @param startTime - Inclusive lower bound for the query window
|
|
17545
|
+
* @param endTime - Exclusive upper bound for the query window
|
|
17546
|
+
* @param options - Optional filters
|
|
17547
|
+
* @returns Promise resolving to {@link AgentGetIncidentDistributionResponse}
|
|
17548
|
+
* @example
|
|
17549
|
+
* ```typescript
|
|
17550
|
+
* import { Agents } from '@uipath/uipath-typescript/agents';
|
|
17551
|
+
*
|
|
17552
|
+
* const agents = new Agents(sdk);
|
|
17553
|
+
*
|
|
17554
|
+
* // Incident distribution in May 2025
|
|
17555
|
+
* const result = await agents.getIncidentDistribution(
|
|
17556
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
17557
|
+
* new Date('2025-06-01T00:00:00Z'),
|
|
17558
|
+
* );
|
|
17559
|
+
* console.log(`Errors: ${result.errorCount}, Escalations: ${result.escalationCount}, Policy: ${result.policyCount}`);
|
|
17560
|
+
* ```
|
|
17561
|
+
* @example
|
|
17562
|
+
* ```typescript
|
|
17563
|
+
* // Scope to specific folders
|
|
17564
|
+
* const result = await agents.getIncidentDistribution(
|
|
17565
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
17566
|
+
* new Date('2025-06-01T00:00:00Z'),
|
|
17567
|
+
* {
|
|
17568
|
+
* folderKeys: ['<folderKey1>'],
|
|
17569
|
+
* },
|
|
17570
|
+
* );
|
|
17571
|
+
* ```
|
|
17572
|
+
*/
|
|
17573
|
+
getIncidentDistribution(startTime: Date, endTime: Date, options?: AgentGetIncidentDistributionOptions): Promise<AgentGetIncidentDistributionResponse>;
|
|
17574
|
+
/**
|
|
17575
|
+
* Retrieves a job-execution summary for the requested window: overall totals
|
|
17576
|
+
* (total jobs, successful jobs, success rate, average duration) alongside a
|
|
17577
|
+
* per-agent breakdown. When `lookbackPeriodAnalysis` is enabled, a comparable
|
|
17578
|
+
* summary for the preceding window of equal length is included too.
|
|
17579
|
+
*
|
|
17580
|
+
* @param startTime - Inclusive lower bound for the query window
|
|
17581
|
+
* @param endTime - Exclusive upper bound for the query window
|
|
17582
|
+
* @param options - Optional filters
|
|
17583
|
+
* @returns Promise resolving to {@link AgentGetSummaryResponse}
|
|
17584
|
+
* @example
|
|
17585
|
+
* ```typescript
|
|
17586
|
+
* import { Agents } from '@uipath/uipath-typescript/agents';
|
|
17587
|
+
*
|
|
17588
|
+
* const agents = new Agents(sdk);
|
|
17589
|
+
*
|
|
17590
|
+
* // Summary for May 2025
|
|
17591
|
+
* const result = await agents.getSummary(
|
|
17592
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
17593
|
+
* new Date('2025-06-01T00:00:00Z'),
|
|
17594
|
+
* );
|
|
17595
|
+
* console.log(`Success rate: ${result.currentPeriodSummary.successRate}%`);
|
|
17596
|
+
* ```
|
|
17597
|
+
* @example
|
|
17598
|
+
* ```typescript
|
|
17599
|
+
* import { Agents, AgentExecutionType } from '@uipath/uipath-typescript/agents';
|
|
17600
|
+
*
|
|
17601
|
+
* const agents = new Agents(sdk);
|
|
17602
|
+
*
|
|
17603
|
+
* // Runtime-only summary with lookback comparison
|
|
17604
|
+
* const result = await agents.getSummary(
|
|
17605
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
17606
|
+
* new Date('2025-06-01T00:00:00Z'),
|
|
17607
|
+
* {
|
|
17608
|
+
* lookbackPeriodAnalysis: true,
|
|
17609
|
+
* executionType: AgentExecutionType.Runtime,
|
|
17610
|
+
* },
|
|
17611
|
+
* );
|
|
17612
|
+
* ```
|
|
17613
|
+
*/
|
|
17614
|
+
getSummary(startTime: Date, endTime: Date, options?: AgentGetSummaryOptions): Promise<AgentGetSummaryResponse>;
|
|
17615
|
+
/**
|
|
17616
|
+
* Retrieves an aggregate Agent Units and Platform Units consumption summary per agent over the
|
|
17617
|
+
* requested window.
|
|
17618
|
+
*
|
|
17619
|
+
* @param startTime - Inclusive lower bound for the query window
|
|
17620
|
+
* @param endTime - Exclusive upper bound for the query window
|
|
17621
|
+
* @param options - Optional filters
|
|
17622
|
+
* @returns Promise resolving to {@link AgentGetUnitConsumptionSummaryResponse}
|
|
17623
|
+
* @example
|
|
17624
|
+
* ```typescript
|
|
17625
|
+
* import { Agents } from '@uipath/uipath-typescript/agents';
|
|
17626
|
+
*
|
|
17627
|
+
* const agents = new Agents(sdk);
|
|
17628
|
+
*
|
|
17629
|
+
* // Unit consumption summary for May 2025
|
|
17630
|
+
* const result = await agents.getUnitConsumptionSummary(
|
|
17631
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
17632
|
+
* new Date('2025-06-01T00:00:00Z'),
|
|
17633
|
+
* );
|
|
17634
|
+
* console.log(`Agent Units complete jobs: ${result.currentPeriodSummary.totalAgentUnitConsumption.completeJobs}`);
|
|
17635
|
+
* ```
|
|
17636
|
+
* @example
|
|
17637
|
+
* ```typescript
|
|
17638
|
+
* import { Agents, AgentExecutionType } from '@uipath/uipath-typescript/agents';
|
|
17639
|
+
*
|
|
17640
|
+
* const agents = new Agents(sdk);
|
|
17641
|
+
*
|
|
17642
|
+
* // Runtime-only summary with lookback comparison
|
|
17643
|
+
* const result = await agents.getUnitConsumptionSummary(
|
|
17644
|
+
* new Date('2025-05-01T00:00:00Z'),
|
|
17645
|
+
* new Date('2025-06-01T00:00:00Z'),
|
|
17646
|
+
* {
|
|
17647
|
+
* lookbackPeriodAnalysis: true,
|
|
17648
|
+
* executionType: AgentExecutionType.Runtime,
|
|
17649
|
+
* },
|
|
17650
|
+
* );
|
|
17651
|
+
* ```
|
|
17652
|
+
*/
|
|
17653
|
+
getUnitConsumptionSummary(startTime: Date, endTime: Date, options?: AgentGetUnitConsumptionSummaryOptions): Promise<AgentGetUnitConsumptionSummaryResponse>;
|
|
16053
17654
|
}
|
|
16054
17655
|
|
|
16055
17656
|
/**
|
|
@@ -16099,7 +17700,10 @@ interface AgentMemoryGetCallsTimelineOptions extends AgentMemoryFilterOptions {
|
|
|
16099
17700
|
* Options for retrieving the top memory spaces.
|
|
16100
17701
|
*/
|
|
16101
17702
|
interface AgentMemoryGetTopSpacesOptions extends AgentMemoryFilterOptions {
|
|
16102
|
-
/**
|
|
17703
|
+
/**
|
|
17704
|
+
* Maximum number of memory spaces to return, ranked by memory count.
|
|
17705
|
+
* @default 5
|
|
17706
|
+
*/
|
|
16103
17707
|
limit?: number;
|
|
16104
17708
|
}
|
|
16105
17709
|
/**
|
|
@@ -17597,7 +19201,7 @@ interface AgentTraceGetLatencyTimelineOptions extends AgentTraceFilterOptions {
|
|
|
17597
19201
|
}
|
|
17598
19202
|
/**
|
|
17599
19203
|
* Per-agent unit consumption totals over the requested window (trace-level) —
|
|
17600
|
-
* a flat per-(agent, version, folder) breakdown of
|
|
19204
|
+
* a flat per-(agent, version, folder) breakdown of Agent Units and Platform Units consumed.
|
|
17601
19205
|
*/
|
|
17602
19206
|
interface AgentTraceGetUnitConsumptionResponse {
|
|
17603
19207
|
/** Agent ID these totals belong to. */
|
|
@@ -17638,33 +19242,33 @@ interface AgentSpanGetResponse {
|
|
|
17638
19242
|
status: string;
|
|
17639
19243
|
/** Organization ID (GUID). */
|
|
17640
19244
|
organizationId: string;
|
|
17641
|
-
/** Tenant ID (GUID).
|
|
19245
|
+
/** Tenant ID (GUID). */
|
|
17642
19246
|
tenantId: string | null;
|
|
17643
|
-
/** Span retention expiry time.
|
|
19247
|
+
/** Span retention expiry time. */
|
|
17644
19248
|
expiredTime: string | null;
|
|
17645
|
-
/** Folder key (GUID) the span was recorded in.
|
|
19249
|
+
/** Folder key (GUID) the span was recorded in. */
|
|
17646
19250
|
folderKey: string | null;
|
|
17647
|
-
/** Span source.
|
|
19251
|
+
/** Span source. */
|
|
17648
19252
|
source: string | null;
|
|
17649
|
-
/** Span type.
|
|
19253
|
+
/** Span type. */
|
|
17650
19254
|
spanType: string | null;
|
|
17651
|
-
/** Process key (GUID).
|
|
19255
|
+
/** Process key (GUID). */
|
|
17652
19256
|
processKey: string | null;
|
|
17653
|
-
/** Job key (GUID).
|
|
19257
|
+
/** Job key (GUID). */
|
|
17654
19258
|
jobKey: string | null;
|
|
17655
|
-
/** Reference ID (GUID).
|
|
19259
|
+
/** Reference ID (GUID). */
|
|
17656
19260
|
referenceId: string | null;
|
|
17657
|
-
/** Verbosity level.
|
|
19261
|
+
/** Verbosity level. */
|
|
17658
19262
|
verbosityLevel: string | null;
|
|
17659
19263
|
/** Record last-updated time. */
|
|
17660
19264
|
updatedAt: string;
|
|
17661
19265
|
/** Whether the span payload is stored as a large payload. */
|
|
17662
19266
|
isLargePayload: boolean;
|
|
17663
|
-
/** Payload compression type.
|
|
19267
|
+
/** Payload compression type. */
|
|
17664
19268
|
compressionType: string | null;
|
|
17665
|
-
/** Agent version that produced the span.
|
|
19269
|
+
/** Agent version that produced the span. */
|
|
17666
19270
|
agentVersion: string | null;
|
|
17667
|
-
/** Raw span context as a JSON string.
|
|
19271
|
+
/** Raw span context as a JSON string. */
|
|
17668
19272
|
context: string | null;
|
|
17669
19273
|
}
|
|
17670
19274
|
/**
|
|
@@ -17686,6 +19290,153 @@ type AgentTraceGetSpansByReferenceOptions = PaginationOptions & {
|
|
|
17686
19290
|
/** Execution type filter */
|
|
17687
19291
|
executionType?: SpanExecutionType;
|
|
17688
19292
|
};
|
|
19293
|
+
/**
|
|
19294
|
+
* Evaluation mode of a governance decision.
|
|
19295
|
+
*/
|
|
19296
|
+
declare enum AgentGovernanceMode {
|
|
19297
|
+
/** Policy evaluated and logged, but not enforced. */
|
|
19298
|
+
Audit = "AUDIT",
|
|
19299
|
+
/** Policy evaluated and enforced. */
|
|
19300
|
+
Enforce = "ENFORCE",
|
|
19301
|
+
/** Unrecognized or missing mode. */
|
|
19302
|
+
Unknown = "Unknown"
|
|
19303
|
+
}
|
|
19304
|
+
/**
|
|
19305
|
+
* Verdict of a governance decision (`Deny` = violation).
|
|
19306
|
+
*/
|
|
19307
|
+
declare enum AgentGovernanceVerdict {
|
|
19308
|
+
/** Allowed — not a violation. */
|
|
19309
|
+
Allow = "ALLOW",
|
|
19310
|
+
/** Denied — counts as a violation. */
|
|
19311
|
+
Deny = "DENY",
|
|
19312
|
+
/** Unrecognized or missing verdict. */
|
|
19313
|
+
Unknown = "Unknown"
|
|
19314
|
+
}
|
|
19315
|
+
/**
|
|
19316
|
+
* A single governance decision — one policy's allow/deny result for an agent run.
|
|
19317
|
+
*/
|
|
19318
|
+
interface AgentGovernanceDecisionGetResponse {
|
|
19319
|
+
/** Tenant ID (GUID). */
|
|
19320
|
+
tenantId: string | null;
|
|
19321
|
+
/** Decision window start time — ISO 8601, UTC. */
|
|
19322
|
+
startTime: string;
|
|
19323
|
+
/** Decision window end time — ISO 8601, UTC. */
|
|
19324
|
+
endTime: string | null;
|
|
19325
|
+
/** Trace ID (GUID). */
|
|
19326
|
+
traceId: string | null;
|
|
19327
|
+
/** Job key (GUID). */
|
|
19328
|
+
jobKey: string | null;
|
|
19329
|
+
/** Folder key (GUID). */
|
|
19330
|
+
folderKey: string | null;
|
|
19331
|
+
/** Runtime the evaluator ran in (context, not a filter). */
|
|
19332
|
+
source: string | null;
|
|
19333
|
+
/** Policy ID. */
|
|
19334
|
+
policyId: string | null;
|
|
19335
|
+
/** Policy display name. */
|
|
19336
|
+
policyName: string | null;
|
|
19337
|
+
/** Governance pack name. */
|
|
19338
|
+
packName: string | null;
|
|
19339
|
+
/** Governance hook (e.g. `BEFORE_MODEL`). */
|
|
19340
|
+
hook: string | null;
|
|
19341
|
+
/** Evaluation mode, normalized to {@link AgentGovernanceMode} ({@link AgentGovernanceMode.Unknown} when missing/unrecognized). */
|
|
19342
|
+
mode: AgentGovernanceMode;
|
|
19343
|
+
/** Enforcement action applied. `null` in audit mode (no action enforced). */
|
|
19344
|
+
actionApplied: string | null;
|
|
19345
|
+
/** Verdict, normalized to {@link AgentGovernanceVerdict} (`Deny` = violation). */
|
|
19346
|
+
evaluatorResult: AgentGovernanceVerdict;
|
|
19347
|
+
/** Human-readable reason. */
|
|
19348
|
+
reason: string | null;
|
|
19349
|
+
/** Resolved agent ID (GUID). */
|
|
19350
|
+
agentId: string | null;
|
|
19351
|
+
/** Agent display name. */
|
|
19352
|
+
agentName: string | null;
|
|
19353
|
+
}
|
|
19354
|
+
/**
|
|
19355
|
+
* Options for the governance decisions query — optional filters plus pagination.
|
|
19356
|
+
*/
|
|
19357
|
+
type AgentGovernanceDecisionsOptions = PaginationOptions & {
|
|
19358
|
+
/** Inclusive upper bound for the query window. Defaults to now when omitted. */
|
|
19359
|
+
endTime?: Date;
|
|
19360
|
+
/** Filter on the governance hook. */
|
|
19361
|
+
hook?: string;
|
|
19362
|
+
/** Filter on the verdict. */
|
|
19363
|
+
evaluatorResult?: AgentGovernanceVerdict;
|
|
19364
|
+
/** Filter on a single policy ID. */
|
|
19365
|
+
policyId?: string;
|
|
19366
|
+
/** Filter on a single agent by its project key. */
|
|
19367
|
+
agentId?: string;
|
|
19368
|
+
/** When `true`, restrict to violations (deny verdicts). */
|
|
19369
|
+
violationsOnly?: boolean;
|
|
19370
|
+
};
|
|
19371
|
+
/**
|
|
19372
|
+
* One breakdown entry in the governance summary — counts for a single key.
|
|
19373
|
+
*/
|
|
19374
|
+
interface AgentGovernanceCountItem {
|
|
19375
|
+
/** The value this row groups by — the distinct hook, agent id, policy id, or pack name for this breakdown. */
|
|
19376
|
+
key: string | null;
|
|
19377
|
+
/** Display name (populated for the policy and agent breakdowns). */
|
|
19378
|
+
name: string | null;
|
|
19379
|
+
/** Number of decisions for this key. */
|
|
19380
|
+
count: number;
|
|
19381
|
+
/** Number of violations (deny verdicts) for this key. */
|
|
19382
|
+
violationCount: number;
|
|
19383
|
+
}
|
|
19384
|
+
/**
|
|
19385
|
+
* Sections the governance summary can compute. `action` and `mode` are opt-in.
|
|
19386
|
+
*/
|
|
19387
|
+
declare enum AgentGovernanceSection {
|
|
19388
|
+
/** Scalar totals (`total`, `violations`). */
|
|
19389
|
+
Totals = "totals",
|
|
19390
|
+
/** Breakdown by governance hook. */
|
|
19391
|
+
Hook = "hook",
|
|
19392
|
+
/** Breakdown by agent. */
|
|
19393
|
+
Agent = "agent",
|
|
19394
|
+
/** Breakdown by policy. */
|
|
19395
|
+
Policy = "policy",
|
|
19396
|
+
/** Breakdown by governance pack. */
|
|
19397
|
+
Pack = "pack",
|
|
19398
|
+
/** Breakdown by enforcement action (opt-in). */
|
|
19399
|
+
Action = "action",
|
|
19400
|
+
/** Breakdown by evaluation mode (opt-in). */
|
|
19401
|
+
Mode = "mode"
|
|
19402
|
+
}
|
|
19403
|
+
/**
|
|
19404
|
+
* Aggregated governance posture over the requested window.
|
|
19405
|
+
*/
|
|
19406
|
+
interface AgentGovernanceGetSummaryResponse {
|
|
19407
|
+
/** Total decisions in the window. */
|
|
19408
|
+
total: number;
|
|
19409
|
+
/** Total violations (deny verdicts). */
|
|
19410
|
+
violations: number;
|
|
19411
|
+
/** Breakdown by governance hook. */
|
|
19412
|
+
byHook: AgentGovernanceCountItem[];
|
|
19413
|
+
/** Breakdown by agent. */
|
|
19414
|
+
byAgent: AgentGovernanceCountItem[];
|
|
19415
|
+
/** Breakdown by policy. */
|
|
19416
|
+
byPolicy: AgentGovernanceCountItem[];
|
|
19417
|
+
/** Breakdown by governance pack. */
|
|
19418
|
+
byPack: AgentGovernanceCountItem[];
|
|
19419
|
+
/** Breakdown by enforcement action. Empty unless `action` is requested in `sections`. */
|
|
19420
|
+
byAction: AgentGovernanceCountItem[];
|
|
19421
|
+
/** Breakdown by evaluation mode. Empty unless `mode` is requested in `sections`. */
|
|
19422
|
+
byMode: AgentGovernanceCountItem[];
|
|
19423
|
+
}
|
|
19424
|
+
/**
|
|
19425
|
+
* Options for the governance summary.
|
|
19426
|
+
*/
|
|
19427
|
+
interface AgentGovernanceSummaryOptions {
|
|
19428
|
+
/** Inclusive upper bound for the query window. Defaults to now when omitted. */
|
|
19429
|
+
endTime?: Date;
|
|
19430
|
+
/** Top-N size for each breakdown. */
|
|
19431
|
+
topN?: number;
|
|
19432
|
+
/** Restrict totals and breakdowns to a single governance pack. */
|
|
19433
|
+
packName?: string;
|
|
19434
|
+
/**
|
|
19435
|
+
* Which sections to compute. Omit for the default set
|
|
19436
|
+
* (`totals`, `hook`, `agent`, `policy`, `pack`); `action` and `mode` are opt-in.
|
|
19437
|
+
*/
|
|
19438
|
+
sections?: AgentGovernanceSection[];
|
|
19439
|
+
}
|
|
17689
19440
|
|
|
17690
19441
|
/**
|
|
17691
19442
|
* Service for retrieving UiPath Agent trace metrics.
|
|
@@ -17769,7 +19520,7 @@ interface AgentTracesServiceModel {
|
|
|
17769
19520
|
* // Get per-agent unit consumption
|
|
17770
19521
|
* const result = await trace.getUnitConsumption();
|
|
17771
19522
|
* result.forEach((row) => {
|
|
17772
|
-
* console.log(`${row.agentId}: ${row.agentUnitsConsumed}
|
|
19523
|
+
* console.log(`${row.agentId}: ${row.agentUnitsConsumed} Agent Units, ${row.platformUnitsConsumed} Platform Units`);
|
|
17773
19524
|
* });
|
|
17774
19525
|
* ```
|
|
17775
19526
|
* @example
|
|
@@ -17808,10 +19559,6 @@ interface AgentTracesServiceModel {
|
|
|
17808
19559
|
/**
|
|
17809
19560
|
* Retrieves spans whose reference hierarchy contains the given reference id.
|
|
17810
19561
|
*
|
|
17811
|
-
* Returns a {@link PaginatedResponse} when pagination options (`pageSize`,
|
|
17812
|
-
* `cursor`, or `jumpToPage`) are provided, otherwise a
|
|
17813
|
-
* {@link NonPaginatedResponse}.
|
|
17814
|
-
*
|
|
17815
19562
|
* @param referenceId - Reference id matched against each span's reference hierarchy
|
|
17816
19563
|
* @param options - Optional pagination and hierarchy/time filters
|
|
17817
19564
|
* @returns Promise resolving to a paginated or non-paginated list of {@link AgentSpanGetResponse}
|
|
@@ -17844,6 +19591,104 @@ interface AgentTracesServiceModel {
|
|
|
17844
19591
|
* ```
|
|
17845
19592
|
*/
|
|
17846
19593
|
getSpansByReference<T extends AgentTraceGetSpansByReferenceOptions = AgentTraceGetSpansByReferenceOptions>(referenceId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<AgentSpanGetResponse> : NonPaginatedResponse<AgentSpanGetResponse>>;
|
|
19594
|
+
/**
|
|
19595
|
+
* Lists individual governance decisions from agent execution traces — each
|
|
19596
|
+
* policy check's allow/deny outcome with its agent, policy, pack, hook, and
|
|
19597
|
+
* mode, plus the trace it belongs to — over the requested window. Filterable
|
|
19598
|
+
* and paginated.
|
|
19599
|
+
*
|
|
19600
|
+
* @remarks Requires the caller to be an organization admin. Non-admin callers get a `403` and the SDK throws an {@link AuthorizationError}.
|
|
19601
|
+
*
|
|
19602
|
+
* @param startTime - Inclusive lower bound for the query window
|
|
19603
|
+
* @param options - Optional window end, filters, and pagination
|
|
19604
|
+
* @returns Promise resolving to a paginated or non-paginated list of {@link AgentGovernanceDecisionGetResponse}
|
|
19605
|
+
* @example
|
|
19606
|
+
* ```typescript
|
|
19607
|
+
* import { AgentTraces } from '@uipath/uipath-typescript/traces';
|
|
19608
|
+
*
|
|
19609
|
+
* const trace = new AgentTraces(sdk);
|
|
19610
|
+
*
|
|
19611
|
+
* // Decision rows since a start time
|
|
19612
|
+
* const result = await trace.getGovernanceDecisions(new Date('2025-05-01T00:00:00Z'));
|
|
19613
|
+
* result.items.forEach((row) => {
|
|
19614
|
+
* console.log(`${row.hook} ${row.policyId}: ${row.evaluatorResult}`);
|
|
19615
|
+
* });
|
|
19616
|
+
* ```
|
|
19617
|
+
* @example
|
|
19618
|
+
* ```typescript
|
|
19619
|
+
* // Violations only, for one agent, paginated
|
|
19620
|
+
* const page = await trace.getGovernanceDecisions(new Date('2025-05-01T00:00:00Z'), {
|
|
19621
|
+
* endTime: new Date('2025-06-01T00:00:00Z'),
|
|
19622
|
+
* violationsOnly: true,
|
|
19623
|
+
* agentId: '<agentProjectKey>',
|
|
19624
|
+
* pageSize: 25,
|
|
19625
|
+
* });
|
|
19626
|
+
* if (page.hasNextPage && page.nextCursor) {
|
|
19627
|
+
* const next = await trace.getGovernanceDecisions(new Date('2025-05-01T00:00:00Z'), { cursor: page.nextCursor });
|
|
19628
|
+
* }
|
|
19629
|
+
* ```
|
|
19630
|
+
* @example
|
|
19631
|
+
* ```typescript
|
|
19632
|
+
* import { isAuthorizationError } from '@uipath/uipath-typescript/core';
|
|
19633
|
+
*
|
|
19634
|
+
* // Non-admin callers get a 403
|
|
19635
|
+
* try {
|
|
19636
|
+
* await trace.getGovernanceDecisions(new Date('2025-05-01T00:00:00Z'));
|
|
19637
|
+
* } catch (error) {
|
|
19638
|
+
* if (isAuthorizationError(error)) {
|
|
19639
|
+
* console.error('Governance data requires an organization admin.');
|
|
19640
|
+
* }
|
|
19641
|
+
* }
|
|
19642
|
+
* ```
|
|
19643
|
+
*/
|
|
19644
|
+
getGovernanceDecisions<T extends AgentGovernanceDecisionsOptions = AgentGovernanceDecisionsOptions>(startTime: Date, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<AgentGovernanceDecisionGetResponse> : NonPaginatedResponse<AgentGovernanceDecisionGetResponse>>;
|
|
19645
|
+
/**
|
|
19646
|
+
* Summarizes governance decisions across agent execution traces — total
|
|
19647
|
+
* decisions and violations, plus top breakdowns by hook, agent, policy, and
|
|
19648
|
+
* pack — over the requested window. Filterable.
|
|
19649
|
+
*
|
|
19650
|
+
* @remarks Requires the caller to be an organization admin. Non-admin callers get a `403` and the SDK throws an {@link AuthorizationError}.
|
|
19651
|
+
*
|
|
19652
|
+
* @param startTime - Inclusive lower bound for the query window
|
|
19653
|
+
* @param options - Optional window end, top-N, pack scope, and sections
|
|
19654
|
+
* @returns Promise resolving to {@link AgentGovernanceGetSummaryResponse}
|
|
19655
|
+
* @example
|
|
19656
|
+
* ```typescript
|
|
19657
|
+
* import { AgentTraces } from '@uipath/uipath-typescript/traces';
|
|
19658
|
+
*
|
|
19659
|
+
* const trace = new AgentTraces(sdk);
|
|
19660
|
+
*
|
|
19661
|
+
* // Default posture since a start time
|
|
19662
|
+
* const summary = await trace.getGovernanceSummary(new Date('2025-05-01T00:00:00Z'));
|
|
19663
|
+
* console.log(`${summary.violations} / ${summary.total} violations`);
|
|
19664
|
+
* summary.byPolicy.forEach((p) => console.log(`${p.key}: ${p.violationCount}`));
|
|
19665
|
+
* ```
|
|
19666
|
+
* @example
|
|
19667
|
+
* ```typescript
|
|
19668
|
+
* import { AgentGovernanceSection } from '@uipath/uipath-typescript/traces';
|
|
19669
|
+
*
|
|
19670
|
+
* // Top 5 per breakdown, scoped to a pack, including the opt-in action/mode sections
|
|
19671
|
+
* const summary = await trace.getGovernanceSummary(new Date('2025-05-01T00:00:00Z'), {
|
|
19672
|
+
* topN: 5,
|
|
19673
|
+
* packName: 'ISO/IEC 42001:2023 Runtime',
|
|
19674
|
+
* sections: [AgentGovernanceSection.Action, AgentGovernanceSection.Mode],
|
|
19675
|
+
* });
|
|
19676
|
+
* ```
|
|
19677
|
+
* @example
|
|
19678
|
+
* ```typescript
|
|
19679
|
+
* import { isAuthorizationError } from '@uipath/uipath-typescript/core';
|
|
19680
|
+
*
|
|
19681
|
+
* // Non-admin callers get a 403
|
|
19682
|
+
* try {
|
|
19683
|
+
* await trace.getGovernanceSummary(new Date('2025-05-01T00:00:00Z'));
|
|
19684
|
+
* } catch (error) {
|
|
19685
|
+
* if (isAuthorizationError(error)) {
|
|
19686
|
+
* console.error('Governance data requires an organization admin.');
|
|
19687
|
+
* }
|
|
19688
|
+
* }
|
|
19689
|
+
* ```
|
|
19690
|
+
*/
|
|
19691
|
+
getGovernanceSummary(startTime: Date, options?: AgentGovernanceSummaryOptions): Promise<AgentGovernanceGetSummaryResponse>;
|
|
17847
19692
|
}
|
|
17848
19693
|
|
|
17849
19694
|
/**
|
|
@@ -18119,5 +19964,5 @@ declare const telemetryClient: {
|
|
|
18119
19964
|
setUserId(userId: string): void;
|
|
18120
19965
|
};
|
|
18121
19966
|
|
|
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 };
|
|
19967
|
+
export { AgentErrorSortColumn, AgentExecutionType, AgentGovernanceMode, AgentGovernanceSection, AgentGovernanceVerdict, AgentListSortColumn, AgentMap, AgentMemoryExecutionType, SpanExecutionType as AgentTraceExecutionType, AgentType, 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 };
|
|
19968
|
+
export type { AgentAppearance, AgentConsumption, AgentConversationServiceModel, AgentCreateConversationOptions, AgentError, AgentErrorOrderBy, AgentFilterOptions, AgentGetAllOptions, AgentGetByIdResponse, AgentGetConsumptionTimelineOptions, AgentGetConsumptionTimelineResponse, AgentGetErrorsOptions, AgentGetErrorsTimelineOptions, AgentGetErrorsTimelineResponse, AgentGetIncidentDistributionOptions, AgentGetIncidentDistributionResponse, AgentGetLatencyTimelineOptions, AgentGetLatencyTimelineResponse, AgentGetResponse, AgentGetSummaryOptions, AgentGetSummaryResponse, AgentGetTopConsumptionOptions, AgentGetTopConsumptionResponse, AgentGetTopErrorCountOptions, AgentGetTopErrorCountResponse, AgentGetUnitConsumptionSummaryOptions, AgentGetUnitConsumptionSummaryResponse, AgentGovernanceCountItem, AgentGovernanceDecisionGetResponse, AgentGovernanceDecisionsOptions, AgentGovernanceGetSummaryResponse, AgentGovernanceSummaryOptions, AgentInput, AgentJobConsumptionSummary, AgentJobInfo, AgentListItem, AgentListOrderBy, AgentMemoryFilterOptions, AgentMemoryGetCallsTimelineOptions, AgentMemoryGetCallsTimelineResponse, AgentMemoryGetTimelineOptions, AgentMemoryGetTimelineResponse, AgentMemoryGetTopSpacesOptions, AgentMemoryGetTopSpacesResponse, AgentMemoryServiceModel, AgentMethods, AgentServiceModel, AgentSpanGetResponse, AgentStartingPrompt, AgentSummaryEntry, AgentSummaryPeriod, AgentTopErrorCount, AgentTraceFilterOptions, AgentTraceGetErrorsTimelineOptions, AgentTraceGetErrorsTimelineResponse, AgentTraceGetLatencyTimelineOptions, AgentTraceGetLatencyTimelineResponse, AgentTraceGetSpansByReferenceOptions, AgentTraceGetUnitConsumptionOptions, AgentTraceGetUnitConsumptionResponse, AgentTracesServiceModel, AgentUnitConsumptionEntry, AgentUnitConsumptionPeriod, 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, ClientSideTool, 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, DurationStats, 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, ExecutingToolCallEvent, 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, IncidentTimelineResponse, InlineOrExternalValue, InlineValue, InstanceStats, InstanceStatusTimelineResponse, Interrupt, InterruptEndEvent, InterruptEvent, InterruptStartEvent, JSONArray, JSONObject, JSONPrimitive, JSONValue, JobAttachment, JobError, JobGetAllOptions, JobGetByIdOptions, JobGetResponse, JobMethods, JobResumeOptions, JobServiceModel, JobStopOptions, LabelUpdatedEvent, Machine, MaestroProcessGetAllResponse, MaestroProcessStatsRequest, 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 };
|