@uipath/uipath-typescript 1.3.6 → 1.3.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/assets/index.cjs +243 -6
- package/dist/assets/index.d.ts +113 -13
- package/dist/assets/index.mjs +243 -6
- package/dist/attachments/index.cjs +42 -6
- package/dist/attachments/index.d.ts +8 -0
- package/dist/attachments/index.mjs +42 -6
- package/dist/buckets/index.cjs +211 -6
- package/dist/buckets/index.d.ts +57 -12
- package/dist/buckets/index.mjs +211 -6
- package/dist/cases/index.cjs +180 -6
- package/dist/cases/index.d.ts +165 -3
- package/dist/cases/index.mjs +181 -7
- package/dist/conversational-agent/index.cjs +235 -85
- package/dist/conversational-agent/index.d.ts +327 -80
- package/dist/conversational-agent/index.mjs +234 -84
- package/dist/core/index.cjs +18 -6
- package/dist/core/index.d.ts +1 -1
- package/dist/core/index.mjs +18 -6
- package/dist/entities/index.cjs +74 -10
- package/dist/entities/index.d.ts +102 -11
- package/dist/entities/index.mjs +75 -11
- package/dist/feedback/index.cjs +293 -10
- package/dist/feedback/index.d.ts +425 -12
- package/dist/feedback/index.mjs +293 -10
- package/dist/index.cjs +463 -17
- package/dist/index.d.ts +885 -39
- package/dist/index.mjs +464 -18
- package/dist/index.umd.js +463 -17
- package/dist/jobs/index.cjs +211 -6
- package/dist/jobs/index.d.ts +68 -23
- package/dist/jobs/index.mjs +211 -6
- package/dist/maestro-processes/index.cjs +79 -6
- package/dist/maestro-processes/index.d.ts +8 -0
- package/dist/maestro-processes/index.mjs +79 -6
- package/dist/processes/index.cjs +279 -7
- package/dist/processes/index.d.ts +125 -2
- package/dist/processes/index.mjs +279 -7
- package/dist/queues/index.cjs +211 -6
- package/dist/queues/index.d.ts +57 -12
- package/dist/queues/index.mjs +211 -6
- package/dist/tasks/index.cjs +42 -6
- package/dist/tasks/index.d.ts +8 -0
- package/dist/tasks/index.mjs +42 -6
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -276,6 +276,7 @@ interface RequestWithPaginationOptions extends RequestSpec {
|
|
|
276
276
|
offsetParam?: string;
|
|
277
277
|
tokenParam?: string;
|
|
278
278
|
countParam?: string;
|
|
279
|
+
convertToSkip?: boolean;
|
|
279
280
|
};
|
|
280
281
|
};
|
|
281
282
|
}
|
|
@@ -388,6 +389,13 @@ interface ApiResponse<T> {
|
|
|
388
389
|
*/
|
|
389
390
|
declare class BaseService {
|
|
390
391
|
#private;
|
|
392
|
+
/**
|
|
393
|
+
* SDK configuration (read-only). Available to subclasses so they can
|
|
394
|
+
* fall back to init-time defaults like `folderKey`.
|
|
395
|
+
*/
|
|
396
|
+
protected readonly config: {
|
|
397
|
+
folderKey?: string;
|
|
398
|
+
};
|
|
391
399
|
/**
|
|
392
400
|
* Creates a base service instance with dependency injection.
|
|
393
401
|
*
|
|
@@ -643,7 +651,31 @@ interface EntityQuerySortOption {
|
|
|
643
651
|
isDescending?: boolean;
|
|
644
652
|
}
|
|
645
653
|
/**
|
|
646
|
-
*
|
|
654
|
+
* Aggregate functions supported by the Data Fabric query API.
|
|
655
|
+
*/
|
|
656
|
+
declare enum EntityAggregateFunction {
|
|
657
|
+
Count = "COUNT",
|
|
658
|
+
Sum = "SUM",
|
|
659
|
+
Avg = "AVG",
|
|
660
|
+
Min = "MIN",
|
|
661
|
+
Max = "MAX"
|
|
662
|
+
}
|
|
663
|
+
/**
|
|
664
|
+
* A single aggregate expression to apply during a query.
|
|
665
|
+
*
|
|
666
|
+
* Aggregate results are returned as fields on each item in the response,
|
|
667
|
+
* keyed by `alias` when provided.
|
|
668
|
+
*/
|
|
669
|
+
interface EntityAggregate {
|
|
670
|
+
/** Aggregate function to apply */
|
|
671
|
+
function: EntityAggregateFunction;
|
|
672
|
+
/** Field to aggregate on. For `COUNT`, any non-null field works (typically `Id`). */
|
|
673
|
+
field: string;
|
|
674
|
+
/** Optional alias for the aggregate result column. */
|
|
675
|
+
alias?: string;
|
|
676
|
+
}
|
|
677
|
+
/**
|
|
678
|
+
* Options for querying entity records with filters, sorting, aggregates, and pagination.
|
|
647
679
|
*
|
|
648
680
|
* Use `pageSize`, `cursor`, or `jumpToPage` for SDK-managed pagination.
|
|
649
681
|
* The SDK computes and manages offset parameters automatically.
|
|
@@ -657,6 +689,10 @@ type EntityQueryRecordsOptions = {
|
|
|
657
689
|
sortOptions?: EntityQuerySortOption[];
|
|
658
690
|
/** Level of entity expansion for related fields (default: 0) */
|
|
659
691
|
expansionLevel?: number;
|
|
692
|
+
/** Aggregate expressions (COUNT, SUM, AVG, MIN, MAX) to apply across the result set. */
|
|
693
|
+
aggregates?: EntityAggregate[];
|
|
694
|
+
/** Field names to group aggregate results by. */
|
|
695
|
+
groupBy?: string[];
|
|
660
696
|
} & PaginationOptions;
|
|
661
697
|
/**
|
|
662
698
|
* Response from querying entity records
|
|
@@ -1336,15 +1372,15 @@ interface EntityServiceModel {
|
|
|
1336
1372
|
*/
|
|
1337
1373
|
deleteRecordById(entityId: string, recordId: string): Promise<void>;
|
|
1338
1374
|
/**
|
|
1339
|
-
* Queries entity records with filters, sorting, and SDK-managed pagination
|
|
1375
|
+
* Queries entity records with filters, sorting, aggregates, and SDK-managed pagination
|
|
1340
1376
|
*
|
|
1341
1377
|
* @param id - UUID of the entity
|
|
1342
|
-
* @param options - Query options including filterGroup, selectedFields, sortOptions, and pagination
|
|
1378
|
+
* @param options - Query options including filterGroup, selectedFields, sortOptions, aggregates, groupBy, and pagination
|
|
1343
1379
|
* @returns Promise resolving to {@link NonPaginatedResponse} without pagination options,
|
|
1344
1380
|
* or {@link PaginatedResponse} when `pageSize`, `cursor`, or `jumpToPage` are provided
|
|
1345
1381
|
* @example
|
|
1346
1382
|
* ```typescript
|
|
1347
|
-
* import { Entities, LogicalOperator, QueryFilterOperator } from '@uipath/uipath-typescript/entities';
|
|
1383
|
+
* import { Entities, LogicalOperator, QueryFilterOperator, EntityAggregateFunction } from '@uipath/uipath-typescript/entities';
|
|
1348
1384
|
*
|
|
1349
1385
|
* const entities = new Entities(sdk);
|
|
1350
1386
|
*
|
|
@@ -1363,6 +1399,23 @@ interface EntityServiceModel {
|
|
|
1363
1399
|
* if (page1.hasNextPage) {
|
|
1364
1400
|
* const page2 = await entities.queryRecordsById(<id>, { cursor: page1.nextCursor });
|
|
1365
1401
|
* }
|
|
1402
|
+
*
|
|
1403
|
+
* // Aggregate: count of records per status
|
|
1404
|
+
* await entities.queryRecordsById(<id>, {
|
|
1405
|
+
* selectedFields: ["status"],
|
|
1406
|
+
* groupBy: ["status"],
|
|
1407
|
+
* aggregates: [
|
|
1408
|
+
* { function: EntityAggregateFunction.Count, field: "Id", alias: "total" },
|
|
1409
|
+
* ],
|
|
1410
|
+
* });
|
|
1411
|
+
*
|
|
1412
|
+
* // Aggregate: total sum and average across all records (no grouping)
|
|
1413
|
+
* await entities.queryRecordsById(<id>, {
|
|
1414
|
+
* aggregates: [
|
|
1415
|
+
* { function: EntityAggregateFunction.Sum, field: "amount", alias: "totalAmount" },
|
|
1416
|
+
* { function: EntityAggregateFunction.Avg, field: "amount", alias: "avgAmount" },
|
|
1417
|
+
* ],
|
|
1418
|
+
* });
|
|
1366
1419
|
* ```
|
|
1367
1420
|
*/
|
|
1368
1421
|
queryRecordsById<T extends EntityQueryRecordsOptions = EntityQueryRecordsOptions>(id: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<EntityRecord> : NonPaginatedResponse<EntityRecord>>;
|
|
@@ -1712,13 +1765,17 @@ interface EntityMethods {
|
|
|
1712
1765
|
*/
|
|
1713
1766
|
batchInsert(data: Record<string, any>[], options?: EntityBatchInsertOptions): Promise<EntityBatchInsertResponse>;
|
|
1714
1767
|
/**
|
|
1715
|
-
* Queries records in this entity with filters, sorting, and SDK-managed pagination
|
|
1768
|
+
* Queries records in this entity with filters, sorting, aggregates, and SDK-managed pagination
|
|
1716
1769
|
*
|
|
1717
|
-
* @param options - Query options including filterGroup, selectedFields, sortOptions, and pagination
|
|
1770
|
+
* @param options - Query options including filterGroup, selectedFields, sortOptions, aggregates, groupBy, and pagination
|
|
1718
1771
|
* @returns Promise resolving to {@link NonPaginatedResponse} without pagination options,
|
|
1719
1772
|
* or {@link PaginatedResponse} when `pageSize`, `cursor`, or `jumpToPage` are provided
|
|
1720
1773
|
* @example
|
|
1721
1774
|
* ```typescript
|
|
1775
|
+
* import { Entities, LogicalOperator, QueryFilterOperator, EntityAggregateFunction } from '@uipath/uipath-typescript/entities';
|
|
1776
|
+
*
|
|
1777
|
+
* const entities = new Entities(sdk);
|
|
1778
|
+
*
|
|
1722
1779
|
* const entity = await entities.getById(<entityId>);
|
|
1723
1780
|
* const result = await entity.queryRecords({
|
|
1724
1781
|
* filterGroup: {
|
|
@@ -1728,6 +1785,23 @@ interface EntityMethods {
|
|
|
1728
1785
|
* sortOptions: [{ fieldName: "createdTime", isDescending: true }],
|
|
1729
1786
|
* });
|
|
1730
1787
|
* console.log(`Found ${result.totalCount} records`);
|
|
1788
|
+
*
|
|
1789
|
+
* // Aggregate: count of records per status
|
|
1790
|
+
* await entity.queryRecords({
|
|
1791
|
+
* selectedFields: ["status"],
|
|
1792
|
+
* groupBy: ["status"],
|
|
1793
|
+
* aggregates: [
|
|
1794
|
+
* { function: EntityAggregateFunction.Count, field: "Id", alias: "total" },
|
|
1795
|
+
* ],
|
|
1796
|
+
* });
|
|
1797
|
+
*
|
|
1798
|
+
* // Aggregate: total sum and average across all records (no grouping)
|
|
1799
|
+
* await entity.queryRecords({
|
|
1800
|
+
* aggregates: [
|
|
1801
|
+
* { function: EntityAggregateFunction.Sum, field: "amount", alias: "totalAmount" },
|
|
1802
|
+
* { function: EntityAggregateFunction.Avg, field: "amount", alias: "avgAmount" },
|
|
1803
|
+
* ],
|
|
1804
|
+
* });
|
|
1731
1805
|
* ```
|
|
1732
1806
|
*/
|
|
1733
1807
|
queryRecords<T extends EntityQueryRecordsOptions = EntityQueryRecordsOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<EntityRecord> : NonPaginatedResponse<EntityRecord>>;
|
|
@@ -2060,16 +2134,16 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2060
2134
|
*/
|
|
2061
2135
|
getAll(): Promise<EntityGetResponse[]>;
|
|
2062
2136
|
/**
|
|
2063
|
-
* Queries entity records with filters, sorting, and pagination
|
|
2137
|
+
* Queries entity records with filters, sorting, aggregates, and pagination
|
|
2064
2138
|
*
|
|
2065
2139
|
* @param id - UUID of the entity
|
|
2066
|
-
* @param options - Query options including filterGroup, selectedFields, sortOptions, and pagination
|
|
2140
|
+
* @param options - Query options including filterGroup, selectedFields, sortOptions, aggregates, groupBy, and pagination
|
|
2067
2141
|
* @returns Promise resolving to {@link NonPaginatedResponse} without pagination options,
|
|
2068
2142
|
* or {@link PaginatedResponse} when `pageSize`, `cursor`, or `jumpToPage` are provided
|
|
2069
2143
|
*
|
|
2070
2144
|
* @example
|
|
2071
2145
|
* ```typescript
|
|
2072
|
-
* import { Entities, LogicalOperator, QueryFilterOperator } from '@uipath/uipath-typescript/entities';
|
|
2146
|
+
* import { Entities, LogicalOperator, QueryFilterOperator, EntityAggregateFunction } from '@uipath/uipath-typescript/entities';
|
|
2073
2147
|
*
|
|
2074
2148
|
* const entities = new Entities(sdk);
|
|
2075
2149
|
*
|
|
@@ -2093,6 +2167,23 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2093
2167
|
* if (page1.hasNextPage) {
|
|
2094
2168
|
* const page2 = await entities.queryRecordsById("<entityId>", { cursor: page1.nextCursor });
|
|
2095
2169
|
* }
|
|
2170
|
+
*
|
|
2171
|
+
* // Aggregate: count of records per status
|
|
2172
|
+
* await entities.queryRecordsById("<entityId>", {
|
|
2173
|
+
* selectedFields: ["status"],
|
|
2174
|
+
* groupBy: ["status"],
|
|
2175
|
+
* aggregates: [
|
|
2176
|
+
* { function: EntityAggregateFunction.Count, field: "Id", alias: "total" },
|
|
2177
|
+
* ],
|
|
2178
|
+
* });
|
|
2179
|
+
*
|
|
2180
|
+
* // Aggregate: total sum and average across all records (no grouping)
|
|
2181
|
+
* await entities.queryRecordsById("<entityId>", {
|
|
2182
|
+
* aggregates: [
|
|
2183
|
+
* { function: EntityAggregateFunction.Sum, field: "amount", alias: "totalAmount" },
|
|
2184
|
+
* { function: EntityAggregateFunction.Avg, field: "amount", alias: "avgAmount" },
|
|
2185
|
+
* ],
|
|
2186
|
+
* });
|
|
2096
2187
|
* ```
|
|
2097
2188
|
*/
|
|
2098
2189
|
queryRecordsById<T extends EntityQueryRecordsOptions = EntityQueryRecordsOptions>(id: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<EntityRecord> : NonPaginatedResponse<EntityRecord>>;
|
|
@@ -2946,6 +3037,20 @@ interface RequestOptions extends BaseOptions {
|
|
|
2946
3037
|
filter?: string;
|
|
2947
3038
|
orderby?: string;
|
|
2948
3039
|
}
|
|
3040
|
+
/**
|
|
3041
|
+
* Options that scope a name-based lookup (e.g. `getByName`) to a folder.
|
|
3042
|
+
* Provide one of `folderId`, `folderKey`, or `folderPath`. When more than
|
|
3043
|
+
* one is supplied, all are forwarded; the server applies precedence
|
|
3044
|
+
* `folderPath` > `folderKey` > `folderId`.
|
|
3045
|
+
*/
|
|
3046
|
+
interface FolderScopedOptions extends BaseOptions {
|
|
3047
|
+
/** Numeric folder ID. */
|
|
3048
|
+
folderId?: number;
|
|
3049
|
+
/** Folder key (GUID-formatted string). */
|
|
3050
|
+
folderKey?: string;
|
|
3051
|
+
/** Slash-delimited folder path, e.g. `'Shared/Finance'`. */
|
|
3052
|
+
folderPath?: string;
|
|
3053
|
+
}
|
|
2949
3054
|
|
|
2950
3055
|
/**
|
|
2951
3056
|
* Service for managing UiPath Maestro Process instances
|
|
@@ -3439,6 +3544,78 @@ interface CaseAppConfig {
|
|
|
3439
3544
|
caseSummary?: string;
|
|
3440
3545
|
overview?: CaseAppOverview[];
|
|
3441
3546
|
}
|
|
3547
|
+
/**
|
|
3548
|
+
* SLA status for a case instance
|
|
3549
|
+
*/
|
|
3550
|
+
declare enum SlaSummaryStatus {
|
|
3551
|
+
/** Case is within SLA deadline */
|
|
3552
|
+
ON_TRACK = "On Track",
|
|
3553
|
+
/** Case is approaching SLA deadline based on at-risk percentage threshold */
|
|
3554
|
+
AT_RISK = "At Risk",
|
|
3555
|
+
/** Case has exceeded SLA deadline */
|
|
3556
|
+
OVERDUE = "Overdue",
|
|
3557
|
+
/** Case instance has completed */
|
|
3558
|
+
COMPLETED = "Completed",
|
|
3559
|
+
/** SLA status cannot be determined (no SLA deadline defined) */
|
|
3560
|
+
UNKNOWN = "Unknown"
|
|
3561
|
+
}
|
|
3562
|
+
/**
|
|
3563
|
+
* Instance status values for case instances and process instances
|
|
3564
|
+
*/
|
|
3565
|
+
declare enum InstanceStatus {
|
|
3566
|
+
/** Instance status not yet populated by the backend */
|
|
3567
|
+
UNKNOWN = "",
|
|
3568
|
+
CANCELLED = "Cancelled",
|
|
3569
|
+
CANCELING = "Canceling",
|
|
3570
|
+
COMPLETED = "Completed",
|
|
3571
|
+
FAULTED = "Faulted",
|
|
3572
|
+
PAUSED = "Paused",
|
|
3573
|
+
PAUSING = "Pausing",
|
|
3574
|
+
PENDING = "Pending",
|
|
3575
|
+
RESUMING = "Resuming",
|
|
3576
|
+
RETRYING = "Retrying",
|
|
3577
|
+
RUNNING = "Running",
|
|
3578
|
+
UPGRADING = "Upgrading"
|
|
3579
|
+
}
|
|
3580
|
+
/**
|
|
3581
|
+
* SLA summary response for a single case instance
|
|
3582
|
+
*/
|
|
3583
|
+
interface SlaSummaryResponse {
|
|
3584
|
+
/** Unique identifier of the case instance */
|
|
3585
|
+
caseInstanceId: string;
|
|
3586
|
+
/** Folder key that the case instance belongs to */
|
|
3587
|
+
folderKey: string;
|
|
3588
|
+
/** Display name of the SLA rule */
|
|
3589
|
+
name: string;
|
|
3590
|
+
/** Human-readable reference number for a case instance */
|
|
3591
|
+
externalId: string;
|
|
3592
|
+
/** Summary text for the case instance — may be empty */
|
|
3593
|
+
caseSummary: string;
|
|
3594
|
+
/** Unique key of the process associated with the case instance */
|
|
3595
|
+
processKey: string;
|
|
3596
|
+
/** SLA deadline timestamp in UTC (ISO 8601 format) */
|
|
3597
|
+
slaDueTime: string;
|
|
3598
|
+
/** Current SLA status indicating whether the deadline is met, at risk, or breached */
|
|
3599
|
+
slaStatus: SlaSummaryStatus;
|
|
3600
|
+
/** Index of the escalation rule currently applied to the SLA */
|
|
3601
|
+
escalationRuleIndex: string;
|
|
3602
|
+
escalationRuleType: EscalationTriggerType;
|
|
3603
|
+
/** Current status of the case instance */
|
|
3604
|
+
instanceStatus: InstanceStatus;
|
|
3605
|
+
/** Last modification timestamp in UTC (ISO 8601 format) */
|
|
3606
|
+
lastModifiedTime: string;
|
|
3607
|
+
}
|
|
3608
|
+
/**
|
|
3609
|
+
* Options for querying SLA summary
|
|
3610
|
+
*/
|
|
3611
|
+
type CaseInstanceSlaSummaryOptions = PaginationOptions & {
|
|
3612
|
+
/** Filter to a specific case instance */
|
|
3613
|
+
caseInstanceId?: string;
|
|
3614
|
+
/** Filter by event start time in UTC */
|
|
3615
|
+
startTimeUtc?: Date;
|
|
3616
|
+
/** Filter by event end time in UTC */
|
|
3617
|
+
endTimeUtc?: Date;
|
|
3618
|
+
};
|
|
3442
3619
|
/**
|
|
3443
3620
|
* Case stage task type
|
|
3444
3621
|
*/
|
|
@@ -3497,7 +3674,9 @@ interface EscalationAction {
|
|
|
3497
3674
|
*/
|
|
3498
3675
|
declare enum EscalationTriggerType {
|
|
3499
3676
|
SLA_BREACHED = "sla-breached",
|
|
3500
|
-
AT_RISK = "at-risk"
|
|
3677
|
+
AT_RISK = "at-risk",
|
|
3678
|
+
/** Default value when no escalation rule is defined */
|
|
3679
|
+
NONE = "None"
|
|
3501
3680
|
}
|
|
3502
3681
|
/**
|
|
3503
3682
|
* Escalation rule trigger metadata
|
|
@@ -4391,6 +4570,42 @@ interface CaseInstancesServiceModel {
|
|
|
4391
4570
|
* ```
|
|
4392
4571
|
*/
|
|
4393
4572
|
getActionTasks<T extends TaskGetAllOptions = TaskGetAllOptions>(caseInstanceId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<TaskGetResponse> : NonPaginatedResponse<TaskGetResponse>>;
|
|
4573
|
+
/**
|
|
4574
|
+
* Get SLA summary for all case instances across folders.
|
|
4575
|
+
*
|
|
4576
|
+
* Returns SLA status, due times, escalation info, and instance metadata for each case instance.
|
|
4577
|
+
* The default page size is 50, so only the top 50 items are returned when no pagination options are provided.
|
|
4578
|
+
*
|
|
4579
|
+
* @param options - Optional filtering and pagination options
|
|
4580
|
+
* @returns Promise resolving to {@link SlaSummaryResponse}, paginated or non-paginated based on options
|
|
4581
|
+
* @example
|
|
4582
|
+
* ```typescript
|
|
4583
|
+
* // Non-paginated (returns top 50 items by default)
|
|
4584
|
+
* const summary = await caseInstances.getSlaSummary();
|
|
4585
|
+
* console.log(`Found ${summary.totalCount} cases`);
|
|
4586
|
+
*
|
|
4587
|
+
* // Filter by case instance ID
|
|
4588
|
+
* const filtered = await caseInstances.getSlaSummary({
|
|
4589
|
+
* caseInstanceId: '<caseInstanceId>'
|
|
4590
|
+
* });
|
|
4591
|
+
*
|
|
4592
|
+
* // Filter by time range
|
|
4593
|
+
* const timeFiltered = await caseInstances.getSlaSummary({
|
|
4594
|
+
* startTimeUtc: new Date('2026-01-01'),
|
|
4595
|
+
* endTimeUtc: new Date('2026-01-31')
|
|
4596
|
+
* });
|
|
4597
|
+
*
|
|
4598
|
+
* // With pagination
|
|
4599
|
+
* const page1 = await caseInstances.getSlaSummary({ pageSize: 25 });
|
|
4600
|
+
* if (page1.hasNextPage) {
|
|
4601
|
+
* const page2 = await caseInstances.getSlaSummary({ cursor: page1.nextCursor });
|
|
4602
|
+
* }
|
|
4603
|
+
*
|
|
4604
|
+
* // Jump to specific page
|
|
4605
|
+
* const page3 = await caseInstances.getSlaSummary({ jumpToPage: 3, pageSize: 25 });
|
|
4606
|
+
* ```
|
|
4607
|
+
*/
|
|
4608
|
+
getSlaSummary<T extends CaseInstanceSlaSummaryOptions = CaseInstanceSlaSummaryOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<SlaSummaryResponse> : NonPaginatedResponse<SlaSummaryResponse>>;
|
|
4394
4609
|
}
|
|
4395
4610
|
interface CaseInstanceMethods {
|
|
4396
4611
|
/**
|
|
@@ -4440,6 +4655,14 @@ interface CaseInstanceMethods {
|
|
|
4440
4655
|
* @returns Promise resolving to human in the loop tasks associated with the case instance
|
|
4441
4656
|
*/
|
|
4442
4657
|
getActionTasks<T extends TaskGetAllOptions = TaskGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<TaskGetResponse> : NonPaginatedResponse<TaskGetResponse>>;
|
|
4658
|
+
/**
|
|
4659
|
+
* Gets the SLA summary for this case instance.
|
|
4660
|
+
* The default page size is 50, so only the top 50 items are returned when no pagination options are provided.
|
|
4661
|
+
*
|
|
4662
|
+
* @param options - Optional time range filtering and pagination options
|
|
4663
|
+
* @returns Promise resolving to SLA summary items for this case instance
|
|
4664
|
+
*/
|
|
4665
|
+
getSlaSummary<T extends Omit<CaseInstanceSlaSummaryOptions, 'caseInstanceId'> = Omit<CaseInstanceSlaSummaryOptions, 'caseInstanceId'>>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<SlaSummaryResponse> : NonPaginatedResponse<SlaSummaryResponse>>;
|
|
4443
4666
|
}
|
|
4444
4667
|
type CaseInstanceGetResponse = RawCaseInstanceGetResponse & CaseInstanceMethods;
|
|
4445
4668
|
/**
|
|
@@ -4855,6 +5078,42 @@ declare class CaseInstancesService extends BaseService implements CaseInstancesS
|
|
|
4855
5078
|
* @returns Promise resolving to human in the loop tasks associated with the case instance
|
|
4856
5079
|
*/
|
|
4857
5080
|
getActionTasks<T extends TaskGetAllOptions = TaskGetAllOptions>(caseInstanceId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<TaskGetResponse> : NonPaginatedResponse<TaskGetResponse>>;
|
|
5081
|
+
/**
|
|
5082
|
+
* Get SLA summary for all case instances across folders.
|
|
5083
|
+
*
|
|
5084
|
+
* Returns SLA status, due times, escalation info, and instance metadata for each case instance.
|
|
5085
|
+
* The default page size is 50, so only the top 50 items are returned when no pagination options are provided.
|
|
5086
|
+
*
|
|
5087
|
+
* @param options - Optional filtering and pagination options
|
|
5088
|
+
* @returns Promise resolving to {@link SlaSummaryResponse}, paginated or non-paginated based on options
|
|
5089
|
+
* @example
|
|
5090
|
+
* ```typescript
|
|
5091
|
+
* // Non-paginated (returns top 50 items by default)
|
|
5092
|
+
* const summary = await caseInstances.getSlaSummary();
|
|
5093
|
+
* console.log(`Found ${summary.totalCount} cases`);
|
|
5094
|
+
*
|
|
5095
|
+
* // Filter by case instance ID
|
|
5096
|
+
* const filtered = await caseInstances.getSlaSummary({
|
|
5097
|
+
* caseInstanceId: '<caseInstanceId>'
|
|
5098
|
+
* });
|
|
5099
|
+
*
|
|
5100
|
+
* // Filter by time range
|
|
5101
|
+
* const timeFiltered = await caseInstances.getSlaSummary({
|
|
5102
|
+
* startTimeUtc: new Date('2026-01-01'),
|
|
5103
|
+
* endTimeUtc: new Date('2026-01-31')
|
|
5104
|
+
* });
|
|
5105
|
+
*
|
|
5106
|
+
* // With pagination
|
|
5107
|
+
* const page1 = await caseInstances.getSlaSummary({ pageSize: 25 });
|
|
5108
|
+
* if (page1.hasNextPage) {
|
|
5109
|
+
* const page2 = await caseInstances.getSlaSummary({ cursor: page1.nextCursor });
|
|
5110
|
+
* }
|
|
5111
|
+
*
|
|
5112
|
+
* // Jump to specific page
|
|
5113
|
+
* const page3 = await caseInstances.getSlaSummary({ jumpToPage: 3, pageSize: 25 });
|
|
5114
|
+
* ```
|
|
5115
|
+
*/
|
|
5116
|
+
getSlaSummary<T extends CaseInstanceSlaSummaryOptions = CaseInstanceSlaSummaryOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<SlaSummaryResponse> : NonPaginatedResponse<SlaSummaryResponse>>;
|
|
4858
5117
|
}
|
|
4859
5118
|
|
|
4860
5119
|
/**
|
|
@@ -4878,6 +5137,29 @@ declare class FolderScopedService extends BaseService {
|
|
|
4878
5137
|
* @returns Promise resolving to an array of resources
|
|
4879
5138
|
*/
|
|
4880
5139
|
protected _getByFolder<T, R = T>(endpoint: string, folderId: number, options?: Record<string, any>, transformFn?: (item: T) => R): Promise<R[]>;
|
|
5140
|
+
/**
|
|
5141
|
+
* Look up a single resource by name on a folder-scoped OData collection.
|
|
5142
|
+
*
|
|
5143
|
+
* Shared by `getByName` implementations across services (Assets, Processes, etc).
|
|
5144
|
+
* Handles:
|
|
5145
|
+
* - Name validation via `validateName`
|
|
5146
|
+
* - Folder header resolution via `resolveFolderHeaders` (folderId → ID/key
|
|
5147
|
+
* header by type, folderPath → encoded path header, falls back to
|
|
5148
|
+
* init-time `config.folderKey` from the `uipath:folder-key` meta tag)
|
|
5149
|
+
* - OData `$filter=Name eq '…'` with single-quote escaping + `$top=1`
|
|
5150
|
+
* - Empty-result → `NotFoundError` with folder context in the message
|
|
5151
|
+
*
|
|
5152
|
+
* The transform step is caller-provided because each resource has its own
|
|
5153
|
+
* PascalCase → camelCase field mapping.
|
|
5154
|
+
*
|
|
5155
|
+
* @param resourceType - Resource label used in validation + error messages (e.g. 'Asset', 'Process')
|
|
5156
|
+
* @param endpoint - Folder-scoped OData collection endpoint
|
|
5157
|
+
* @param name - Resource name to search for
|
|
5158
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) + OData query options (`expand`, `select`)
|
|
5159
|
+
* @param transform - Maps a raw OData item to the typed response (e.g. PascalCase → camelCase via field map)
|
|
5160
|
+
* @throws ValidationError when inputs are malformed; NotFoundError when no match
|
|
5161
|
+
*/
|
|
5162
|
+
protected getByNameLookup<TRaw extends object, T>(resourceType: string, endpoint: string, name: string, options: FolderScopedOptions, transform: (raw: TRaw) => T): Promise<T>;
|
|
4881
5163
|
}
|
|
4882
5164
|
|
|
4883
5165
|
/**
|
|
@@ -4943,6 +5225,11 @@ type AssetGetAllOptions = RequestOptions & PaginationOptions & {
|
|
|
4943
5225
|
*/
|
|
4944
5226
|
interface AssetGetByIdOptions extends BaseOptions {
|
|
4945
5227
|
}
|
|
5228
|
+
/**
|
|
5229
|
+
* Options for getting a single asset by name
|
|
5230
|
+
*/
|
|
5231
|
+
interface AssetGetByNameOptions extends FolderScopedOptions {
|
|
5232
|
+
}
|
|
4946
5233
|
|
|
4947
5234
|
/**
|
|
4948
5235
|
* Service for managing UiPath Assets.
|
|
@@ -5004,6 +5291,29 @@ interface AssetServiceModel {
|
|
|
5004
5291
|
* ```
|
|
5005
5292
|
*/
|
|
5006
5293
|
getById(id: number, folderId: number, options?: AssetGetByIdOptions): Promise<AssetGetResponse>;
|
|
5294
|
+
/**
|
|
5295
|
+
* Retrieves a single asset by name.
|
|
5296
|
+
*
|
|
5297
|
+
* @param name - Asset name to search for
|
|
5298
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
|
|
5299
|
+
* @returns Promise resolving to a single asset
|
|
5300
|
+
* {@link AssetGetResponse}
|
|
5301
|
+
* @example
|
|
5302
|
+
* ```typescript
|
|
5303
|
+
* // By folder ID
|
|
5304
|
+
* await assets.getByName('ApiKey', { folderId: 123 });
|
|
5305
|
+
*
|
|
5306
|
+
* // By folder key (GUID)
|
|
5307
|
+
* await assets.getByName('ApiKey', { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
|
|
5308
|
+
*
|
|
5309
|
+
* // By folder path
|
|
5310
|
+
* await assets.getByName('ApiKey', { folderPath: 'Shared/Finance' });
|
|
5311
|
+
*
|
|
5312
|
+
* // With expand
|
|
5313
|
+
* await assets.getByName('ApiKey', { folderPath: 'Shared/Finance', expand: 'keyValueList' });
|
|
5314
|
+
* ```
|
|
5315
|
+
*/
|
|
5316
|
+
getByName(name: string, options?: AssetGetByNameOptions): Promise<AssetGetResponse>;
|
|
5007
5317
|
}
|
|
5008
5318
|
|
|
5009
5319
|
/**
|
|
@@ -5064,6 +5374,33 @@ declare class AssetService extends FolderScopedService implements AssetServiceMo
|
|
|
5064
5374
|
* ```
|
|
5065
5375
|
*/
|
|
5066
5376
|
getById(id: number, folderId: number, options?: AssetGetByIdOptions): Promise<AssetGetResponse>;
|
|
5377
|
+
/**
|
|
5378
|
+
* Retrieves a single asset by name.
|
|
5379
|
+
*
|
|
5380
|
+
* @param name - Asset name to search for
|
|
5381
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
|
|
5382
|
+
* @returns Promise resolving to a single asset
|
|
5383
|
+
* {@link AssetGetResponse}
|
|
5384
|
+
* @example
|
|
5385
|
+
* ```typescript
|
|
5386
|
+
* import { Assets } from '@uipath/uipath-typescript/assets';
|
|
5387
|
+
*
|
|
5388
|
+
* const assets = new Assets(sdk);
|
|
5389
|
+
*
|
|
5390
|
+
* // By folder ID
|
|
5391
|
+
* await assets.getByName('ApiKey', { folderId: 123 });
|
|
5392
|
+
*
|
|
5393
|
+
* // By folder key (GUID)
|
|
5394
|
+
* await assets.getByName('ApiKey', { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
|
|
5395
|
+
*
|
|
5396
|
+
* // By folder path
|
|
5397
|
+
* await assets.getByName('ApiKey', { folderPath: 'Shared/Finance' });
|
|
5398
|
+
*
|
|
5399
|
+
* // With expand
|
|
5400
|
+
* await assets.getByName('ApiKey', { folderPath: 'Shared/Finance', expand: 'keyValueList' });
|
|
5401
|
+
* ```
|
|
5402
|
+
*/
|
|
5403
|
+
getByName(name: string, options?: AssetGetByNameOptions): Promise<AssetGetResponse>;
|
|
5067
5404
|
}
|
|
5068
5405
|
|
|
5069
5406
|
declare enum BucketOptions {
|
|
@@ -5913,6 +6250,11 @@ type ProcessGetAllOptions = RequestOptions & PaginationOptions & {
|
|
|
5913
6250
|
*/
|
|
5914
6251
|
interface ProcessGetByIdOptions extends BaseOptions {
|
|
5915
6252
|
}
|
|
6253
|
+
/**
|
|
6254
|
+
* Options for getting a single process by name
|
|
6255
|
+
*/
|
|
6256
|
+
interface ProcessGetByNameOptions extends FolderScopedOptions {
|
|
6257
|
+
}
|
|
5916
6258
|
|
|
5917
6259
|
/**
|
|
5918
6260
|
* Enum for job sub-state
|
|
@@ -6425,6 +6767,29 @@ interface ProcessServiceModel {
|
|
|
6425
6767
|
* ```
|
|
6426
6768
|
*/
|
|
6427
6769
|
getById(id: number, folderId: number, options?: ProcessGetByIdOptions): Promise<ProcessGetResponse>;
|
|
6770
|
+
/**
|
|
6771
|
+
* Retrieves a single process by name.
|
|
6772
|
+
*
|
|
6773
|
+
* @param name - Process name to search for
|
|
6774
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
|
|
6775
|
+
* @returns Promise resolving to a single process
|
|
6776
|
+
* {@link ProcessGetResponse}
|
|
6777
|
+
* @example
|
|
6778
|
+
* ```typescript
|
|
6779
|
+
* // By folder ID
|
|
6780
|
+
* await processes.getByName('MyProcess', { folderId: 123 });
|
|
6781
|
+
*
|
|
6782
|
+
* // By folder key (GUID)
|
|
6783
|
+
* await processes.getByName('MyProcess', { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
|
|
6784
|
+
*
|
|
6785
|
+
* // By folder path
|
|
6786
|
+
* await processes.getByName('MyProcess', { folderPath: 'Shared/Finance' });
|
|
6787
|
+
*
|
|
6788
|
+
* // With expand
|
|
6789
|
+
* await processes.getByName('MyProcess', { folderPath: 'Shared/Finance', expand: 'entryPoints' });
|
|
6790
|
+
* ```
|
|
6791
|
+
*/
|
|
6792
|
+
getByName(name: string, options?: ProcessGetByNameOptions): Promise<ProcessGetResponse>;
|
|
6428
6793
|
/**
|
|
6429
6794
|
* Starts a process with the specified configuration
|
|
6430
6795
|
*
|
|
@@ -6452,7 +6817,7 @@ interface ProcessServiceModel {
|
|
|
6452
6817
|
/**
|
|
6453
6818
|
* Service for interacting with UiPath Orchestrator Processes API
|
|
6454
6819
|
*/
|
|
6455
|
-
declare class ProcessService extends
|
|
6820
|
+
declare class ProcessService extends FolderScopedService implements ProcessServiceModel {
|
|
6456
6821
|
/**
|
|
6457
6822
|
* Gets all processes across folders with optional filtering and folder scoping
|
|
6458
6823
|
*
|
|
@@ -6543,6 +6908,33 @@ declare class ProcessService extends BaseService implements ProcessServiceModel
|
|
|
6543
6908
|
* ```
|
|
6544
6909
|
*/
|
|
6545
6910
|
getById(id: number, folderId: number, options?: ProcessGetByIdOptions): Promise<ProcessGetResponse>;
|
|
6911
|
+
/**
|
|
6912
|
+
* Retrieves a single process by name.
|
|
6913
|
+
*
|
|
6914
|
+
* @param name - Process name to search for
|
|
6915
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
|
|
6916
|
+
* @returns Promise resolving to a single process
|
|
6917
|
+
* {@link ProcessGetResponse}
|
|
6918
|
+
* @example
|
|
6919
|
+
* ```typescript
|
|
6920
|
+
* import { Processes } from '@uipath/uipath-typescript/processes';
|
|
6921
|
+
*
|
|
6922
|
+
* const processes = new Processes(sdk);
|
|
6923
|
+
*
|
|
6924
|
+
* // By folder ID
|
|
6925
|
+
* await processes.getByName('MyProcess', { folderId: 123 });
|
|
6926
|
+
*
|
|
6927
|
+
* // By folder key (GUID)
|
|
6928
|
+
* await processes.getByName('MyProcess', { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
|
|
6929
|
+
*
|
|
6930
|
+
* // By folder path
|
|
6931
|
+
* await processes.getByName('MyProcess', { folderPath: 'Shared/Finance' });
|
|
6932
|
+
*
|
|
6933
|
+
* // With expand
|
|
6934
|
+
* await processes.getByName('MyProcess', { folderPath: 'Shared/Finance', expand: 'entryPoints' });
|
|
6935
|
+
* ```
|
|
6936
|
+
*/
|
|
6937
|
+
getByName(name: string, options?: ProcessGetByNameOptions): Promise<ProcessGetResponse>;
|
|
6546
6938
|
}
|
|
6547
6939
|
|
|
6548
6940
|
/**
|
|
@@ -7171,6 +7563,14 @@ declare class UiPath extends UiPath$1 {
|
|
|
7171
7563
|
get assets(): AssetService;
|
|
7172
7564
|
}
|
|
7173
7565
|
|
|
7566
|
+
/**
|
|
7567
|
+
* Meta-tag-derived config. Extends {@link PartialUiPathConfig} with
|
|
7568
|
+
* `folderKey`, which is sourced only from `<meta name="uipath:folder-key">`
|
|
7569
|
+
* (not accepted via the public SDK constructor).
|
|
7570
|
+
*/
|
|
7571
|
+
type MetaTagConfig = PartialUiPathConfig & {
|
|
7572
|
+
folderKey?: string;
|
|
7573
|
+
};
|
|
7174
7574
|
/**
|
|
7175
7575
|
* Load configuration from HTML meta tags injected at runtime.
|
|
7176
7576
|
* These meta tags are injected by @uipath/coded-apps during build
|
|
@@ -7178,7 +7578,7 @@ declare class UiPath extends UiPath$1 {
|
|
|
7178
7578
|
*
|
|
7179
7579
|
* Returns partial config with values found, or null if no meta tags present.
|
|
7180
7580
|
*/
|
|
7181
|
-
declare function loadFromMetaTags():
|
|
7581
|
+
declare function loadFromMetaTags(): MetaTagConfig | null;
|
|
7182
7582
|
|
|
7183
7583
|
/**
|
|
7184
7584
|
* Constants for Conversational Agent
|
|
@@ -8049,7 +8449,34 @@ interface ToolCallStartEvent {
|
|
|
8049
8449
|
* Optional metadata pertaining to the tool call.
|
|
8050
8450
|
*/
|
|
8051
8451
|
metaData?: MetaData;
|
|
8452
|
+
/**
|
|
8453
|
+
* Indicates that the tool call requires user confirmation before execution.
|
|
8454
|
+
* When true, the client should render a confirmation UI and respond with a
|
|
8455
|
+
* `confirmToolCall` event on the same tool call.
|
|
8456
|
+
*/
|
|
8457
|
+
requireConfirmation?: boolean;
|
|
8458
|
+
/**
|
|
8459
|
+
* JSON schema describing the tool's input parameters. Present when
|
|
8460
|
+
* `requireConfirmation` is true so the client can render an editable form.
|
|
8461
|
+
*/
|
|
8462
|
+
inputSchema?: JSONValue;
|
|
8052
8463
|
}
|
|
8464
|
+
/**
|
|
8465
|
+
* Sent by the client to approve or reject a tool call that was emitted with
|
|
8466
|
+
* `requireConfirmation: true`. Carries the user's decision and, when approved,
|
|
8467
|
+
* the (possibly edited) input the tool should execute with.
|
|
8468
|
+
*
|
|
8469
|
+
* `input` is required when `approved` is `true` and optional when `approved`
|
|
8470
|
+
* is `false`. The discriminated union enforces this at compile time so
|
|
8471
|
+
* `{ approved: true }` (no `input`) is a type error.
|
|
8472
|
+
*/
|
|
8473
|
+
type ToolCallConfirmationEvent = {
|
|
8474
|
+
approved: true;
|
|
8475
|
+
input: JSONValue;
|
|
8476
|
+
} | {
|
|
8477
|
+
approved: false;
|
|
8478
|
+
input?: JSONValue;
|
|
8479
|
+
};
|
|
8053
8480
|
/**
|
|
8054
8481
|
* Signals the end of a tool call.
|
|
8055
8482
|
*/
|
|
@@ -8110,6 +8537,11 @@ interface ToolCallEvent {
|
|
|
8110
8537
|
* Signals the end of a tool call.
|
|
8111
8538
|
*/
|
|
8112
8539
|
endToolCall?: ToolCallEndEvent;
|
|
8540
|
+
/**
|
|
8541
|
+
* Signals the user's approve/reject decision for a tool call that was
|
|
8542
|
+
* emitted with `requireConfirmation: true`.
|
|
8543
|
+
*/
|
|
8544
|
+
confirmToolCall?: ToolCallConfirmationEvent;
|
|
8113
8545
|
/**
|
|
8114
8546
|
* Allows additional events to be sent in the context of the enclosing event stream.
|
|
8115
8547
|
*/
|
|
@@ -8121,6 +8553,11 @@ interface ToolCallEvent {
|
|
|
8121
8553
|
}
|
|
8122
8554
|
/**
|
|
8123
8555
|
* Schema for tool call confirmation interrupt value.
|
|
8556
|
+
*
|
|
8557
|
+
* @deprecated Tool call confirmation now travels on {@link ToolCallStartEvent} via
|
|
8558
|
+
* `requireConfirmation: true` / `inputSchema` and is responded to with
|
|
8559
|
+
* {@link ToolCallConfirmationEvent}. This shape is retained for agents on the legacy
|
|
8560
|
+
* runtime that still emit confirmations as interrupts.
|
|
8124
8561
|
*/
|
|
8125
8562
|
interface ToolCallConfirmationValue {
|
|
8126
8563
|
/**
|
|
@@ -8142,6 +8579,10 @@ interface ToolCallConfirmationValue {
|
|
|
8142
8579
|
}
|
|
8143
8580
|
/**
|
|
8144
8581
|
* Schema for tool call confirmation end value.
|
|
8582
|
+
*
|
|
8583
|
+
* @deprecated Confirmation responses now use {@link ToolCallConfirmationEvent} (sent via
|
|
8584
|
+
* {@link ToolCallStream.sendToolCallConfirm}). This shape is retained for agents on the
|
|
8585
|
+
* legacy runtime that consume confirmations through the interrupt-end channel.
|
|
8145
8586
|
*/
|
|
8146
8587
|
interface ToolCallConfirmationEndValue {
|
|
8147
8588
|
/**
|
|
@@ -8155,6 +8596,11 @@ interface ToolCallConfirmationEndValue {
|
|
|
8155
8596
|
}
|
|
8156
8597
|
/**
|
|
8157
8598
|
* Known interrupt start event for tool call confirmation.
|
|
8599
|
+
*
|
|
8600
|
+
* @deprecated Emitted only by agents on the legacy runtime. Agents on the current runtime
|
|
8601
|
+
* express confirmation as `requireConfirmation: true` on {@link ToolCallStartEvent}, with
|
|
8602
|
+
* the client responding via {@link ToolCallConfirmationEvent} (`confirmToolCall` on
|
|
8603
|
+
* {@link ToolCallEvent}).
|
|
8158
8604
|
*/
|
|
8159
8605
|
interface ToolCallConfirmationInterruptStartEvent {
|
|
8160
8606
|
/**
|
|
@@ -8744,6 +9190,36 @@ type CompletedToolCall = ToolCallStartEvent & ToolCallEndEvent & {
|
|
|
8744
9190
|
* });
|
|
8745
9191
|
* });
|
|
8746
9192
|
* ```
|
|
9193
|
+
*
|
|
9194
|
+
* @example Migrating from legacy interrupt-based confirmation
|
|
9195
|
+
* ```typescript
|
|
9196
|
+
* // BEFORE — legacy interrupt flow
|
|
9197
|
+
* message.onInterruptStart(async ({ interruptId, startEvent }) => {
|
|
9198
|
+
* if (startEvent.type !== InterruptType.ToolCallConfirmation) return;
|
|
9199
|
+
* const { toolName, inputSchema, inputValue } = startEvent.value;
|
|
9200
|
+
*
|
|
9201
|
+
* const decision = await showConfirmationDialog({
|
|
9202
|
+
* toolName, inputSchema, input: inputValue,
|
|
9203
|
+
* });
|
|
9204
|
+
* message.sendInterruptEnd(interruptId, {
|
|
9205
|
+
* approved: decision.approved,
|
|
9206
|
+
* input: decision.editedInput,
|
|
9207
|
+
* });
|
|
9208
|
+
* });
|
|
9209
|
+
*
|
|
9210
|
+
* // AFTER — new tool-call confirmation flow
|
|
9211
|
+
* message.onToolCallStart(async (toolCall) => {
|
|
9212
|
+
* const { toolName, input, requireConfirmation, inputSchema } = toolCall.startEvent;
|
|
9213
|
+
* if (!requireConfirmation) return;
|
|
9214
|
+
*
|
|
9215
|
+
* const decision = await showConfirmationDialog({ toolName, inputSchema, input });
|
|
9216
|
+
* if (decision.approved) {
|
|
9217
|
+
* toolCall.sendToolCallConfirm({ approved: true, input: decision.editedInput });
|
|
9218
|
+
* } else {
|
|
9219
|
+
* toolCall.sendToolCallConfirm({ approved: false });
|
|
9220
|
+
* }
|
|
9221
|
+
* });
|
|
9222
|
+
* ```
|
|
8747
9223
|
*/
|
|
8748
9224
|
interface ToolCallStream {
|
|
8749
9225
|
/** Unique identifier for this tool call */
|
|
@@ -8798,6 +9274,23 @@ interface ToolCallStream {
|
|
|
8798
9274
|
* ```
|
|
8799
9275
|
*/
|
|
8800
9276
|
onToolCallEnd(cb: (endToolCall: ToolCallEndEvent) => void): () => void;
|
|
9277
|
+
/**
|
|
9278
|
+
* Registers a handler for tool call confirmation events. Fired when the
|
|
9279
|
+
* peer responds to a tool call that was emitted with
|
|
9280
|
+
* `requireConfirmation: true` on its start event.
|
|
9281
|
+
*
|
|
9282
|
+
* @param callback - Callback receiving the confirmation event
|
|
9283
|
+
* @returns Cleanup function to remove the handler
|
|
9284
|
+
*
|
|
9285
|
+
* @example Handling a confirmation response (agent-side)
|
|
9286
|
+
* ```typescript
|
|
9287
|
+
* toolCall.onToolCallConfirm(({ approved, input }) => {
|
|
9288
|
+
* if (approved) executeTool(toolCall.startEvent.toolName, input);
|
|
9289
|
+
* else cancelToolCall();
|
|
9290
|
+
* });
|
|
9291
|
+
* ```
|
|
9292
|
+
*/
|
|
9293
|
+
onToolCallConfirm(callback: (confirmToolCall: ToolCallConfirmationEvent) => void): () => void;
|
|
8801
9294
|
/**
|
|
8802
9295
|
* Ends the tool call
|
|
8803
9296
|
*
|
|
@@ -8811,6 +9304,25 @@ interface ToolCallStream {
|
|
|
8811
9304
|
* ```
|
|
8812
9305
|
*/
|
|
8813
9306
|
sendToolCallEnd(endToolCall?: ToolCallEndEvent): void;
|
|
9307
|
+
/**
|
|
9308
|
+
* Sends a tool call confirmation (approve or reject) for a tool call that
|
|
9309
|
+
* was emitted with `requireConfirmation: true`. Replaces the legacy
|
|
9310
|
+
* interrupt-based confirmation flow.
|
|
9311
|
+
*
|
|
9312
|
+
* @param confirmToolCall - The user's decision and (when approved) the
|
|
9313
|
+
* possibly-edited input the tool should execute with
|
|
9314
|
+
*
|
|
9315
|
+
* @example Approving a tool call
|
|
9316
|
+
* ```typescript
|
|
9317
|
+
* toolCall.sendToolCallConfirm({ approved: true, input: editedInput });
|
|
9318
|
+
* ```
|
|
9319
|
+
*
|
|
9320
|
+
* @example Rejecting a tool call
|
|
9321
|
+
* ```typescript
|
|
9322
|
+
* toolCall.sendToolCallConfirm({ approved: false });
|
|
9323
|
+
* ```
|
|
9324
|
+
*/
|
|
9325
|
+
sendToolCallConfirm(confirmToolCall: ToolCallConfirmationEvent): void;
|
|
8814
9326
|
/**
|
|
8815
9327
|
* Sends an error start event for this tool call
|
|
8816
9328
|
* @param args - Error details including optional error ID and message
|
|
@@ -9429,6 +9941,28 @@ interface MessageStream {
|
|
|
9429
9941
|
* ```
|
|
9430
9942
|
*/
|
|
9431
9943
|
sendInterruptEnd(interruptId: string, endInterrupt: InterruptEndEvent): void;
|
|
9944
|
+
/**
|
|
9945
|
+
* Registers a handler for tool-call confirmation events on this message
|
|
9946
|
+
*
|
|
9947
|
+
* Fired when a peer responds to a tool call that was emitted with
|
|
9948
|
+
* `requireConfirmation: true`. The handler runs at the message level, so it
|
|
9949
|
+
* fires even if no per-tool-call stream exists for the confirmed `toolCallId`.
|
|
9950
|
+
*
|
|
9951
|
+
* @param callback - Callback receiving the toolCallId and the confirmation event
|
|
9952
|
+
* @returns Cleanup function to remove the handler
|
|
9953
|
+
*
|
|
9954
|
+
* @example Handling a tool-call confirmation response
|
|
9955
|
+
* ```typescript
|
|
9956
|
+
* message.onToolCallConfirm(({ toolCallId, confirmEvent }) => {
|
|
9957
|
+
* if (confirmEvent.approved) executeTool(toolCallId, confirmEvent.input);
|
|
9958
|
+
* else cancelToolCall(toolCallId);
|
|
9959
|
+
* });
|
|
9960
|
+
* ```
|
|
9961
|
+
*/
|
|
9962
|
+
onToolCallConfirm(callback: (args: {
|
|
9963
|
+
toolCallId: string;
|
|
9964
|
+
confirmEvent: ToolCallConfirmationEvent;
|
|
9965
|
+
}) => void): () => void;
|
|
9432
9966
|
/**
|
|
9433
9967
|
* Starts a new content part stream in this message
|
|
9434
9968
|
*
|
|
@@ -11296,7 +11830,7 @@ declare const AgentMap: {
|
|
|
11296
11830
|
};
|
|
11297
11831
|
|
|
11298
11832
|
/**
|
|
11299
|
-
* Types for User Service
|
|
11833
|
+
* Types for User Settings Service
|
|
11300
11834
|
*/
|
|
11301
11835
|
/**
|
|
11302
11836
|
* Response for getting user settings
|
|
@@ -11374,46 +11908,92 @@ interface UserSettingsUpdateOptions {
|
|
|
11374
11908
|
}
|
|
11375
11909
|
|
|
11376
11910
|
/**
|
|
11377
|
-
* Service for
|
|
11911
|
+
* Service for reading and updating the current user's profile and context settings.
|
|
11378
11912
|
*
|
|
11379
|
-
* User settings are
|
|
11380
|
-
* to
|
|
11913
|
+
* User settings are user-supplied profile fields (name, email, role, department, company,
|
|
11914
|
+
* country, timezone) that the SDK passes to a UiPath Conversational Agent on every conversation
|
|
11915
|
+
* so the agent can personalize its responses. Settings are scoped to the calling user — identified
|
|
11916
|
+
* by the access token for user tokens, or by the externalUserId option for app-scoped tokens.
|
|
11381
11917
|
*
|
|
11382
|
-
*
|
|
11918
|
+
* Accessed via `conversationalAgent.user`.
|
|
11919
|
+
*
|
|
11920
|
+
* @example Read current settings
|
|
11921
|
+
* ```typescript
|
|
11922
|
+
* import { ConversationalAgent } from '@uipath/uipath-typescript/conversational-agent';
|
|
11923
|
+
*
|
|
11924
|
+
* const conversationalAgent = new ConversationalAgent(sdk);
|
|
11925
|
+
*
|
|
11926
|
+
* const settings = await conversationalAgent.user.getSettings();
|
|
11927
|
+
* console.log(settings.name, settings.email, settings.timezone);
|
|
11928
|
+
* ```
|
|
11929
|
+
*
|
|
11930
|
+
* @example Update specific fields (partial update)
|
|
11931
|
+
* ```typescript
|
|
11932
|
+
* await conversationalAgent.user.updateSettings({
|
|
11933
|
+
* name: 'John Doe',
|
|
11934
|
+
* timezone: 'America/New_York'
|
|
11935
|
+
* });
|
|
11936
|
+
* ```
|
|
11937
|
+
*
|
|
11938
|
+
* @example Clear a field by setting it to null
|
|
11939
|
+
* ```typescript
|
|
11940
|
+
* await conversationalAgent.user.updateSettings({
|
|
11941
|
+
* department: null
|
|
11942
|
+
* });
|
|
11943
|
+
* ```
|
|
11383
11944
|
*/
|
|
11384
|
-
interface
|
|
11945
|
+
interface UserSettingsServiceModel {
|
|
11385
11946
|
/**
|
|
11386
|
-
* Gets the current user's profile and context settings
|
|
11947
|
+
* Gets the current user's profile and context settings.
|
|
11387
11948
|
*
|
|
11388
|
-
*
|
|
11949
|
+
* Returns the full user settings record — profile fields the agent uses for personalization
|
|
11950
|
+
* (name, email, role, department, company, country, timezone) plus identifiers and timestamps.
|
|
11951
|
+
* Fields the user has not set are returned as `null`.
|
|
11952
|
+
*
|
|
11953
|
+
* @returns Promise resolving to the current user's settings
|
|
11389
11954
|
* {@link UserSettingsGetResponse}
|
|
11955
|
+
*
|
|
11390
11956
|
* @example
|
|
11391
11957
|
* ```typescript
|
|
11392
|
-
* const
|
|
11393
|
-
* console.log(
|
|
11394
|
-
* console.log(
|
|
11958
|
+
* const settings = await conversationalAgent.user.getSettings();
|
|
11959
|
+
* console.log(settings.name); // e.g. 'John Doe' or null
|
|
11960
|
+
* console.log(settings.email); // e.g. 'john@example.com' or null
|
|
11961
|
+
* console.log(settings.timezone); // e.g. 'America/New_York' or null
|
|
11395
11962
|
* ```
|
|
11396
11963
|
*/
|
|
11397
11964
|
getSettings(): Promise<UserSettingsGetResponse>;
|
|
11398
11965
|
/**
|
|
11399
|
-
* Updates the current user's profile and context settings
|
|
11966
|
+
* Updates the current user's profile and context settings.
|
|
11400
11967
|
*
|
|
11401
|
-
*
|
|
11402
|
-
*
|
|
11968
|
+
* Accepts a partial payload — only fields included in `options` are changed. Pass `null` to
|
|
11969
|
+
* explicitly clear a field. Omitting a field leaves it unchanged. Returns the full updated
|
|
11970
|
+
* settings record.
|
|
11971
|
+
*
|
|
11972
|
+
* @param options - Fields to update; omit fields to leave them unchanged, set to `null` to clear
|
|
11973
|
+
* @returns Promise resolving to the updated user settings
|
|
11403
11974
|
* {@link UserSettingsUpdateResponse}
|
|
11404
|
-
*
|
|
11975
|
+
*
|
|
11976
|
+
* @example Partial update
|
|
11405
11977
|
* ```typescript
|
|
11406
|
-
* const
|
|
11978
|
+
* const updated = await conversationalAgent.user.updateSettings({
|
|
11407
11979
|
* name: 'John Doe',
|
|
11408
11980
|
* timezone: 'America/New_York'
|
|
11409
11981
|
* });
|
|
11410
11982
|
* ```
|
|
11983
|
+
*
|
|
11984
|
+
* @example Clear fields by setting to null
|
|
11985
|
+
* ```typescript
|
|
11986
|
+
* await conversationalAgent.user.updateSettings({
|
|
11987
|
+
* role: null,
|
|
11988
|
+
* department: null
|
|
11989
|
+
* });
|
|
11990
|
+
* ```
|
|
11411
11991
|
*/
|
|
11412
11992
|
updateSettings(options: UserSettingsUpdateOptions): Promise<UserSettingsUpdateResponse>;
|
|
11413
11993
|
}
|
|
11414
11994
|
|
|
11415
11995
|
/**
|
|
11416
|
-
* Constants for User Service
|
|
11996
|
+
* Constants for User Settings Service
|
|
11417
11997
|
*/
|
|
11418
11998
|
/**
|
|
11419
11999
|
* Maps fields for User Settings entities to ensure consistent SDK naming
|
|
@@ -11575,6 +12155,8 @@ interface ConversationalAgentServiceModel {
|
|
|
11575
12155
|
onConnectionStatusChanged(handler: (status: ConnectionStatus, error: Error | null) => void): () => void;
|
|
11576
12156
|
/** Service for creating and managing conversations. See {@link ConversationServiceModel}. */
|
|
11577
12157
|
readonly conversations: ConversationServiceModel;
|
|
12158
|
+
/** Service for reading and updating the current user's profile/context settings. See {@link UserSettingsServiceModel}. */
|
|
12159
|
+
readonly user: UserSettingsServiceModel;
|
|
11578
12160
|
/**
|
|
11579
12161
|
* Gets feature flags for the current tenant
|
|
11580
12162
|
*
|
|
@@ -11593,6 +12175,21 @@ interface ConversationalAgentOptions {
|
|
|
11593
12175
|
* external app client; omit for standard UiPath user tokens.
|
|
11594
12176
|
*/
|
|
11595
12177
|
externalUserId?: string;
|
|
12178
|
+
/**
|
|
12179
|
+
* Optional identifier used in UiPath logs to identify the implementing service
|
|
12180
|
+
* of requests. External consumers do not need to set it; the server logs
|
|
12181
|
+
* missing values as "unknown".
|
|
12182
|
+
*
|
|
12183
|
+
* @internal
|
|
12184
|
+
*/
|
|
12185
|
+
surfaceName?: string;
|
|
12186
|
+
/**
|
|
12187
|
+
* Optional version of the implementing service of requests. Paired with
|
|
12188
|
+
* `surfaceName` for internal telemetry.
|
|
12189
|
+
*
|
|
12190
|
+
* @internal
|
|
12191
|
+
*/
|
|
12192
|
+
surfaceVersion?: string;
|
|
11596
12193
|
/** Log level for debugging */
|
|
11597
12194
|
logLevel?: LogLevel;
|
|
11598
12195
|
}
|
|
@@ -11600,6 +12197,7 @@ interface ConversationalAgentOptions {
|
|
|
11600
12197
|
/**
|
|
11601
12198
|
* Represents a category that can be associated with feedback.
|
|
11602
12199
|
* Default categories (Output, Agent Error, Agent Plan Execution) are auto-created per tenant.
|
|
12200
|
+
* Used as nested objects inside {@link FeedbackResponse}.
|
|
11603
12201
|
*/
|
|
11604
12202
|
interface FeedbackCategory {
|
|
11605
12203
|
/** Unique identifier of the feedback category */
|
|
@@ -11615,6 +12213,24 @@ interface FeedbackCategory {
|
|
|
11615
12213
|
/** Whether this category applies to negative feedback */
|
|
11616
12214
|
isNegative: boolean;
|
|
11617
12215
|
}
|
|
12216
|
+
/**
|
|
12217
|
+
* A feedback category returned by {@link FeedbackServiceModel.getCategories}, {@link FeedbackServiceModel.createCategory}.
|
|
12218
|
+
* Fields are transformed to camelCase SDK conventions (createdAt → createdTime).
|
|
12219
|
+
*/
|
|
12220
|
+
interface FeedbackCategoryResponse {
|
|
12221
|
+
/** Unique identifier of the feedback category */
|
|
12222
|
+
id: string;
|
|
12223
|
+
/** Category name (max 256 characters, unique per tenant) */
|
|
12224
|
+
category: string;
|
|
12225
|
+
/** Timestamp when the category was created */
|
|
12226
|
+
createdTime: string;
|
|
12227
|
+
/** Whether this is a system default category (e.g., Output, Agent Error, Agent Plan Execution) */
|
|
12228
|
+
isDefault: boolean;
|
|
12229
|
+
/** Whether this category applies to positive feedback */
|
|
12230
|
+
isPositive: boolean;
|
|
12231
|
+
/** Whether this category applies to negative feedback */
|
|
12232
|
+
isNegative: boolean;
|
|
12233
|
+
}
|
|
11618
12234
|
/**
|
|
11619
12235
|
* Status of a feedback entry in the review workflow
|
|
11620
12236
|
*/
|
|
@@ -11629,7 +12245,7 @@ declare enum FeedbackStatus {
|
|
|
11629
12245
|
/**
|
|
11630
12246
|
* Complete feedback object returned from the API
|
|
11631
12247
|
*/
|
|
11632
|
-
interface
|
|
12248
|
+
interface FeedbackResponse {
|
|
11633
12249
|
/** Unique identifier of the feedback entry */
|
|
11634
12250
|
id: string;
|
|
11635
12251
|
/** Trace identifier linking feedback to a specific agent execution */
|
|
@@ -11659,6 +12275,12 @@ interface FeedbackGetResponse {
|
|
|
11659
12275
|
/** Timestamp when the feedback was last updated */
|
|
11660
12276
|
updatedTime: string;
|
|
11661
12277
|
}
|
|
12278
|
+
/**
|
|
12279
|
+
* Feedback object returned by getAll and getById.
|
|
12280
|
+
* Extends {@link FeedbackResponse} — use this type for getAll/getById return values.
|
|
12281
|
+
*/
|
|
12282
|
+
interface FeedbackGetResponse extends FeedbackResponse {
|
|
12283
|
+
}
|
|
11662
12284
|
/**
|
|
11663
12285
|
* Options shared across feedback operations
|
|
11664
12286
|
*/
|
|
@@ -11666,6 +12288,45 @@ interface FeedbackOptions {
|
|
|
11666
12288
|
/** Folder key for authorization */
|
|
11667
12289
|
folderKey: string;
|
|
11668
12290
|
}
|
|
12291
|
+
/**
|
|
12292
|
+
* A category reference used when creating or updating feedback
|
|
12293
|
+
*/
|
|
12294
|
+
interface FeedbackCategoryInput {
|
|
12295
|
+
/** Unique identifier of the category */
|
|
12296
|
+
id: string;
|
|
12297
|
+
/** Category name (e.g., 'Output', 'Agent Error', 'Agent Plan Execution') */
|
|
12298
|
+
category: string;
|
|
12299
|
+
}
|
|
12300
|
+
/**
|
|
12301
|
+
* Options for submitting a new feedback entry
|
|
12302
|
+
*/
|
|
12303
|
+
interface FeedbackSubmitOptions extends FeedbackOptions {
|
|
12304
|
+
/** Span identifier representing a specific operation within the trace */
|
|
12305
|
+
spanId?: string;
|
|
12306
|
+
/** Identifier of the agent that generated the response being reviewed */
|
|
12307
|
+
agentId?: string;
|
|
12308
|
+
/** Version of the agent at the time the feedback was given (max 100 characters) */
|
|
12309
|
+
agentVersion?: string;
|
|
12310
|
+
/** Span type (e.g., 'agentRun', 'llm', 'tool', 'retriever') (max 100 characters) */
|
|
12311
|
+
spanType?: string;
|
|
12312
|
+
/** Optional text comment provided by the user (max 4000 characters) */
|
|
12313
|
+
comment?: string;
|
|
12314
|
+
/** Optional metadata string associated with the feedback (max 4000 characters) */
|
|
12315
|
+
metadata?: string;
|
|
12316
|
+
/** Categories to associate with this feedback entry */
|
|
12317
|
+
categories?: FeedbackCategoryInput[];
|
|
12318
|
+
}
|
|
12319
|
+
/**
|
|
12320
|
+
* Options for updating an existing feedback entry
|
|
12321
|
+
*/
|
|
12322
|
+
interface FeedbackUpdateOptions extends FeedbackOptions {
|
|
12323
|
+
/** Optional text comment provided by the user (max 4000 characters) */
|
|
12324
|
+
comment?: string;
|
|
12325
|
+
/** Optional metadata string associated with the feedback (max 4000 characters) */
|
|
12326
|
+
metadata?: string;
|
|
12327
|
+
/** Categories to associate with this feedback entry */
|
|
12328
|
+
categories?: FeedbackCategoryInput[];
|
|
12329
|
+
}
|
|
11669
12330
|
/**
|
|
11670
12331
|
* Options for retrieving multiple feedback entries
|
|
11671
12332
|
*/
|
|
@@ -11681,6 +12342,32 @@ type FeedbackGetAllOptions = PaginationOptions & {
|
|
|
11681
12342
|
/** Filter by OpenTelemetry span identifier */
|
|
11682
12343
|
spanId?: string;
|
|
11683
12344
|
};
|
|
12345
|
+
/**
|
|
12346
|
+
* Options for creating a new feedback category
|
|
12347
|
+
*/
|
|
12348
|
+
interface FeedbackCreateCategoryOptions {
|
|
12349
|
+
/** Whether the category applies to positive feedback (defaults to true) */
|
|
12350
|
+
isPositive?: boolean;
|
|
12351
|
+
/** Whether the category applies to negative feedback (defaults to true) */
|
|
12352
|
+
isNegative?: boolean;
|
|
12353
|
+
}
|
|
12354
|
+
/**
|
|
12355
|
+
* Options for deleting a feedback category.
|
|
12356
|
+
* Note: system default categories (Output, Agent Error, Agent Plan Execution) cannot be deleted — attempting to do so returns a 409 Conflict.
|
|
12357
|
+
*/
|
|
12358
|
+
interface FeedbackDeleteCategoryOptions {
|
|
12359
|
+
/** When true, deletes the category even if it has associated feedback entries */
|
|
12360
|
+
forceDelete?: boolean;
|
|
12361
|
+
}
|
|
12362
|
+
/**
|
|
12363
|
+
* Options for retrieving feedback categories
|
|
12364
|
+
*/
|
|
12365
|
+
type FeedbackGetCategoriesOptions = PaginationOptions & {
|
|
12366
|
+
/** Filter by whether the category applies to positive feedback */
|
|
12367
|
+
isPositive?: boolean;
|
|
12368
|
+
/** Filter by whether the category applies to negative feedback */
|
|
12369
|
+
isNegative?: boolean;
|
|
12370
|
+
};
|
|
11684
12371
|
|
|
11685
12372
|
/**
|
|
11686
12373
|
* Service for managing UiPath Agent Feedback.
|
|
@@ -11706,10 +12393,10 @@ interface FeedbackServiceModel {
|
|
|
11706
12393
|
* Gets all feedback across all agents in the tenant, with optional filters.
|
|
11707
12394
|
*
|
|
11708
12395
|
* Retrieves a list of feedback entries, optionally filtered by agent, trace, span, status, or agent version.
|
|
11709
|
-
* When no pagination options are provided, the
|
|
12396
|
+
* When no pagination options are provided, the SDK returns up to 100 items. When pagination options are provided without a pageSize, the SDK defaults to 50 items per page.
|
|
11710
12397
|
*
|
|
11711
12398
|
* @param options - Optional query parameters for filtering and pagination
|
|
11712
|
-
* @returns Promise resolving to {@link NonPaginatedResponse} of {@link
|
|
12399
|
+
* @returns Promise resolving to {@link NonPaginatedResponse} of {@link FeedbackResponse} without pagination options, or {@link PaginatedResponse} of {@link FeedbackResponse} when pagination options are used.
|
|
11713
12400
|
* @example
|
|
11714
12401
|
* ```typescript
|
|
11715
12402
|
* import { Feedback, FeedbackStatus } from '@uipath/uipath-typescript/feedback';
|
|
@@ -11739,13 +12426,13 @@ interface FeedbackServiceModel {
|
|
|
11739
12426
|
* });
|
|
11740
12427
|
* ```
|
|
11741
12428
|
*/
|
|
11742
|
-
getAll<T extends FeedbackGetAllOptions = FeedbackGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<
|
|
12429
|
+
getAll<T extends FeedbackGetAllOptions = FeedbackGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<FeedbackResponse> : NonPaginatedResponse<FeedbackResponse>>;
|
|
11743
12430
|
/**
|
|
11744
12431
|
* Gets a single feedback entry by its feedback ID.
|
|
11745
12432
|
*
|
|
11746
12433
|
* @param id - Feedback ID (GUID) of the feedback entry
|
|
11747
12434
|
* @param options - Required options including folderKey for folder-level authorization {@link FeedbackOptions}
|
|
11748
|
-
* @returns Promise resolving to {@link
|
|
12435
|
+
* @returns Promise resolving to {@link FeedbackResponse}
|
|
11749
12436
|
* @example
|
|
11750
12437
|
* ```typescript
|
|
11751
12438
|
* import { Feedback } from '@uipath/uipath-typescript/feedback';
|
|
@@ -11756,11 +12443,169 @@ interface FeedbackServiceModel {
|
|
|
11756
12443
|
* const allFeedback = await feedback.getAll({ pageSize: 10 });
|
|
11757
12444
|
* const feedbackId = allFeedback.items[0].id;
|
|
11758
12445
|
* const folderKey = allFeedback.items[0].folderKey;
|
|
12446
|
+
*
|
|
11759
12447
|
* const item = await feedback.getById(feedbackId, { folderKey });
|
|
11760
12448
|
* console.log(item.isPositive, item.comment, item.status);
|
|
11761
12449
|
* ```
|
|
11762
12450
|
*/
|
|
11763
|
-
getById(id: string, options: FeedbackOptions): Promise<
|
|
12451
|
+
getById(id: string, options: FeedbackOptions): Promise<FeedbackResponse>;
|
|
12452
|
+
/**
|
|
12453
|
+
* Submits a feedback entry.
|
|
12454
|
+
*
|
|
12455
|
+
* @param traceId - Trace identifier linking feedback to a specific agent execution
|
|
12456
|
+
* @param isPositive - Whether the feedback is positive (thumbs up) or negative (thumbs down)
|
|
12457
|
+
* @param options - Additional feedback data and folderKey for authorization {@link FeedbackSubmitOptions}
|
|
12458
|
+
* @returns Promise resolving to the submitted {@link FeedbackResponse}
|
|
12459
|
+
* @example
|
|
12460
|
+
* ```typescript
|
|
12461
|
+
* import { Feedback } from '@uipath/uipath-typescript/feedback';
|
|
12462
|
+
*
|
|
12463
|
+
* const feedback = new Feedback(sdk);
|
|
12464
|
+
*
|
|
12465
|
+
* // Obtain traceId and folderKey from an existing feedback entry
|
|
12466
|
+
* const allFeedback = await feedback.getAll({ pageSize: 1 });
|
|
12467
|
+
* const traceId = allFeedback.items[0].traceId;
|
|
12468
|
+
* const folderKey = allFeedback.items[0].folderKey!;
|
|
12469
|
+
*
|
|
12470
|
+
* const item = await feedback.submit(traceId, true, { folderKey });
|
|
12471
|
+
* console.log(item.id, item.status);
|
|
12472
|
+
* ```
|
|
12473
|
+
*/
|
|
12474
|
+
submit(traceId: string, isPositive: boolean, options: FeedbackSubmitOptions): Promise<FeedbackResponse>;
|
|
12475
|
+
/**
|
|
12476
|
+
* Updates already submitted feedback.
|
|
12477
|
+
*
|
|
12478
|
+
* @param id - Feedback ID (GUID) of the entry to update
|
|
12479
|
+
* @param isPositive - Whether the feedback is positive (thumbs up) or negative (thumbs down)
|
|
12480
|
+
* @param options - Updated feedback data and folderKey for authorization {@link FeedbackUpdateOptions}
|
|
12481
|
+
* @returns Promise resolving to the updated {@link FeedbackResponse}
|
|
12482
|
+
* @example
|
|
12483
|
+
* ```typescript
|
|
12484
|
+
* import { Feedback } from '@uipath/uipath-typescript/feedback';
|
|
12485
|
+
*
|
|
12486
|
+
* const feedback = new Feedback(sdk);
|
|
12487
|
+
*
|
|
12488
|
+
* const allFeedback = await feedback.getAll({ pageSize: 1 });
|
|
12489
|
+
* const feedbackId = allFeedback.items[0].id;
|
|
12490
|
+
* const folderKey = allFeedback.items[0].folderKey!;
|
|
12491
|
+
*
|
|
12492
|
+
* const updated = await feedback.updateById(feedbackId, false, {
|
|
12493
|
+
* comment: 'On reflection, not great.',
|
|
12494
|
+
* folderKey,
|
|
12495
|
+
* });
|
|
12496
|
+
* console.log(updated.isPositive, updated.comment);
|
|
12497
|
+
* ```
|
|
12498
|
+
*/
|
|
12499
|
+
updateById(id: string, isPositive: boolean, options: FeedbackUpdateOptions): Promise<FeedbackResponse>;
|
|
12500
|
+
/**
|
|
12501
|
+
* Deletes a feedback entry by its ID.
|
|
12502
|
+
*
|
|
12503
|
+
* @param id - Feedback ID (GUID) of the entry to delete
|
|
12504
|
+
* @param options - Required options including folderKey for folder-level authorization {@link FeedbackOptions}
|
|
12505
|
+
* @returns Promise resolving to void on success
|
|
12506
|
+
* @example
|
|
12507
|
+
* ```typescript
|
|
12508
|
+
* import { Feedback } from '@uipath/uipath-typescript/feedback';
|
|
12509
|
+
*
|
|
12510
|
+
* const feedback = new Feedback(sdk);
|
|
12511
|
+
*
|
|
12512
|
+
* const allFeedback = await feedback.getAll({ pageSize: 1 });
|
|
12513
|
+
* const feedbackId = allFeedback.items[0].id;
|
|
12514
|
+
* const folderKey = allFeedback.items[0].folderKey!;
|
|
12515
|
+
*
|
|
12516
|
+
* await feedback.deleteById(feedbackId, { folderKey });
|
|
12517
|
+
* ```
|
|
12518
|
+
*/
|
|
12519
|
+
deleteById(id: string, options: FeedbackOptions): Promise<void>;
|
|
12520
|
+
/**
|
|
12521
|
+
* Creates a new feedback category.
|
|
12522
|
+
*
|
|
12523
|
+
* Custom categories can be used to label feedback entries beyond the default system categories.
|
|
12524
|
+
* Once created, reference the category by its `id` when submitting or updating feedback.
|
|
12525
|
+
* If `isPositive` and `isNegative` are omitted, the backend defaults both to `true`.
|
|
12526
|
+
*
|
|
12527
|
+
* @param category - Name of the category to create (max 256 characters, unique per tenant)
|
|
12528
|
+
* @param options - Optional flags controlling whether the category applies to positive and/or negative feedback {@link FeedbackCreateCategoryOptions}
|
|
12529
|
+
* @returns Promise resolving to the created {@link FeedbackCategoryResponse}
|
|
12530
|
+
* @example
|
|
12531
|
+
* ```typescript
|
|
12532
|
+
* import { Feedback } from '@uipath/uipath-typescript/feedback';
|
|
12533
|
+
*
|
|
12534
|
+
* const feedback = new Feedback(sdk);
|
|
12535
|
+
*
|
|
12536
|
+
* // Minimum — applies to both positive and negative feedback by default
|
|
12537
|
+
* const category = await feedback.createCategory('Hallucination');
|
|
12538
|
+
* console.log(category.id, category.category);
|
|
12539
|
+
*
|
|
12540
|
+
* // With explicit flags
|
|
12541
|
+
* const negativeOnly = await feedback.createCategory('Off-topic', {
|
|
12542
|
+
* isPositive: false,
|
|
12543
|
+
* isNegative: true,
|
|
12544
|
+
* });
|
|
12545
|
+
* ```
|
|
12546
|
+
*/
|
|
12547
|
+
createCategory(category: string, options?: FeedbackCreateCategoryOptions): Promise<FeedbackCategoryResponse>;
|
|
12548
|
+
/**
|
|
12549
|
+
* Gets all feedback categories for the tenant.
|
|
12550
|
+
*
|
|
12551
|
+
* Returns both system default categories (Output, Agent Error, Agent Plan Execution)
|
|
12552
|
+
* and any custom categories created for this tenant.
|
|
12553
|
+
* When no pagination options are provided, the SDK returns up to 100 items. When pagination options are provided without a pageSize, the SDK defaults to 50 items per page.
|
|
12554
|
+
*
|
|
12555
|
+
* @param options - Optional filters and pagination options {@link FeedbackGetCategoriesOptions}
|
|
12556
|
+
* @returns Promise resolving to {@link NonPaginatedResponse} of {@link FeedbackCategoryResponse} without pagination options, or {@link PaginatedResponse} of {@link FeedbackCategoryResponse} when pagination options are used.
|
|
12557
|
+
* @example
|
|
12558
|
+
* ```typescript
|
|
12559
|
+
* import { Feedback } from '@uipath/uipath-typescript/feedback';
|
|
12560
|
+
*
|
|
12561
|
+
* const feedback = new Feedback(sdk);
|
|
12562
|
+
*
|
|
12563
|
+
* // Get all categories
|
|
12564
|
+
* const categories = await feedback.getCategories();
|
|
12565
|
+
* console.log(categories.items.map(c => c.category));
|
|
12566
|
+
*
|
|
12567
|
+
* // Get only categories applicable to negative feedback
|
|
12568
|
+
* const negativeCategories = await feedback.getCategories({ isNegative: true });
|
|
12569
|
+
*
|
|
12570
|
+
* // Paginated
|
|
12571
|
+
* const page1 = await feedback.getCategories({ pageSize: 10 });
|
|
12572
|
+
* ```
|
|
12573
|
+
*/
|
|
12574
|
+
getCategories<T extends FeedbackGetCategoriesOptions = FeedbackGetCategoriesOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<FeedbackCategoryResponse> : NonPaginatedResponse<FeedbackCategoryResponse>>;
|
|
12575
|
+
/**
|
|
12576
|
+
* Deletes a feedback category by its ID.
|
|
12577
|
+
*
|
|
12578
|
+
* System default categories (Output, Agent Error, Agent Plan Execution) cannot be deleted —
|
|
12579
|
+
* attempting to do so throws a `409 Conflict` error.
|
|
12580
|
+
* Use `forceDelete` to delete a custom category that already has feedback entries associated with it.
|
|
12581
|
+
*
|
|
12582
|
+
* @param id - Category ID (GUID) of the category to delete
|
|
12583
|
+
* @param options - Optional deletion options {@link FeedbackDeleteCategoryOptions}
|
|
12584
|
+
* @returns Promise resolving to void on success
|
|
12585
|
+
* @example
|
|
12586
|
+
* ```typescript
|
|
12587
|
+
* import { Feedback } from '@uipath/uipath-typescript/feedback';
|
|
12588
|
+
*
|
|
12589
|
+
* const feedback = new Feedback(sdk);
|
|
12590
|
+
*
|
|
12591
|
+
* // Only custom categories (isDefault: false) can be deleted
|
|
12592
|
+
* const categories = await feedback.getCategories();
|
|
12593
|
+
* const customCategory = categories.items.find(c => !c.isDefault);
|
|
12594
|
+
* if (customCategory) {
|
|
12595
|
+
* await feedback.deleteCategory(customCategory.id);
|
|
12596
|
+
* }
|
|
12597
|
+
* ```
|
|
12598
|
+
* @example
|
|
12599
|
+
* ```typescript
|
|
12600
|
+
* // Force-delete a custom category that has associated feedback entries
|
|
12601
|
+
* const categories = await feedback.getCategories();
|
|
12602
|
+
* const customCategory = categories.items.find(c => !c.isDefault);
|
|
12603
|
+
* if (customCategory) {
|
|
12604
|
+
* await feedback.deleteCategory(customCategory.id, { forceDelete: true });
|
|
12605
|
+
* }
|
|
12606
|
+
* ```
|
|
12607
|
+
*/
|
|
12608
|
+
deleteCategory(id: string, options?: FeedbackDeleteCategoryOptions): Promise<void>;
|
|
11764
12609
|
}
|
|
11765
12610
|
|
|
11766
12611
|
declare enum DocumentActionPriority {
|
|
@@ -13205,7 +14050,8 @@ declare enum UiPathMetaTags {
|
|
|
13205
14050
|
BASE_URL = "uipath:base-url",
|
|
13206
14051
|
REDIRECT_URI = "uipath:redirect-uri",
|
|
13207
14052
|
CDN_BASE = "uipath:cdn-base",
|
|
13208
|
-
APP_BASE = "uipath:app-base"
|
|
14053
|
+
APP_BASE = "uipath:app-base",
|
|
14054
|
+
FOLDER_KEY = "uipath:folder-key"
|
|
13209
14055
|
}
|
|
13210
14056
|
|
|
13211
14057
|
/**
|
|
@@ -13291,7 +14137,7 @@ declare const telemetryClient: TelemetryClient;
|
|
|
13291
14137
|
* SDK Telemetry constants
|
|
13292
14138
|
*/
|
|
13293
14139
|
declare const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
|
|
13294
|
-
declare const SDK_VERSION = "1.3.
|
|
14140
|
+
declare const SDK_VERSION = "1.3.8";
|
|
13295
14141
|
declare const VERSION = "Version";
|
|
13296
14142
|
declare const SERVICE = "Service";
|
|
13297
14143
|
declare const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
|
|
@@ -13306,5 +14152,5 @@ declare const SDK_LOGGER_NAME = "uipath-ts-sdk-telemetry";
|
|
|
13306
14152
|
declare const SDK_RUN_EVENT = "Sdk.Run";
|
|
13307
14153
|
declare const UNKNOWN = "";
|
|
13308
14154
|
|
|
13309
|
-
export { APP_NAME, AgentMap, AssetValueScope, AssetValueType, AuthenticationError, AuthorizationError, BucketOptions, CLOUD_CLIENT_ID, CLOUD_ORGANIZATION_NAME, CLOUD_REDIRECT_URI, CLOUD_ROLE_NAME, CLOUD_TENANT_NAME, CLOUD_URL, CONNECTION_STRING, CitationErrorType, ConversationMap, DEFAULT_ITEMS_FIELD, DEFAULT_PAGE_SIZE, DEFAULT_TOTAL_COUNT_FIELD, DataDirectionType, DebugMode, index as DuFramework, EntityFieldDataType, EntityType, ErrorType, EscalationActionType, EscalationRecipientScope, EscalationTriggerType, ExchangeMap, FeedbackRating, FeedbackStatus, FieldDisplayType, HttpStatus, InputStreamSpeechSensitivity, InterruptType, JobPriority, JobSourceType, JobState, JobSubState, JobType, JoinType, LogicalOperator$1 as LogicalOperator, MAX_PAGE_SIZE, MessageMap, MessageRole, NetworkError, NotFoundError, PackageSourceType, PackageType, ProcessIncidentSeverity, ProcessIncidentStatus, ProcessIncidentType, QueryFilterOperator, RateLimitError, ReferenceType, RemoteControlAccess, RobotSize, RuntimeType, SDK_LOGGER_NAME, SDK_RUN_EVENT, SDK_SERVICE_NAME, SDK_VERSION, SERVICE, SLADurationUnit, ServerError, ServerlessJobType, SortOrder, StageTaskType, StartStrategy, StopStrategy, TargetFramework, TaskActivityType, TaskPriority, TaskSlaCriteria, TaskSlaStatus, TaskSourceName, TaskStatus, TaskType, TaskUserType, UNKNOWN, UiPath, UiPathError, UiPathMetaTags, UserSettingsMap, VERSION, ValidationError, createAgentWithMethods, createCaseInstanceWithMethods, createConversationWithMethods, createEntityWithMethods, createJobWithMethods, createProcessInstanceWithMethods, createProcessWithMethods, createTaskWithMethods, getAppBase, getAsset, getErrorDetails, getLimitedPageSize, isAuthenticationError, isAuthorizationError, isNetworkError, isNotFoundError, isRateLimitError, isServerError, isUiPathError, isValidationError, loadFromMetaTags, telemetryClient, track, trackEvent };
|
|
13310
|
-
export type { AgentAppearance, AgentConversationServiceModel, AgentCreateConversationOptions, AgentGetByIdResponse, AgentGetResponse, AgentInput, AgentMethods, AgentStartingPrompt, ArgumentMetadata, AssetGetAllOptions, AssetGetByIdOptions, AssetGetResponse, AssetServiceModel, AsyncInputStream, AsyncInputStreamChunkEvent, AsyncInputStreamEndEvent, AsyncInputStreamEvent, AsyncInputStreamStartEvent, AsyncToolCallStream, AttachmentGetByIdOptions, AttachmentResponse, AttachmentServiceModel, BaseConfig, BaseOptions, BaseProcessStartRequest, BlobItem, BodyOptions, BpmnXmlString, BucketGetAllOptions, BucketGetByIdOptions, BucketGetFileMetaDataOptions, BucketGetFileMetaDataResponse, BucketGetFileMetaDataWithPaginationOptions, BucketGetReadUriOptions, BucketGetResponse, BucketGetUriOptions, BucketGetUriResponse, BucketServiceModel, BucketUploadFileOptions, BucketUploadResponse, CaseAppConfig, CaseAppOverview, CaseGetAllResponse, CaseGetStageResponse, CaseInstanceExecutionHistoryResponse, CaseInstanceGetAllOptions, CaseInstanceGetAllWithPaginationOptions, CaseInstanceGetResponse, CaseInstanceMethods, CaseInstanceOperationOptions, CaseInstanceOperationResponse, CaseInstanceReopenOptions, CaseInstanceRun, CaseInstancesServiceModel, CasesServiceModel, ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, Citation, CitationEndEvent, CitationError, CitationEvent, CitationOptions, CitationSource, CitationSourceBase, CitationSourceMedia, CitationSourceUrl, CitationStartEvent, CollectionResponse, CompletedContentPart, CompletedMessage, CompletedToolCall, ContentPart, ContentPartChunkEvent, ContentPartData, ContentPartEndEvent, ContentPartEvent, ContentPartGetResponse, ContentPartInterrupted, ContentPartStartEvent, ContentPartStartMetaData, ContentPartStream, ConversationAttachmentCreateResponse, ConversationAttachmentUploadResponse, ConversationCreateOptions, ConversationCreateResponse, ConversationDeleteResponse, ConversationEvent, ConversationExchangeServiceModel, ConversationGetAllOptions, ConversationGetResponse, ConversationJobStartOverrides, ConversationMethods, ConversationServiceModel, ConversationSessionMethods, ConversationSessionOptions, ConversationUpdateOptions, ConversationUpdateResponse, ConversationalAgentOptions, ConversationalAgentServiceModel, CreateFeedbackOptions, CustomKeyValuePair, ElementExecutionMetadata, ElementMetaData, ElementRunMetadata, EntityBatchInsertOptions, EntityBatchInsertResponse, EntityCreateFieldOptions, EntityCreateOptions, EntityDeleteAttachmentResponse, EntityDeleteOptions, EntityDeleteRecordsOptions, EntityDeleteResponse, EntityFieldBase, EntityFieldUpdateOptions, EntityFileType, EntityGetAllRecordsOptions, EntityGetRecordByIdOptions, EntityGetRecordsByIdOptions, EntityGetResponse, EntityImportRecordsResponse, EntityInsertOptions, EntityInsertRecordOptions, EntityInsertRecordsOptions, EntityInsertResponse, EntityMethods, EntityOperationOptions, EntityOperationResponse, EntityQueryFilter, EntityQueryFilterGroup, EntityQueryRecordsOptions, EntityQueryRecordsResponse, EntityQuerySortOption, EntityRecord, EntityRemoveFieldOptions, EntityServiceModel, EntityUpdateByIdOptions, EntityUpdateOptions, EntityUpdateRecordOptions, EntityUpdateRecordResponse, EntityUpdateRecordsOptions, EntityUpdateResponse, EntityUploadAttachmentOptions, EntityUploadAttachmentResponse, ErrorEndEvent, ErrorEvent, ErrorStartEvent, EscalationAction, EscalationRecipient, EscalationRule, EscalationTriggerMetadata, Exchange, ExchangeEndEvent, ExchangeEvent, ExchangeGetAllOptions, ExchangeGetByIdOptions, ExchangeGetResponse, ExchangeServiceModel, ExchangeStartEvent, ExchangeStream, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, ExternalValue, FailureRecord, FeatureFlags, FeedbackCategory, FeedbackCreateResponse, FeedbackGetAllOptions, FeedbackGetResponse, FeedbackOptions, FeedbackServiceModel, Field$1 as Field, FieldDataType, FieldMetaData, FileUploadAccess, FolderProperties, GenericInterruptStartEvent, GlobalVariableMetaData, HasPaginationOptions, Headers, HttpMethod, InlineOrExternalValue, InlineValue, Interrupt, InterruptEndEvent, InterruptEvent, InterruptStartEvent, JSONArray, JSONObject, JSONPrimitive, JSONValue, JobAttachment, JobError, JobGetAllOptions, JobGetByIdOptions, JobGetResponse, JobMethods, JobResumeOptions, JobServiceModel, JobStopOptions, LabelUpdatedEvent, Machine, MaestroProcessGetAllResponse, MaestroProcessesServiceModel, MakeOptional, MakeRequired, Message, MessageEndEvent, MessageEvent, MessageGetResponse, MessageServiceModel, MessageStartEvent, MessageStream, MetaData, MetaEvent, NonPaginatedResponse, OAuthFields, OperationResponse, PaginatedResponse, PaginationCursor, PaginationMetadata, PaginationMethodUnion, PaginationOptions, PartialUiPathConfig, ProcessGetAllOptions, ProcessGetByIdOptions, ProcessGetResponse, ProcessIncidentGetAllResponse, ProcessIncidentGetResponse, ProcessIncidentsServiceModel, ProcessInstanceExecutionHistoryResponse, ProcessInstanceGetAllOptions, ProcessInstanceGetAllWithPaginationOptions, ProcessInstanceGetResponse, ProcessInstanceGetVariablesOptions, ProcessInstanceGetVariablesResponse, ProcessInstanceMethods, ProcessInstanceOperationOptions, ProcessInstanceOperationResponse, ProcessInstanceRun, ProcessInstancesServiceModel, ProcessMetadata, ProcessMethods, ProcessProperties, ProcessServiceModel, ProcessStartRequest, ProcessStartRequestWithKey, ProcessStartRequestWithName, ProcessStartResponse, QueryParams, QueueGetAllOptions, QueueGetByIdOptions, QueueGetResponse, QueueServiceModel, RawAgentGetByIdResponse, RawAgentGetResponse, RawCaseInstanceGetResponse, RawConversationGetResponse, RawEntityGetResponse, RawJobGetResponse, RawMaestroProcessGetAllResponse, RawProcessInstanceGetResponse, RawTaskCreateResponse, RawTaskGetResponse, RequestOptions, RequestSpec, ResponseDictionary, ResponseType, RetryOptions, RobotMetadata, SessionCapabilities, SessionEndEvent, SessionEndingEvent, SessionStartEvent, SessionStartedEvent, SessionStream, Simplify, SourceJoinCriteria, SqlType, StageSLA, StageTask, Tag, TaskActivity, TaskAssignOptions, TaskAssignment, TaskAssignmentOptions, TaskAssignmentResponse, TaskBaseResponse, TaskCompleteOptions, TaskCompletionOptions, TaskCreateOptions, TaskCreateResponse, TaskGetAllOptions, TaskGetByIdOptions, TaskGetResponse, TaskGetUsersOptions, TaskMethods, TaskServiceModel, TaskSlaDetail, TaskSource, TasksUnassignOptions, TimeoutOptions, ToolCall, ToolCallConfirmationEndValue, ToolCallConfirmationInterruptStartEvent, ToolCallConfirmationValue, ToolCallEndEvent, ToolCallEvent, ToolCallInputValue, ToolCallOutputValue, ToolCallResult, ToolCallStartEvent, ToolCallStream, UiPathSDKConfig, UserLoginInfo,
|
|
14155
|
+
export { APP_NAME, AgentMap, AssetValueScope, AssetValueType, AuthenticationError, AuthorizationError, BucketOptions, CLOUD_CLIENT_ID, CLOUD_ORGANIZATION_NAME, CLOUD_REDIRECT_URI, CLOUD_ROLE_NAME, CLOUD_TENANT_NAME, CLOUD_URL, CONNECTION_STRING, CitationErrorType, 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, InstanceStatus, InterruptType, JobPriority, JobSourceType, JobState, JobSubState, JobType, JoinType, LogicalOperator$1 as LogicalOperator, MAX_PAGE_SIZE, MessageMap, MessageRole, NetworkError, NotFoundError, PackageSourceType, PackageType, ProcessIncidentSeverity, ProcessIncidentStatus, ProcessIncidentType, QueryFilterOperator, RateLimitError, ReferenceType, RemoteControlAccess, RobotSize, RuntimeType, SDK_LOGGER_NAME, SDK_RUN_EVENT, SDK_SERVICE_NAME, SDK_VERSION, SERVICE, SLADurationUnit, ServerError, ServerlessJobType, SlaSummaryStatus, SortOrder, StageTaskType, StartStrategy, StopStrategy, TargetFramework, TaskActivityType, TaskPriority, TaskSlaCriteria, TaskSlaStatus, TaskSourceName, TaskStatus, TaskType, TaskUserType, UNKNOWN, UiPath, UiPathError, UiPathMetaTags, UserSettingsMap, VERSION, ValidationError, createAgentWithMethods, createCaseInstanceWithMethods, createConversationWithMethods, createEntityWithMethods, createJobWithMethods, createProcessInstanceWithMethods, createProcessWithMethods, createTaskWithMethods, getAppBase, getAsset, getErrorDetails, getLimitedPageSize, isAuthenticationError, isAuthorizationError, isNetworkError, isNotFoundError, isRateLimitError, isServerError, isUiPathError, isValidationError, loadFromMetaTags, telemetryClient, track, trackEvent };
|
|
14156
|
+
export type { AgentAppearance, AgentConversationServiceModel, AgentCreateConversationOptions, AgentGetByIdResponse, AgentGetResponse, AgentInput, AgentMethods, AgentStartingPrompt, ArgumentMetadata, AssetGetAllOptions, AssetGetByIdOptions, AssetGetByNameOptions, AssetGetResponse, AssetServiceModel, AsyncInputStream, AsyncInputStreamChunkEvent, AsyncInputStreamEndEvent, AsyncInputStreamEvent, AsyncInputStreamStartEvent, AsyncToolCallStream, AttachmentGetByIdOptions, AttachmentResponse, AttachmentServiceModel, BaseConfig, BaseOptions, BaseProcessStartRequest, BlobItem, BodyOptions, BpmnXmlString, BucketGetAllOptions, BucketGetByIdOptions, BucketGetFileMetaDataOptions, BucketGetFileMetaDataResponse, BucketGetFileMetaDataWithPaginationOptions, BucketGetReadUriOptions, BucketGetResponse, BucketGetUriOptions, BucketGetUriResponse, BucketServiceModel, BucketUploadFileOptions, BucketUploadResponse, CaseAppConfig, CaseAppOverview, CaseGetAllResponse, CaseGetStageResponse, CaseInstanceExecutionHistoryResponse, CaseInstanceGetAllOptions, CaseInstanceGetAllWithPaginationOptions, CaseInstanceGetResponse, CaseInstanceMethods, CaseInstanceOperationOptions, CaseInstanceOperationResponse, CaseInstanceReopenOptions, CaseInstanceRun, CaseInstanceSlaSummaryOptions, CaseInstancesServiceModel, CasesServiceModel, ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, Citation, CitationEndEvent, CitationError, CitationEvent, CitationOptions, CitationSource, CitationSourceBase, CitationSourceMedia, CitationSourceUrl, CitationStartEvent, CollectionResponse, CompletedContentPart, CompletedMessage, CompletedToolCall, ContentPart, ContentPartChunkEvent, ContentPartData, ContentPartEndEvent, ContentPartEvent, ContentPartGetResponse, ContentPartInterrupted, ContentPartStartEvent, ContentPartStartMetaData, ContentPartStream, ConversationAttachmentCreateResponse, ConversationAttachmentUploadResponse, ConversationCreateOptions, ConversationCreateResponse, ConversationDeleteResponse, ConversationEvent, ConversationExchangeServiceModel, ConversationGetAllOptions, ConversationGetResponse, ConversationJobStartOverrides, ConversationMethods, ConversationServiceModel, ConversationSessionMethods, ConversationSessionOptions, ConversationUpdateOptions, ConversationUpdateResponse, ConversationalAgentOptions, ConversationalAgentServiceModel, CreateFeedbackOptions, CustomKeyValuePair, ElementExecutionMetadata, ElementMetaData, ElementRunMetadata, EntityAggregate, EntityBatchInsertOptions, EntityBatchInsertResponse, EntityCreateFieldOptions, EntityCreateOptions, EntityDeleteAttachmentResponse, EntityDeleteOptions, EntityDeleteRecordsOptions, EntityDeleteResponse, EntityFieldBase, EntityFieldUpdateOptions, EntityFileType, EntityGetAllRecordsOptions, EntityGetRecordByIdOptions, EntityGetRecordsByIdOptions, EntityGetResponse, EntityImportRecordsResponse, EntityInsertOptions, EntityInsertRecordOptions, EntityInsertRecordsOptions, EntityInsertResponse, EntityMethods, EntityOperationOptions, EntityOperationResponse, EntityQueryFilter, EntityQueryFilterGroup, EntityQueryRecordsOptions, EntityQueryRecordsResponse, EntityQuerySortOption, EntityRecord, EntityRemoveFieldOptions, EntityServiceModel, EntityUpdateByIdOptions, EntityUpdateOptions, EntityUpdateRecordOptions, EntityUpdateRecordResponse, EntityUpdateRecordsOptions, EntityUpdateResponse, EntityUploadAttachmentOptions, EntityUploadAttachmentResponse, ErrorEndEvent, ErrorEvent, ErrorStartEvent, EscalationAction, EscalationRecipient, EscalationRule, EscalationTriggerMetadata, Exchange, ExchangeEndEvent, ExchangeEvent, ExchangeGetAllOptions, ExchangeGetByIdOptions, ExchangeGetResponse, ExchangeServiceModel, ExchangeStartEvent, ExchangeStream, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, ExternalValue, FailureRecord, FeatureFlags, FeedbackCategory, FeedbackCategoryInput, FeedbackCategoryResponse, FeedbackCreateCategoryOptions, FeedbackCreateResponse, FeedbackDeleteCategoryOptions, FeedbackGetAllOptions, FeedbackGetCategoriesOptions, FeedbackGetResponse, FeedbackOptions, FeedbackResponse, FeedbackServiceModel, FeedbackSubmitOptions, FeedbackUpdateOptions, Field$1 as Field, FieldDataType, FieldMetaData, FileUploadAccess, FolderProperties, FolderScopedOptions, GenericInterruptStartEvent, GlobalVariableMetaData, HasPaginationOptions, Headers, HttpMethod, InlineOrExternalValue, InlineValue, Interrupt, InterruptEndEvent, InterruptEvent, InterruptStartEvent, JSONArray, JSONObject, JSONPrimitive, JSONValue, JobAttachment, JobError, JobGetAllOptions, JobGetByIdOptions, JobGetResponse, JobMethods, JobResumeOptions, JobServiceModel, JobStopOptions, LabelUpdatedEvent, Machine, MaestroProcessGetAllResponse, MaestroProcessesServiceModel, MakeOptional, MakeRequired, Message, MessageEndEvent, MessageEvent, MessageGetResponse, MessageServiceModel, MessageStartEvent, MessageStream, MetaData, MetaEvent, NonPaginatedResponse, OAuthFields, OperationResponse, PaginatedResponse, PaginationCursor, PaginationMetadata, PaginationMethodUnion, PaginationOptions, PartialUiPathConfig, ProcessGetAllOptions, ProcessGetByIdOptions, ProcessGetByNameOptions, ProcessGetResponse, ProcessIncidentGetAllResponse, ProcessIncidentGetResponse, ProcessIncidentsServiceModel, ProcessInstanceExecutionHistoryResponse, ProcessInstanceGetAllOptions, ProcessInstanceGetAllWithPaginationOptions, ProcessInstanceGetResponse, ProcessInstanceGetVariablesOptions, ProcessInstanceGetVariablesResponse, ProcessInstanceMethods, ProcessInstanceOperationOptions, ProcessInstanceOperationResponse, ProcessInstanceRun, ProcessInstancesServiceModel, ProcessMetadata, ProcessMethods, ProcessProperties, ProcessServiceModel, ProcessStartRequest, ProcessStartRequestWithKey, ProcessStartRequestWithName, ProcessStartResponse, QueryParams, QueueGetAllOptions, QueueGetByIdOptions, QueueGetResponse, QueueServiceModel, RawAgentGetByIdResponse, RawAgentGetResponse, RawCaseInstanceGetResponse, RawConversationGetResponse, RawEntityGetResponse, RawJobGetResponse, RawMaestroProcessGetAllResponse, RawProcessInstanceGetResponse, RawTaskCreateResponse, RawTaskGetResponse, RequestOptions, RequestSpec, ResponseDictionary, ResponseType, RetryOptions, RobotMetadata, SessionCapabilities, SessionEndEvent, SessionEndingEvent, SessionStartEvent, SessionStartedEvent, SessionStream, Simplify, SlaSummaryResponse, SourceJoinCriteria, SqlType, StageSLA, StageTask, Tag, TaskActivity, TaskAssignOptions, TaskAssignment, TaskAssignmentOptions, TaskAssignmentResponse, TaskBaseResponse, TaskCompleteOptions, TaskCompletionOptions, TaskCreateOptions, TaskCreateResponse, TaskGetAllOptions, TaskGetByIdOptions, TaskGetResponse, TaskGetUsersOptions, TaskMethods, TaskServiceModel, TaskSlaDetail, TaskSource, TasksUnassignOptions, TimeoutOptions, ToolCall, ToolCallConfirmationEndValue, ToolCallConfirmationEvent, ToolCallConfirmationInterruptStartEvent, ToolCallConfirmationValue, ToolCallEndEvent, ToolCallEvent, ToolCallInputValue, ToolCallOutputValue, ToolCallResult, ToolCallStartEvent, ToolCallStream, UiPathSDKConfig, UserLoginInfo, UserSettingsGetResponse, UserSettingsServiceModel, UserSettingsUpdateOptions, UserSettingsUpdateResponse };
|