@uipath/uipath-typescript 1.3.6 → 1.3.7
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 +204 -2
- package/dist/assets/index.d.ts +112 -13
- package/dist/assets/index.mjs +204 -2
- package/dist/attachments/index.cjs +3 -2
- package/dist/attachments/index.d.ts +7 -0
- package/dist/attachments/index.mjs +3 -2
- package/dist/buckets/index.cjs +172 -2
- package/dist/buckets/index.d.ts +56 -12
- package/dist/buckets/index.mjs +172 -2
- package/dist/cases/index.cjs +3 -2
- package/dist/cases/index.d.ts +7 -0
- package/dist/cases/index.mjs +3 -2
- package/dist/conversational-agent/index.cjs +196 -81
- package/dist/conversational-agent/index.d.ts +326 -80
- package/dist/conversational-agent/index.mjs +195 -80
- 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 +35 -6
- package/dist/entities/index.d.ts +101 -11
- package/dist/entities/index.mjs +36 -7
- package/dist/feedback/index.cjs +3 -2
- package/dist/feedback/index.d.ts +7 -0
- package/dist/feedback/index.mjs +3 -2
- package/dist/index.cjs +286 -13
- package/dist/index.d.ts +475 -32
- package/dist/index.mjs +287 -14
- package/dist/index.umd.js +286 -13
- package/dist/jobs/index.cjs +172 -2
- package/dist/jobs/index.d.ts +67 -23
- package/dist/jobs/index.mjs +172 -2
- package/dist/maestro-processes/index.cjs +3 -2
- package/dist/maestro-processes/index.d.ts +7 -0
- package/dist/maestro-processes/index.mjs +3 -2
- package/dist/processes/index.cjs +240 -3
- package/dist/processes/index.d.ts +124 -2
- package/dist/processes/index.mjs +240 -3
- package/dist/queues/index.cjs +172 -2
- package/dist/queues/index.d.ts +56 -12
- package/dist/queues/index.mjs +172 -2
- package/dist/tasks/index.cjs +3 -2
- package/dist/tasks/index.d.ts +7 -0
- package/dist/tasks/index.mjs +3 -2
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -388,6 +388,13 @@ interface ApiResponse<T> {
|
|
|
388
388
|
*/
|
|
389
389
|
declare class BaseService {
|
|
390
390
|
#private;
|
|
391
|
+
/**
|
|
392
|
+
* SDK configuration (read-only). Available to subclasses so they can
|
|
393
|
+
* fall back to init-time defaults like `folderKey`.
|
|
394
|
+
*/
|
|
395
|
+
protected readonly config: {
|
|
396
|
+
folderKey?: string;
|
|
397
|
+
};
|
|
391
398
|
/**
|
|
392
399
|
* Creates a base service instance with dependency injection.
|
|
393
400
|
*
|
|
@@ -643,7 +650,31 @@ interface EntityQuerySortOption {
|
|
|
643
650
|
isDescending?: boolean;
|
|
644
651
|
}
|
|
645
652
|
/**
|
|
646
|
-
*
|
|
653
|
+
* Aggregate functions supported by the Data Fabric query API.
|
|
654
|
+
*/
|
|
655
|
+
declare enum EntityAggregateFunction {
|
|
656
|
+
Count = "COUNT",
|
|
657
|
+
Sum = "SUM",
|
|
658
|
+
Avg = "AVG",
|
|
659
|
+
Min = "MIN",
|
|
660
|
+
Max = "MAX"
|
|
661
|
+
}
|
|
662
|
+
/**
|
|
663
|
+
* A single aggregate expression to apply during a query.
|
|
664
|
+
*
|
|
665
|
+
* Aggregate results are returned as fields on each item in the response,
|
|
666
|
+
* keyed by `alias` when provided.
|
|
667
|
+
*/
|
|
668
|
+
interface EntityAggregate {
|
|
669
|
+
/** Aggregate function to apply */
|
|
670
|
+
function: EntityAggregateFunction;
|
|
671
|
+
/** Field to aggregate on. For `COUNT`, any non-null field works (typically `Id`). */
|
|
672
|
+
field: string;
|
|
673
|
+
/** Optional alias for the aggregate result column. */
|
|
674
|
+
alias?: string;
|
|
675
|
+
}
|
|
676
|
+
/**
|
|
677
|
+
* Options for querying entity records with filters, sorting, aggregates, and pagination.
|
|
647
678
|
*
|
|
648
679
|
* Use `pageSize`, `cursor`, or `jumpToPage` for SDK-managed pagination.
|
|
649
680
|
* The SDK computes and manages offset parameters automatically.
|
|
@@ -657,6 +688,10 @@ type EntityQueryRecordsOptions = {
|
|
|
657
688
|
sortOptions?: EntityQuerySortOption[];
|
|
658
689
|
/** Level of entity expansion for related fields (default: 0) */
|
|
659
690
|
expansionLevel?: number;
|
|
691
|
+
/** Aggregate expressions (COUNT, SUM, AVG, MIN, MAX) to apply across the result set. */
|
|
692
|
+
aggregates?: EntityAggregate[];
|
|
693
|
+
/** Field names to group aggregate results by. */
|
|
694
|
+
groupBy?: string[];
|
|
660
695
|
} & PaginationOptions;
|
|
661
696
|
/**
|
|
662
697
|
* Response from querying entity records
|
|
@@ -1336,15 +1371,15 @@ interface EntityServiceModel {
|
|
|
1336
1371
|
*/
|
|
1337
1372
|
deleteRecordById(entityId: string, recordId: string): Promise<void>;
|
|
1338
1373
|
/**
|
|
1339
|
-
* Queries entity records with filters, sorting, and SDK-managed pagination
|
|
1374
|
+
* Queries entity records with filters, sorting, aggregates, and SDK-managed pagination
|
|
1340
1375
|
*
|
|
1341
1376
|
* @param id - UUID of the entity
|
|
1342
|
-
* @param options - Query options including filterGroup, selectedFields, sortOptions, and pagination
|
|
1377
|
+
* @param options - Query options including filterGroup, selectedFields, sortOptions, aggregates, groupBy, and pagination
|
|
1343
1378
|
* @returns Promise resolving to {@link NonPaginatedResponse} without pagination options,
|
|
1344
1379
|
* or {@link PaginatedResponse} when `pageSize`, `cursor`, or `jumpToPage` are provided
|
|
1345
1380
|
* @example
|
|
1346
1381
|
* ```typescript
|
|
1347
|
-
* import { Entities, LogicalOperator, QueryFilterOperator } from '@uipath/uipath-typescript/entities';
|
|
1382
|
+
* import { Entities, LogicalOperator, QueryFilterOperator, EntityAggregateFunction } from '@uipath/uipath-typescript/entities';
|
|
1348
1383
|
*
|
|
1349
1384
|
* const entities = new Entities(sdk);
|
|
1350
1385
|
*
|
|
@@ -1363,6 +1398,23 @@ interface EntityServiceModel {
|
|
|
1363
1398
|
* if (page1.hasNextPage) {
|
|
1364
1399
|
* const page2 = await entities.queryRecordsById(<id>, { cursor: page1.nextCursor });
|
|
1365
1400
|
* }
|
|
1401
|
+
*
|
|
1402
|
+
* // Aggregate: count of records per status
|
|
1403
|
+
* await entities.queryRecordsById(<id>, {
|
|
1404
|
+
* selectedFields: ["status"],
|
|
1405
|
+
* groupBy: ["status"],
|
|
1406
|
+
* aggregates: [
|
|
1407
|
+
* { function: EntityAggregateFunction.Count, field: "Id", alias: "total" },
|
|
1408
|
+
* ],
|
|
1409
|
+
* });
|
|
1410
|
+
*
|
|
1411
|
+
* // Aggregate: total sum and average across all records (no grouping)
|
|
1412
|
+
* await entities.queryRecordsById(<id>, {
|
|
1413
|
+
* aggregates: [
|
|
1414
|
+
* { function: EntityAggregateFunction.Sum, field: "amount", alias: "totalAmount" },
|
|
1415
|
+
* { function: EntityAggregateFunction.Avg, field: "amount", alias: "avgAmount" },
|
|
1416
|
+
* ],
|
|
1417
|
+
* });
|
|
1366
1418
|
* ```
|
|
1367
1419
|
*/
|
|
1368
1420
|
queryRecordsById<T extends EntityQueryRecordsOptions = EntityQueryRecordsOptions>(id: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<EntityRecord> : NonPaginatedResponse<EntityRecord>>;
|
|
@@ -1712,13 +1764,17 @@ interface EntityMethods {
|
|
|
1712
1764
|
*/
|
|
1713
1765
|
batchInsert(data: Record<string, any>[], options?: EntityBatchInsertOptions): Promise<EntityBatchInsertResponse>;
|
|
1714
1766
|
/**
|
|
1715
|
-
* Queries records in this entity with filters, sorting, and SDK-managed pagination
|
|
1767
|
+
* Queries records in this entity with filters, sorting, aggregates, and SDK-managed pagination
|
|
1716
1768
|
*
|
|
1717
|
-
* @param options - Query options including filterGroup, selectedFields, sortOptions, and pagination
|
|
1769
|
+
* @param options - Query options including filterGroup, selectedFields, sortOptions, aggregates, groupBy, and pagination
|
|
1718
1770
|
* @returns Promise resolving to {@link NonPaginatedResponse} without pagination options,
|
|
1719
1771
|
* or {@link PaginatedResponse} when `pageSize`, `cursor`, or `jumpToPage` are provided
|
|
1720
1772
|
* @example
|
|
1721
1773
|
* ```typescript
|
|
1774
|
+
* import { Entities, LogicalOperator, QueryFilterOperator, EntityAggregateFunction } from '@uipath/uipath-typescript/entities';
|
|
1775
|
+
*
|
|
1776
|
+
* const entities = new Entities(sdk);
|
|
1777
|
+
*
|
|
1722
1778
|
* const entity = await entities.getById(<entityId>);
|
|
1723
1779
|
* const result = await entity.queryRecords({
|
|
1724
1780
|
* filterGroup: {
|
|
@@ -1728,6 +1784,23 @@ interface EntityMethods {
|
|
|
1728
1784
|
* sortOptions: [{ fieldName: "createdTime", isDescending: true }],
|
|
1729
1785
|
* });
|
|
1730
1786
|
* console.log(`Found ${result.totalCount} records`);
|
|
1787
|
+
*
|
|
1788
|
+
* // Aggregate: count of records per status
|
|
1789
|
+
* await entity.queryRecords({
|
|
1790
|
+
* selectedFields: ["status"],
|
|
1791
|
+
* groupBy: ["status"],
|
|
1792
|
+
* aggregates: [
|
|
1793
|
+
* { function: EntityAggregateFunction.Count, field: "Id", alias: "total" },
|
|
1794
|
+
* ],
|
|
1795
|
+
* });
|
|
1796
|
+
*
|
|
1797
|
+
* // Aggregate: total sum and average across all records (no grouping)
|
|
1798
|
+
* await entity.queryRecords({
|
|
1799
|
+
* aggregates: [
|
|
1800
|
+
* { function: EntityAggregateFunction.Sum, field: "amount", alias: "totalAmount" },
|
|
1801
|
+
* { function: EntityAggregateFunction.Avg, field: "amount", alias: "avgAmount" },
|
|
1802
|
+
* ],
|
|
1803
|
+
* });
|
|
1731
1804
|
* ```
|
|
1732
1805
|
*/
|
|
1733
1806
|
queryRecords<T extends EntityQueryRecordsOptions = EntityQueryRecordsOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<EntityRecord> : NonPaginatedResponse<EntityRecord>>;
|
|
@@ -2060,16 +2133,16 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2060
2133
|
*/
|
|
2061
2134
|
getAll(): Promise<EntityGetResponse[]>;
|
|
2062
2135
|
/**
|
|
2063
|
-
* Queries entity records with filters, sorting, and pagination
|
|
2136
|
+
* Queries entity records with filters, sorting, aggregates, and pagination
|
|
2064
2137
|
*
|
|
2065
2138
|
* @param id - UUID of the entity
|
|
2066
|
-
* @param options - Query options including filterGroup, selectedFields, sortOptions, and pagination
|
|
2139
|
+
* @param options - Query options including filterGroup, selectedFields, sortOptions, aggregates, groupBy, and pagination
|
|
2067
2140
|
* @returns Promise resolving to {@link NonPaginatedResponse} without pagination options,
|
|
2068
2141
|
* or {@link PaginatedResponse} when `pageSize`, `cursor`, or `jumpToPage` are provided
|
|
2069
2142
|
*
|
|
2070
2143
|
* @example
|
|
2071
2144
|
* ```typescript
|
|
2072
|
-
* import { Entities, LogicalOperator, QueryFilterOperator } from '@uipath/uipath-typescript/entities';
|
|
2145
|
+
* import { Entities, LogicalOperator, QueryFilterOperator, EntityAggregateFunction } from '@uipath/uipath-typescript/entities';
|
|
2073
2146
|
*
|
|
2074
2147
|
* const entities = new Entities(sdk);
|
|
2075
2148
|
*
|
|
@@ -2093,6 +2166,23 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
2093
2166
|
* if (page1.hasNextPage) {
|
|
2094
2167
|
* const page2 = await entities.queryRecordsById("<entityId>", { cursor: page1.nextCursor });
|
|
2095
2168
|
* }
|
|
2169
|
+
*
|
|
2170
|
+
* // Aggregate: count of records per status
|
|
2171
|
+
* await entities.queryRecordsById("<entityId>", {
|
|
2172
|
+
* selectedFields: ["status"],
|
|
2173
|
+
* groupBy: ["status"],
|
|
2174
|
+
* aggregates: [
|
|
2175
|
+
* { function: EntityAggregateFunction.Count, field: "Id", alias: "total" },
|
|
2176
|
+
* ],
|
|
2177
|
+
* });
|
|
2178
|
+
*
|
|
2179
|
+
* // Aggregate: total sum and average across all records (no grouping)
|
|
2180
|
+
* await entities.queryRecordsById("<entityId>", {
|
|
2181
|
+
* aggregates: [
|
|
2182
|
+
* { function: EntityAggregateFunction.Sum, field: "amount", alias: "totalAmount" },
|
|
2183
|
+
* { function: EntityAggregateFunction.Avg, field: "amount", alias: "avgAmount" },
|
|
2184
|
+
* ],
|
|
2185
|
+
* });
|
|
2096
2186
|
* ```
|
|
2097
2187
|
*/
|
|
2098
2188
|
queryRecordsById<T extends EntityQueryRecordsOptions = EntityQueryRecordsOptions>(id: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<EntityRecord> : NonPaginatedResponse<EntityRecord>>;
|
|
@@ -2946,6 +3036,20 @@ interface RequestOptions extends BaseOptions {
|
|
|
2946
3036
|
filter?: string;
|
|
2947
3037
|
orderby?: string;
|
|
2948
3038
|
}
|
|
3039
|
+
/**
|
|
3040
|
+
* Options that scope a name-based lookup (e.g. `getByName`) to a folder.
|
|
3041
|
+
* Provide one of `folderId`, `folderKey`, or `folderPath`. When more than
|
|
3042
|
+
* one is supplied, all are forwarded; the server applies precedence
|
|
3043
|
+
* `folderPath` > `folderKey` > `folderId`.
|
|
3044
|
+
*/
|
|
3045
|
+
interface FolderScopedOptions extends BaseOptions {
|
|
3046
|
+
/** Numeric folder ID. */
|
|
3047
|
+
folderId?: number;
|
|
3048
|
+
/** Folder key (GUID-formatted string). */
|
|
3049
|
+
folderKey?: string;
|
|
3050
|
+
/** Slash-delimited folder path, e.g. `'Shared/Finance'`. */
|
|
3051
|
+
folderPath?: string;
|
|
3052
|
+
}
|
|
2949
3053
|
|
|
2950
3054
|
/**
|
|
2951
3055
|
* Service for managing UiPath Maestro Process instances
|
|
@@ -4878,6 +4982,29 @@ declare class FolderScopedService extends BaseService {
|
|
|
4878
4982
|
* @returns Promise resolving to an array of resources
|
|
4879
4983
|
*/
|
|
4880
4984
|
protected _getByFolder<T, R = T>(endpoint: string, folderId: number, options?: Record<string, any>, transformFn?: (item: T) => R): Promise<R[]>;
|
|
4985
|
+
/**
|
|
4986
|
+
* Look up a single resource by name on a folder-scoped OData collection.
|
|
4987
|
+
*
|
|
4988
|
+
* Shared by `getByName` implementations across services (Assets, Processes, etc).
|
|
4989
|
+
* Handles:
|
|
4990
|
+
* - Name validation via `validateName`
|
|
4991
|
+
* - Folder header resolution via `resolveFolderHeaders` (folderId → ID/key
|
|
4992
|
+
* header by type, folderPath → encoded path header, falls back to
|
|
4993
|
+
* init-time `config.folderKey` from the `uipath:folder-key` meta tag)
|
|
4994
|
+
* - OData `$filter=Name eq '…'` with single-quote escaping + `$top=1`
|
|
4995
|
+
* - Empty-result → `NotFoundError` with folder context in the message
|
|
4996
|
+
*
|
|
4997
|
+
* The transform step is caller-provided because each resource has its own
|
|
4998
|
+
* PascalCase → camelCase field mapping.
|
|
4999
|
+
*
|
|
5000
|
+
* @param resourceType - Resource label used in validation + error messages (e.g. 'Asset', 'Process')
|
|
5001
|
+
* @param endpoint - Folder-scoped OData collection endpoint
|
|
5002
|
+
* @param name - Resource name to search for
|
|
5003
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) + OData query options (`expand`, `select`)
|
|
5004
|
+
* @param transform - Maps a raw OData item to the typed response (e.g. PascalCase → camelCase via field map)
|
|
5005
|
+
* @throws ValidationError when inputs are malformed; NotFoundError when no match
|
|
5006
|
+
*/
|
|
5007
|
+
protected getByNameLookup<TRaw extends object, T>(resourceType: string, endpoint: string, name: string, options: FolderScopedOptions, transform: (raw: TRaw) => T): Promise<T>;
|
|
4881
5008
|
}
|
|
4882
5009
|
|
|
4883
5010
|
/**
|
|
@@ -4943,6 +5070,11 @@ type AssetGetAllOptions = RequestOptions & PaginationOptions & {
|
|
|
4943
5070
|
*/
|
|
4944
5071
|
interface AssetGetByIdOptions extends BaseOptions {
|
|
4945
5072
|
}
|
|
5073
|
+
/**
|
|
5074
|
+
* Options for getting a single asset by name
|
|
5075
|
+
*/
|
|
5076
|
+
interface AssetGetByNameOptions extends FolderScopedOptions {
|
|
5077
|
+
}
|
|
4946
5078
|
|
|
4947
5079
|
/**
|
|
4948
5080
|
* Service for managing UiPath Assets.
|
|
@@ -5004,6 +5136,29 @@ interface AssetServiceModel {
|
|
|
5004
5136
|
* ```
|
|
5005
5137
|
*/
|
|
5006
5138
|
getById(id: number, folderId: number, options?: AssetGetByIdOptions): Promise<AssetGetResponse>;
|
|
5139
|
+
/**
|
|
5140
|
+
* Retrieves a single asset by name.
|
|
5141
|
+
*
|
|
5142
|
+
* @param name - Asset name to search for
|
|
5143
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
|
|
5144
|
+
* @returns Promise resolving to a single asset
|
|
5145
|
+
* {@link AssetGetResponse}
|
|
5146
|
+
* @example
|
|
5147
|
+
* ```typescript
|
|
5148
|
+
* // By folder ID
|
|
5149
|
+
* await assets.getByName('ApiKey', { folderId: 123 });
|
|
5150
|
+
*
|
|
5151
|
+
* // By folder key (GUID)
|
|
5152
|
+
* await assets.getByName('ApiKey', { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
|
|
5153
|
+
*
|
|
5154
|
+
* // By folder path
|
|
5155
|
+
* await assets.getByName('ApiKey', { folderPath: 'Shared/Finance' });
|
|
5156
|
+
*
|
|
5157
|
+
* // With expand
|
|
5158
|
+
* await assets.getByName('ApiKey', { folderPath: 'Shared/Finance', expand: 'keyValueList' });
|
|
5159
|
+
* ```
|
|
5160
|
+
*/
|
|
5161
|
+
getByName(name: string, options?: AssetGetByNameOptions): Promise<AssetGetResponse>;
|
|
5007
5162
|
}
|
|
5008
5163
|
|
|
5009
5164
|
/**
|
|
@@ -5064,6 +5219,33 @@ declare class AssetService extends FolderScopedService implements AssetServiceMo
|
|
|
5064
5219
|
* ```
|
|
5065
5220
|
*/
|
|
5066
5221
|
getById(id: number, folderId: number, options?: AssetGetByIdOptions): Promise<AssetGetResponse>;
|
|
5222
|
+
/**
|
|
5223
|
+
* Retrieves a single asset by name.
|
|
5224
|
+
*
|
|
5225
|
+
* @param name - Asset name to search for
|
|
5226
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
|
|
5227
|
+
* @returns Promise resolving to a single asset
|
|
5228
|
+
* {@link AssetGetResponse}
|
|
5229
|
+
* @example
|
|
5230
|
+
* ```typescript
|
|
5231
|
+
* import { Assets } from '@uipath/uipath-typescript/assets';
|
|
5232
|
+
*
|
|
5233
|
+
* const assets = new Assets(sdk);
|
|
5234
|
+
*
|
|
5235
|
+
* // By folder ID
|
|
5236
|
+
* await assets.getByName('ApiKey', { folderId: 123 });
|
|
5237
|
+
*
|
|
5238
|
+
* // By folder key (GUID)
|
|
5239
|
+
* await assets.getByName('ApiKey', { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
|
|
5240
|
+
*
|
|
5241
|
+
* // By folder path
|
|
5242
|
+
* await assets.getByName('ApiKey', { folderPath: 'Shared/Finance' });
|
|
5243
|
+
*
|
|
5244
|
+
* // With expand
|
|
5245
|
+
* await assets.getByName('ApiKey', { folderPath: 'Shared/Finance', expand: 'keyValueList' });
|
|
5246
|
+
* ```
|
|
5247
|
+
*/
|
|
5248
|
+
getByName(name: string, options?: AssetGetByNameOptions): Promise<AssetGetResponse>;
|
|
5067
5249
|
}
|
|
5068
5250
|
|
|
5069
5251
|
declare enum BucketOptions {
|
|
@@ -5913,6 +6095,11 @@ type ProcessGetAllOptions = RequestOptions & PaginationOptions & {
|
|
|
5913
6095
|
*/
|
|
5914
6096
|
interface ProcessGetByIdOptions extends BaseOptions {
|
|
5915
6097
|
}
|
|
6098
|
+
/**
|
|
6099
|
+
* Options for getting a single process by name
|
|
6100
|
+
*/
|
|
6101
|
+
interface ProcessGetByNameOptions extends FolderScopedOptions {
|
|
6102
|
+
}
|
|
5916
6103
|
|
|
5917
6104
|
/**
|
|
5918
6105
|
* Enum for job sub-state
|
|
@@ -6425,6 +6612,29 @@ interface ProcessServiceModel {
|
|
|
6425
6612
|
* ```
|
|
6426
6613
|
*/
|
|
6427
6614
|
getById(id: number, folderId: number, options?: ProcessGetByIdOptions): Promise<ProcessGetResponse>;
|
|
6615
|
+
/**
|
|
6616
|
+
* Retrieves a single process by name.
|
|
6617
|
+
*
|
|
6618
|
+
* @param name - Process name to search for
|
|
6619
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
|
|
6620
|
+
* @returns Promise resolving to a single process
|
|
6621
|
+
* {@link ProcessGetResponse}
|
|
6622
|
+
* @example
|
|
6623
|
+
* ```typescript
|
|
6624
|
+
* // By folder ID
|
|
6625
|
+
* await processes.getByName('MyProcess', { folderId: 123 });
|
|
6626
|
+
*
|
|
6627
|
+
* // By folder key (GUID)
|
|
6628
|
+
* await processes.getByName('MyProcess', { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
|
|
6629
|
+
*
|
|
6630
|
+
* // By folder path
|
|
6631
|
+
* await processes.getByName('MyProcess', { folderPath: 'Shared/Finance' });
|
|
6632
|
+
*
|
|
6633
|
+
* // With expand
|
|
6634
|
+
* await processes.getByName('MyProcess', { folderPath: 'Shared/Finance', expand: 'entryPoints' });
|
|
6635
|
+
* ```
|
|
6636
|
+
*/
|
|
6637
|
+
getByName(name: string, options?: ProcessGetByNameOptions): Promise<ProcessGetResponse>;
|
|
6428
6638
|
/**
|
|
6429
6639
|
* Starts a process with the specified configuration
|
|
6430
6640
|
*
|
|
@@ -6452,7 +6662,7 @@ interface ProcessServiceModel {
|
|
|
6452
6662
|
/**
|
|
6453
6663
|
* Service for interacting with UiPath Orchestrator Processes API
|
|
6454
6664
|
*/
|
|
6455
|
-
declare class ProcessService extends
|
|
6665
|
+
declare class ProcessService extends FolderScopedService implements ProcessServiceModel {
|
|
6456
6666
|
/**
|
|
6457
6667
|
* Gets all processes across folders with optional filtering and folder scoping
|
|
6458
6668
|
*
|
|
@@ -6543,6 +6753,33 @@ declare class ProcessService extends BaseService implements ProcessServiceModel
|
|
|
6543
6753
|
* ```
|
|
6544
6754
|
*/
|
|
6545
6755
|
getById(id: number, folderId: number, options?: ProcessGetByIdOptions): Promise<ProcessGetResponse>;
|
|
6756
|
+
/**
|
|
6757
|
+
* Retrieves a single process by name.
|
|
6758
|
+
*
|
|
6759
|
+
* @param name - Process name to search for
|
|
6760
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
|
|
6761
|
+
* @returns Promise resolving to a single process
|
|
6762
|
+
* {@link ProcessGetResponse}
|
|
6763
|
+
* @example
|
|
6764
|
+
* ```typescript
|
|
6765
|
+
* import { Processes } from '@uipath/uipath-typescript/processes';
|
|
6766
|
+
*
|
|
6767
|
+
* const processes = new Processes(sdk);
|
|
6768
|
+
*
|
|
6769
|
+
* // By folder ID
|
|
6770
|
+
* await processes.getByName('MyProcess', { folderId: 123 });
|
|
6771
|
+
*
|
|
6772
|
+
* // By folder key (GUID)
|
|
6773
|
+
* await processes.getByName('MyProcess', { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
|
|
6774
|
+
*
|
|
6775
|
+
* // By folder path
|
|
6776
|
+
* await processes.getByName('MyProcess', { folderPath: 'Shared/Finance' });
|
|
6777
|
+
*
|
|
6778
|
+
* // With expand
|
|
6779
|
+
* await processes.getByName('MyProcess', { folderPath: 'Shared/Finance', expand: 'entryPoints' });
|
|
6780
|
+
* ```
|
|
6781
|
+
*/
|
|
6782
|
+
getByName(name: string, options?: ProcessGetByNameOptions): Promise<ProcessGetResponse>;
|
|
6546
6783
|
}
|
|
6547
6784
|
|
|
6548
6785
|
/**
|
|
@@ -7171,6 +7408,14 @@ declare class UiPath extends UiPath$1 {
|
|
|
7171
7408
|
get assets(): AssetService;
|
|
7172
7409
|
}
|
|
7173
7410
|
|
|
7411
|
+
/**
|
|
7412
|
+
* Meta-tag-derived config. Extends {@link PartialUiPathConfig} with
|
|
7413
|
+
* `folderKey`, which is sourced only from `<meta name="uipath:folder-key">`
|
|
7414
|
+
* (not accepted via the public SDK constructor).
|
|
7415
|
+
*/
|
|
7416
|
+
type MetaTagConfig = PartialUiPathConfig & {
|
|
7417
|
+
folderKey?: string;
|
|
7418
|
+
};
|
|
7174
7419
|
/**
|
|
7175
7420
|
* Load configuration from HTML meta tags injected at runtime.
|
|
7176
7421
|
* These meta tags are injected by @uipath/coded-apps during build
|
|
@@ -7178,7 +7423,7 @@ declare class UiPath extends UiPath$1 {
|
|
|
7178
7423
|
*
|
|
7179
7424
|
* Returns partial config with values found, or null if no meta tags present.
|
|
7180
7425
|
*/
|
|
7181
|
-
declare function loadFromMetaTags():
|
|
7426
|
+
declare function loadFromMetaTags(): MetaTagConfig | null;
|
|
7182
7427
|
|
|
7183
7428
|
/**
|
|
7184
7429
|
* Constants for Conversational Agent
|
|
@@ -8049,7 +8294,34 @@ interface ToolCallStartEvent {
|
|
|
8049
8294
|
* Optional metadata pertaining to the tool call.
|
|
8050
8295
|
*/
|
|
8051
8296
|
metaData?: MetaData;
|
|
8297
|
+
/**
|
|
8298
|
+
* Indicates that the tool call requires user confirmation before execution.
|
|
8299
|
+
* When true, the client should render a confirmation UI and respond with a
|
|
8300
|
+
* `confirmToolCall` event on the same tool call.
|
|
8301
|
+
*/
|
|
8302
|
+
requireConfirmation?: boolean;
|
|
8303
|
+
/**
|
|
8304
|
+
* JSON schema describing the tool's input parameters. Present when
|
|
8305
|
+
* `requireConfirmation` is true so the client can render an editable form.
|
|
8306
|
+
*/
|
|
8307
|
+
inputSchema?: JSONValue;
|
|
8052
8308
|
}
|
|
8309
|
+
/**
|
|
8310
|
+
* Sent by the client to approve or reject a tool call that was emitted with
|
|
8311
|
+
* `requireConfirmation: true`. Carries the user's decision and, when approved,
|
|
8312
|
+
* the (possibly edited) input the tool should execute with.
|
|
8313
|
+
*
|
|
8314
|
+
* `input` is required when `approved` is `true` and optional when `approved`
|
|
8315
|
+
* is `false`. The discriminated union enforces this at compile time so
|
|
8316
|
+
* `{ approved: true }` (no `input`) is a type error.
|
|
8317
|
+
*/
|
|
8318
|
+
type ToolCallConfirmationEvent = {
|
|
8319
|
+
approved: true;
|
|
8320
|
+
input: JSONValue;
|
|
8321
|
+
} | {
|
|
8322
|
+
approved: false;
|
|
8323
|
+
input?: JSONValue;
|
|
8324
|
+
};
|
|
8053
8325
|
/**
|
|
8054
8326
|
* Signals the end of a tool call.
|
|
8055
8327
|
*/
|
|
@@ -8110,6 +8382,11 @@ interface ToolCallEvent {
|
|
|
8110
8382
|
* Signals the end of a tool call.
|
|
8111
8383
|
*/
|
|
8112
8384
|
endToolCall?: ToolCallEndEvent;
|
|
8385
|
+
/**
|
|
8386
|
+
* Signals the user's approve/reject decision for a tool call that was
|
|
8387
|
+
* emitted with `requireConfirmation: true`.
|
|
8388
|
+
*/
|
|
8389
|
+
confirmToolCall?: ToolCallConfirmationEvent;
|
|
8113
8390
|
/**
|
|
8114
8391
|
* Allows additional events to be sent in the context of the enclosing event stream.
|
|
8115
8392
|
*/
|
|
@@ -8121,6 +8398,11 @@ interface ToolCallEvent {
|
|
|
8121
8398
|
}
|
|
8122
8399
|
/**
|
|
8123
8400
|
* Schema for tool call confirmation interrupt value.
|
|
8401
|
+
*
|
|
8402
|
+
* @deprecated Tool call confirmation now travels on {@link ToolCallStartEvent} via
|
|
8403
|
+
* `requireConfirmation: true` / `inputSchema` and is responded to with
|
|
8404
|
+
* {@link ToolCallConfirmationEvent}. This shape is retained for agents on the legacy
|
|
8405
|
+
* runtime that still emit confirmations as interrupts.
|
|
8124
8406
|
*/
|
|
8125
8407
|
interface ToolCallConfirmationValue {
|
|
8126
8408
|
/**
|
|
@@ -8142,6 +8424,10 @@ interface ToolCallConfirmationValue {
|
|
|
8142
8424
|
}
|
|
8143
8425
|
/**
|
|
8144
8426
|
* Schema for tool call confirmation end value.
|
|
8427
|
+
*
|
|
8428
|
+
* @deprecated Confirmation responses now use {@link ToolCallConfirmationEvent} (sent via
|
|
8429
|
+
* {@link ToolCallStream.sendToolCallConfirm}). This shape is retained for agents on the
|
|
8430
|
+
* legacy runtime that consume confirmations through the interrupt-end channel.
|
|
8145
8431
|
*/
|
|
8146
8432
|
interface ToolCallConfirmationEndValue {
|
|
8147
8433
|
/**
|
|
@@ -8155,6 +8441,11 @@ interface ToolCallConfirmationEndValue {
|
|
|
8155
8441
|
}
|
|
8156
8442
|
/**
|
|
8157
8443
|
* Known interrupt start event for tool call confirmation.
|
|
8444
|
+
*
|
|
8445
|
+
* @deprecated Emitted only by agents on the legacy runtime. Agents on the current runtime
|
|
8446
|
+
* express confirmation as `requireConfirmation: true` on {@link ToolCallStartEvent}, with
|
|
8447
|
+
* the client responding via {@link ToolCallConfirmationEvent} (`confirmToolCall` on
|
|
8448
|
+
* {@link ToolCallEvent}).
|
|
8158
8449
|
*/
|
|
8159
8450
|
interface ToolCallConfirmationInterruptStartEvent {
|
|
8160
8451
|
/**
|
|
@@ -8744,6 +9035,36 @@ type CompletedToolCall = ToolCallStartEvent & ToolCallEndEvent & {
|
|
|
8744
9035
|
* });
|
|
8745
9036
|
* });
|
|
8746
9037
|
* ```
|
|
9038
|
+
*
|
|
9039
|
+
* @example Migrating from legacy interrupt-based confirmation
|
|
9040
|
+
* ```typescript
|
|
9041
|
+
* // BEFORE — legacy interrupt flow
|
|
9042
|
+
* message.onInterruptStart(async ({ interruptId, startEvent }) => {
|
|
9043
|
+
* if (startEvent.type !== InterruptType.ToolCallConfirmation) return;
|
|
9044
|
+
* const { toolName, inputSchema, inputValue } = startEvent.value;
|
|
9045
|
+
*
|
|
9046
|
+
* const decision = await showConfirmationDialog({
|
|
9047
|
+
* toolName, inputSchema, input: inputValue,
|
|
9048
|
+
* });
|
|
9049
|
+
* message.sendInterruptEnd(interruptId, {
|
|
9050
|
+
* approved: decision.approved,
|
|
9051
|
+
* input: decision.editedInput,
|
|
9052
|
+
* });
|
|
9053
|
+
* });
|
|
9054
|
+
*
|
|
9055
|
+
* // AFTER — new tool-call confirmation flow
|
|
9056
|
+
* message.onToolCallStart(async (toolCall) => {
|
|
9057
|
+
* const { toolName, input, requireConfirmation, inputSchema } = toolCall.startEvent;
|
|
9058
|
+
* if (!requireConfirmation) return;
|
|
9059
|
+
*
|
|
9060
|
+
* const decision = await showConfirmationDialog({ toolName, inputSchema, input });
|
|
9061
|
+
* if (decision.approved) {
|
|
9062
|
+
* toolCall.sendToolCallConfirm({ approved: true, input: decision.editedInput });
|
|
9063
|
+
* } else {
|
|
9064
|
+
* toolCall.sendToolCallConfirm({ approved: false });
|
|
9065
|
+
* }
|
|
9066
|
+
* });
|
|
9067
|
+
* ```
|
|
8747
9068
|
*/
|
|
8748
9069
|
interface ToolCallStream {
|
|
8749
9070
|
/** Unique identifier for this tool call */
|
|
@@ -8798,6 +9119,23 @@ interface ToolCallStream {
|
|
|
8798
9119
|
* ```
|
|
8799
9120
|
*/
|
|
8800
9121
|
onToolCallEnd(cb: (endToolCall: ToolCallEndEvent) => void): () => void;
|
|
9122
|
+
/**
|
|
9123
|
+
* Registers a handler for tool call confirmation events. Fired when the
|
|
9124
|
+
* peer responds to a tool call that was emitted with
|
|
9125
|
+
* `requireConfirmation: true` on its start event.
|
|
9126
|
+
*
|
|
9127
|
+
* @param callback - Callback receiving the confirmation event
|
|
9128
|
+
* @returns Cleanup function to remove the handler
|
|
9129
|
+
*
|
|
9130
|
+
* @example Handling a confirmation response (agent-side)
|
|
9131
|
+
* ```typescript
|
|
9132
|
+
* toolCall.onToolCallConfirm(({ approved, input }) => {
|
|
9133
|
+
* if (approved) executeTool(toolCall.startEvent.toolName, input);
|
|
9134
|
+
* else cancelToolCall();
|
|
9135
|
+
* });
|
|
9136
|
+
* ```
|
|
9137
|
+
*/
|
|
9138
|
+
onToolCallConfirm(callback: (confirmToolCall: ToolCallConfirmationEvent) => void): () => void;
|
|
8801
9139
|
/**
|
|
8802
9140
|
* Ends the tool call
|
|
8803
9141
|
*
|
|
@@ -8811,6 +9149,25 @@ interface ToolCallStream {
|
|
|
8811
9149
|
* ```
|
|
8812
9150
|
*/
|
|
8813
9151
|
sendToolCallEnd(endToolCall?: ToolCallEndEvent): void;
|
|
9152
|
+
/**
|
|
9153
|
+
* Sends a tool call confirmation (approve or reject) for a tool call that
|
|
9154
|
+
* was emitted with `requireConfirmation: true`. Replaces the legacy
|
|
9155
|
+
* interrupt-based confirmation flow.
|
|
9156
|
+
*
|
|
9157
|
+
* @param confirmToolCall - The user's decision and (when approved) the
|
|
9158
|
+
* possibly-edited input the tool should execute with
|
|
9159
|
+
*
|
|
9160
|
+
* @example Approving a tool call
|
|
9161
|
+
* ```typescript
|
|
9162
|
+
* toolCall.sendToolCallConfirm({ approved: true, input: editedInput });
|
|
9163
|
+
* ```
|
|
9164
|
+
*
|
|
9165
|
+
* @example Rejecting a tool call
|
|
9166
|
+
* ```typescript
|
|
9167
|
+
* toolCall.sendToolCallConfirm({ approved: false });
|
|
9168
|
+
* ```
|
|
9169
|
+
*/
|
|
9170
|
+
sendToolCallConfirm(confirmToolCall: ToolCallConfirmationEvent): void;
|
|
8814
9171
|
/**
|
|
8815
9172
|
* Sends an error start event for this tool call
|
|
8816
9173
|
* @param args - Error details including optional error ID and message
|
|
@@ -9429,6 +9786,28 @@ interface MessageStream {
|
|
|
9429
9786
|
* ```
|
|
9430
9787
|
*/
|
|
9431
9788
|
sendInterruptEnd(interruptId: string, endInterrupt: InterruptEndEvent): void;
|
|
9789
|
+
/**
|
|
9790
|
+
* Registers a handler for tool-call confirmation events on this message
|
|
9791
|
+
*
|
|
9792
|
+
* Fired when a peer responds to a tool call that was emitted with
|
|
9793
|
+
* `requireConfirmation: true`. The handler runs at the message level, so it
|
|
9794
|
+
* fires even if no per-tool-call stream exists for the confirmed `toolCallId`.
|
|
9795
|
+
*
|
|
9796
|
+
* @param callback - Callback receiving the toolCallId and the confirmation event
|
|
9797
|
+
* @returns Cleanup function to remove the handler
|
|
9798
|
+
*
|
|
9799
|
+
* @example Handling a tool-call confirmation response
|
|
9800
|
+
* ```typescript
|
|
9801
|
+
* message.onToolCallConfirm(({ toolCallId, confirmEvent }) => {
|
|
9802
|
+
* if (confirmEvent.approved) executeTool(toolCallId, confirmEvent.input);
|
|
9803
|
+
* else cancelToolCall(toolCallId);
|
|
9804
|
+
* });
|
|
9805
|
+
* ```
|
|
9806
|
+
*/
|
|
9807
|
+
onToolCallConfirm(callback: (args: {
|
|
9808
|
+
toolCallId: string;
|
|
9809
|
+
confirmEvent: ToolCallConfirmationEvent;
|
|
9810
|
+
}) => void): () => void;
|
|
9432
9811
|
/**
|
|
9433
9812
|
* Starts a new content part stream in this message
|
|
9434
9813
|
*
|
|
@@ -11296,7 +11675,7 @@ declare const AgentMap: {
|
|
|
11296
11675
|
};
|
|
11297
11676
|
|
|
11298
11677
|
/**
|
|
11299
|
-
* Types for User Service
|
|
11678
|
+
* Types for User Settings Service
|
|
11300
11679
|
*/
|
|
11301
11680
|
/**
|
|
11302
11681
|
* Response for getting user settings
|
|
@@ -11374,46 +11753,92 @@ interface UserSettingsUpdateOptions {
|
|
|
11374
11753
|
}
|
|
11375
11754
|
|
|
11376
11755
|
/**
|
|
11377
|
-
* Service for
|
|
11756
|
+
* Service for reading and updating the current user's profile and context settings.
|
|
11378
11757
|
*
|
|
11379
|
-
* User settings are
|
|
11380
|
-
* to
|
|
11758
|
+
* User settings are user-supplied profile fields (name, email, role, department, company,
|
|
11759
|
+
* country, timezone) that the SDK passes to a UiPath Conversational Agent on every conversation
|
|
11760
|
+
* so the agent can personalize its responses. Settings are scoped to the calling user — identified
|
|
11761
|
+
* by the access token for user tokens, or by the externalUserId option for app-scoped tokens.
|
|
11381
11762
|
*
|
|
11382
|
-
*
|
|
11763
|
+
* Accessed via `conversationalAgent.user`.
|
|
11764
|
+
*
|
|
11765
|
+
* @example Read current settings
|
|
11766
|
+
* ```typescript
|
|
11767
|
+
* import { ConversationalAgent } from '@uipath/uipath-typescript/conversational-agent';
|
|
11768
|
+
*
|
|
11769
|
+
* const conversationalAgent = new ConversationalAgent(sdk);
|
|
11770
|
+
*
|
|
11771
|
+
* const settings = await conversationalAgent.user.getSettings();
|
|
11772
|
+
* console.log(settings.name, settings.email, settings.timezone);
|
|
11773
|
+
* ```
|
|
11774
|
+
*
|
|
11775
|
+
* @example Update specific fields (partial update)
|
|
11776
|
+
* ```typescript
|
|
11777
|
+
* await conversationalAgent.user.updateSettings({
|
|
11778
|
+
* name: 'John Doe',
|
|
11779
|
+
* timezone: 'America/New_York'
|
|
11780
|
+
* });
|
|
11781
|
+
* ```
|
|
11782
|
+
*
|
|
11783
|
+
* @example Clear a field by setting it to null
|
|
11784
|
+
* ```typescript
|
|
11785
|
+
* await conversationalAgent.user.updateSettings({
|
|
11786
|
+
* department: null
|
|
11787
|
+
* });
|
|
11788
|
+
* ```
|
|
11383
11789
|
*/
|
|
11384
|
-
interface
|
|
11790
|
+
interface UserSettingsServiceModel {
|
|
11385
11791
|
/**
|
|
11386
|
-
* Gets the current user's profile and context settings
|
|
11792
|
+
* Gets the current user's profile and context settings.
|
|
11387
11793
|
*
|
|
11388
|
-
*
|
|
11794
|
+
* Returns the full user settings record — profile fields the agent uses for personalization
|
|
11795
|
+
* (name, email, role, department, company, country, timezone) plus identifiers and timestamps.
|
|
11796
|
+
* Fields the user has not set are returned as `null`.
|
|
11797
|
+
*
|
|
11798
|
+
* @returns Promise resolving to the current user's settings
|
|
11389
11799
|
* {@link UserSettingsGetResponse}
|
|
11800
|
+
*
|
|
11390
11801
|
* @example
|
|
11391
11802
|
* ```typescript
|
|
11392
|
-
* const
|
|
11393
|
-
* console.log(
|
|
11394
|
-
* console.log(
|
|
11803
|
+
* const settings = await conversationalAgent.user.getSettings();
|
|
11804
|
+
* console.log(settings.name); // e.g. 'John Doe' or null
|
|
11805
|
+
* console.log(settings.email); // e.g. 'john@example.com' or null
|
|
11806
|
+
* console.log(settings.timezone); // e.g. 'America/New_York' or null
|
|
11395
11807
|
* ```
|
|
11396
11808
|
*/
|
|
11397
11809
|
getSettings(): Promise<UserSettingsGetResponse>;
|
|
11398
11810
|
/**
|
|
11399
|
-
* Updates the current user's profile and context settings
|
|
11811
|
+
* Updates the current user's profile and context settings.
|
|
11400
11812
|
*
|
|
11401
|
-
*
|
|
11402
|
-
*
|
|
11813
|
+
* Accepts a partial payload — only fields included in `options` are changed. Pass `null` to
|
|
11814
|
+
* explicitly clear a field. Omitting a field leaves it unchanged. Returns the full updated
|
|
11815
|
+
* settings record.
|
|
11816
|
+
*
|
|
11817
|
+
* @param options - Fields to update; omit fields to leave them unchanged, set to `null` to clear
|
|
11818
|
+
* @returns Promise resolving to the updated user settings
|
|
11403
11819
|
* {@link UserSettingsUpdateResponse}
|
|
11404
|
-
*
|
|
11820
|
+
*
|
|
11821
|
+
* @example Partial update
|
|
11405
11822
|
* ```typescript
|
|
11406
|
-
* const
|
|
11823
|
+
* const updated = await conversationalAgent.user.updateSettings({
|
|
11407
11824
|
* name: 'John Doe',
|
|
11408
11825
|
* timezone: 'America/New_York'
|
|
11409
11826
|
* });
|
|
11410
11827
|
* ```
|
|
11828
|
+
*
|
|
11829
|
+
* @example Clear fields by setting to null
|
|
11830
|
+
* ```typescript
|
|
11831
|
+
* await conversationalAgent.user.updateSettings({
|
|
11832
|
+
* role: null,
|
|
11833
|
+
* department: null
|
|
11834
|
+
* });
|
|
11835
|
+
* ```
|
|
11411
11836
|
*/
|
|
11412
11837
|
updateSettings(options: UserSettingsUpdateOptions): Promise<UserSettingsUpdateResponse>;
|
|
11413
11838
|
}
|
|
11414
11839
|
|
|
11415
11840
|
/**
|
|
11416
|
-
* Constants for User Service
|
|
11841
|
+
* Constants for User Settings Service
|
|
11417
11842
|
*/
|
|
11418
11843
|
/**
|
|
11419
11844
|
* Maps fields for User Settings entities to ensure consistent SDK naming
|
|
@@ -11575,6 +12000,8 @@ interface ConversationalAgentServiceModel {
|
|
|
11575
12000
|
onConnectionStatusChanged(handler: (status: ConnectionStatus, error: Error | null) => void): () => void;
|
|
11576
12001
|
/** Service for creating and managing conversations. See {@link ConversationServiceModel}. */
|
|
11577
12002
|
readonly conversations: ConversationServiceModel;
|
|
12003
|
+
/** Service for reading and updating the current user's profile/context settings. See {@link UserSettingsServiceModel}. */
|
|
12004
|
+
readonly user: UserSettingsServiceModel;
|
|
11578
12005
|
/**
|
|
11579
12006
|
* Gets feature flags for the current tenant
|
|
11580
12007
|
*
|
|
@@ -11593,6 +12020,21 @@ interface ConversationalAgentOptions {
|
|
|
11593
12020
|
* external app client; omit for standard UiPath user tokens.
|
|
11594
12021
|
*/
|
|
11595
12022
|
externalUserId?: string;
|
|
12023
|
+
/**
|
|
12024
|
+
* Optional identifier used in UiPath logs to identify the implementing service
|
|
12025
|
+
* of requests. External consumers do not need to set it; the server logs
|
|
12026
|
+
* missing values as "unknown".
|
|
12027
|
+
*
|
|
12028
|
+
* @internal
|
|
12029
|
+
*/
|
|
12030
|
+
surfaceName?: string;
|
|
12031
|
+
/**
|
|
12032
|
+
* Optional version of the implementing service of requests. Paired with
|
|
12033
|
+
* `surfaceName` for internal telemetry.
|
|
12034
|
+
*
|
|
12035
|
+
* @internal
|
|
12036
|
+
*/
|
|
12037
|
+
surfaceVersion?: string;
|
|
11596
12038
|
/** Log level for debugging */
|
|
11597
12039
|
logLevel?: LogLevel;
|
|
11598
12040
|
}
|
|
@@ -13205,7 +13647,8 @@ declare enum UiPathMetaTags {
|
|
|
13205
13647
|
BASE_URL = "uipath:base-url",
|
|
13206
13648
|
REDIRECT_URI = "uipath:redirect-uri",
|
|
13207
13649
|
CDN_BASE = "uipath:cdn-base",
|
|
13208
|
-
APP_BASE = "uipath:app-base"
|
|
13650
|
+
APP_BASE = "uipath:app-base",
|
|
13651
|
+
FOLDER_KEY = "uipath:folder-key"
|
|
13209
13652
|
}
|
|
13210
13653
|
|
|
13211
13654
|
/**
|
|
@@ -13291,7 +13734,7 @@ declare const telemetryClient: TelemetryClient;
|
|
|
13291
13734
|
* SDK Telemetry constants
|
|
13292
13735
|
*/
|
|
13293
13736
|
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.
|
|
13737
|
+
declare const SDK_VERSION = "1.3.7";
|
|
13295
13738
|
declare const VERSION = "Version";
|
|
13296
13739
|
declare const SERVICE = "Service";
|
|
13297
13740
|
declare const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
|
|
@@ -13306,5 +13749,5 @@ declare const SDK_LOGGER_NAME = "uipath-ts-sdk-telemetry";
|
|
|
13306
13749
|
declare const SDK_RUN_EVENT = "Sdk.Run";
|
|
13307
13750
|
declare const UNKNOWN = "";
|
|
13308
13751
|
|
|
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,
|
|
13752
|
+
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, 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 };
|
|
13753
|
+
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, 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, FeedbackCreateResponse, FeedbackGetAllOptions, FeedbackGetResponse, FeedbackOptions, FeedbackServiceModel, 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, 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 };
|