@uipath/uipath-typescript 1.1.3 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/assets/index.cjs +1 -4
- package/dist/assets/index.mjs +1 -4
- package/dist/buckets/index.cjs +1 -4
- package/dist/buckets/index.mjs +1 -4
- package/dist/cases/index.cjs +1 -4
- package/dist/cases/index.mjs +1 -4
- package/dist/conversational-agent/index.cjs +38 -10
- package/dist/conversational-agent/index.d.ts +62 -1
- package/dist/conversational-agent/index.mjs +38 -10
- package/dist/core/index.cjs +278 -84
- package/dist/core/index.d.ts +26 -2
- package/dist/core/index.mjs +278 -84
- package/dist/entities/index.cjs +129 -44
- package/dist/entities/index.d.ts +214 -70
- package/dist/entities/index.mjs +129 -44
- package/dist/index.cjs +406 -127
- package/dist/index.d.ts +270 -71
- package/dist/index.mjs +406 -127
- package/dist/index.umd.js +406 -127
- package/dist/maestro-processes/index.cjs +1 -4
- package/dist/maestro-processes/index.mjs +1 -4
- package/dist/processes/index.cjs +1 -4
- package/dist/processes/index.mjs +1 -4
- package/dist/queues/index.cjs +1 -4
- package/dist/queues/index.mjs +1 -4
- package/dist/tasks/index.cjs +1 -4
- package/dist/tasks/index.mjs +1 -4
- package/package.json +5 -4
package/dist/index.d.ts
CHANGED
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Authentication token information
|
|
3
|
+
*/
|
|
4
|
+
interface TokenInfo {
|
|
5
|
+
token: string;
|
|
6
|
+
type: 'secret' | 'oauth';
|
|
7
|
+
expiresAt?: Date;
|
|
8
|
+
refreshToken?: string;
|
|
9
|
+
}
|
|
10
|
+
|
|
1
11
|
interface BaseConfig {
|
|
2
12
|
baseUrl: string;
|
|
3
13
|
orgName: string;
|
|
@@ -64,6 +74,13 @@ interface IUiPath {
|
|
|
64
74
|
* After calling this method, the user will need to re-initialize to authenticate again.
|
|
65
75
|
*/
|
|
66
76
|
logout(): void;
|
|
77
|
+
/**
|
|
78
|
+
* Updates the access token used for API requests.
|
|
79
|
+
* Use this to inject or refresh a token externally.
|
|
80
|
+
*
|
|
81
|
+
* @param tokenInfo - The token information containing the access token, type, expiration, and optional refresh token
|
|
82
|
+
*/
|
|
83
|
+
updateToken(tokenInfo: TokenInfo): void;
|
|
67
84
|
}
|
|
68
85
|
|
|
69
86
|
/**
|
|
@@ -134,6 +151,13 @@ declare class UiPath$1 implements IUiPath {
|
|
|
134
151
|
* After calling this method, the user will need to re-initialize to authenticate again.
|
|
135
152
|
*/
|
|
136
153
|
logout(): void;
|
|
154
|
+
/**
|
|
155
|
+
* Updates the access token used for API requests.
|
|
156
|
+
* Use this to inject or refresh a token externally.
|
|
157
|
+
*
|
|
158
|
+
* @param tokenInfo - The token information containing the access token, type, expiration, and optional refresh token
|
|
159
|
+
*/
|
|
160
|
+
updateToken(tokenInfo: TokenInfo): void;
|
|
137
161
|
}
|
|
138
162
|
|
|
139
163
|
/**
|
|
@@ -504,9 +528,13 @@ type EntityBatchInsertOptions = EntityOperationOptions;
|
|
|
504
528
|
* Options for inserting multiple records into an entity
|
|
505
529
|
*/
|
|
506
530
|
type EntityInsertRecordsOptions = EntityOperationOptions;
|
|
531
|
+
/**
|
|
532
|
+
* Options for updating a single record in an entity
|
|
533
|
+
*/
|
|
534
|
+
type EntityUpdateRecordOptions = EntityGetRecordByIdOptions;
|
|
507
535
|
/**
|
|
508
536
|
* Options for updating data in an entity
|
|
509
|
-
* @deprecated Use {@link
|
|
537
|
+
* @deprecated Use {@link EntityUpdateRecordsOptions} instead for better clarity on updating records in an entity. This type will be removed in future versions.
|
|
510
538
|
*/
|
|
511
539
|
type EntityUpdateOptions = EntityOperationOptions;
|
|
512
540
|
/**
|
|
@@ -526,34 +554,13 @@ interface EntityDeleteOptions {
|
|
|
526
554
|
*/
|
|
527
555
|
type EntityDeleteRecordsOptions = EntityDeleteOptions;
|
|
528
556
|
/**
|
|
529
|
-
*
|
|
557
|
+
* Supported file types for attachment upload
|
|
530
558
|
*/
|
|
531
|
-
|
|
532
|
-
/** Entity name */
|
|
533
|
-
entityName: string;
|
|
534
|
-
/** Record ID */
|
|
535
|
-
recordId: string;
|
|
536
|
-
/** Field name containing the attachment */
|
|
537
|
-
fieldName: string;
|
|
538
|
-
}
|
|
559
|
+
type EntityFileType = Blob | File | Uint8Array;
|
|
539
560
|
/**
|
|
540
|
-
*
|
|
561
|
+
* Optional options for uploading an attachment to an entity record
|
|
541
562
|
*/
|
|
542
563
|
interface EntityUploadAttachmentOptions {
|
|
543
|
-
/** Entity name */
|
|
544
|
-
entityName: string;
|
|
545
|
-
/** Record ID (UUID) */
|
|
546
|
-
recordId: string;
|
|
547
|
-
/** Field name of the File-type field */
|
|
548
|
-
fieldName: string;
|
|
549
|
-
/**
|
|
550
|
-
* File to upload. Accepts the native types supported by FormData:
|
|
551
|
-
* - `Blob` / `File`: standard browser and Node.js ≥ 18 types accepted directly by FormData.
|
|
552
|
-
* `File` is a subclass of `Blob` and is typically obtained from a browser file input.
|
|
553
|
-
* - `Uint8Array`: raw binary buffer (e.g. from `fs.readFileSync` or a Node.js Buffer).
|
|
554
|
-
* Converted to a `Blob` internally before appending to FormData.
|
|
555
|
-
*/
|
|
556
|
-
file: Blob | File | Uint8Array;
|
|
557
564
|
/** Optional expansion level (default: 0) */
|
|
558
565
|
expansionLevel?: number;
|
|
559
566
|
}
|
|
@@ -561,6 +568,10 @@ interface EntityUploadAttachmentOptions {
|
|
|
561
568
|
* Response from uploading an attachment to an entity record
|
|
562
569
|
*/
|
|
563
570
|
type EntityUploadAttachmentResponse = Record<string, unknown>;
|
|
571
|
+
/**
|
|
572
|
+
* Response from deleting an attachment from an entity record
|
|
573
|
+
*/
|
|
574
|
+
type EntityDeleteAttachmentResponse = Record<string, unknown>;
|
|
564
575
|
/**
|
|
565
576
|
* Represents a failure record in an entity operation
|
|
566
577
|
*/
|
|
@@ -584,6 +595,11 @@ interface EntityOperationResponse {
|
|
|
584
595
|
* Returns the inserted record with its generated record ID and other fields
|
|
585
596
|
*/
|
|
586
597
|
type EntityInsertResponse = EntityRecord;
|
|
598
|
+
/**
|
|
599
|
+
* Response from updating a single record in an entity
|
|
600
|
+
* Returns the updated record
|
|
601
|
+
*/
|
|
602
|
+
type EntityUpdateRecordResponse = EntityRecord;
|
|
587
603
|
/**
|
|
588
604
|
* Response from batch inserting data into an entity
|
|
589
605
|
*/
|
|
@@ -980,9 +996,35 @@ interface EntityServiceModel {
|
|
|
980
996
|
* @hidden
|
|
981
997
|
*/
|
|
982
998
|
batchInsertById(id: string, data: Record<string, any>[], options?: EntityBatchInsertOptions): Promise<EntityBatchInsertResponse>;
|
|
999
|
+
/**
|
|
1000
|
+
* Updates a single record in an entity by entity ID
|
|
1001
|
+
*
|
|
1002
|
+
* Note: Data Fabric supports trigger events only on individual updates, not on updating multiple records.
|
|
1003
|
+
* Use this method if you need trigger events to fire for the updated record.
|
|
1004
|
+
*
|
|
1005
|
+
* @param entityId - UUID of the entity
|
|
1006
|
+
* @param recordId - UUID of the record to update
|
|
1007
|
+
* @param data - Key-value pairs of fields to update
|
|
1008
|
+
* @param options - Update options
|
|
1009
|
+
* @returns Promise resolving to the updated record
|
|
1010
|
+
* {@link EntityUpdateRecordResponse}
|
|
1011
|
+
* @example
|
|
1012
|
+
* ```typescript
|
|
1013
|
+
* // Basic usage
|
|
1014
|
+
* const result = await entities.updateRecordById(<entityId>, <recordId>, { name: "John Updated", age: 31 });
|
|
1015
|
+
*
|
|
1016
|
+
* // With options
|
|
1017
|
+
* const result = await entities.updateRecordById(<entityId>, <recordId>, { name: "John Updated", age: 31 }, {
|
|
1018
|
+
* expansionLevel: 1
|
|
1019
|
+
* });
|
|
1020
|
+
* ```
|
|
1021
|
+
*/
|
|
1022
|
+
updateRecordById(entityId: string, recordId: string, data: Record<string, any>, options?: EntityUpdateRecordOptions): Promise<EntityUpdateRecordResponse>;
|
|
983
1023
|
/**
|
|
984
1024
|
* Updates data in an entity by entity ID
|
|
985
1025
|
*
|
|
1026
|
+
* Note: Records updated using updateRecordsById will not trigger Data Fabric trigger events. Use {@link updateRecordById} if you need trigger events to fire for each updated record.
|
|
1027
|
+
*
|
|
986
1028
|
* @param id - UUID of the entity
|
|
987
1029
|
* @param data - Array of records to update. Each record MUST contain the record Id.
|
|
988
1030
|
* @param options - Update options
|
|
@@ -1037,7 +1079,9 @@ interface EntityServiceModel {
|
|
|
1037
1079
|
/**
|
|
1038
1080
|
* Downloads an attachment stored in a File-type field of an entity record.
|
|
1039
1081
|
*
|
|
1040
|
-
* @param
|
|
1082
|
+
* @param entityId - UUID of the entity
|
|
1083
|
+
* @param recordId - UUID of the record containing the attachment
|
|
1084
|
+
* @param fieldName - Name of the File-type field containing the attachment
|
|
1041
1085
|
* @returns Promise resolving to Blob containing the file content
|
|
1042
1086
|
* @example
|
|
1043
1087
|
* ```typescript
|
|
@@ -1050,15 +1094,19 @@ interface EntityServiceModel {
|
|
|
1050
1094
|
* // Get the recordId for the record that contains the attachment
|
|
1051
1095
|
* const recordId = records.items[0].id;
|
|
1052
1096
|
*
|
|
1097
|
+
* // Get the entityId from getAll()
|
|
1098
|
+
* const allEntities = await entities.getAll();
|
|
1099
|
+
* const entityId = allEntities[0].id;
|
|
1100
|
+
*
|
|
1101
|
+
* // Get the recordId from getAllRecords()
|
|
1102
|
+
* const records = await entities.getAllRecords(entityId);
|
|
1103
|
+
* const recordId = records[0].id;
|
|
1104
|
+
*
|
|
1053
1105
|
* // Download attachment using service method
|
|
1054
|
-
* const response = await entities.downloadAttachment(
|
|
1055
|
-
* entityName: 'Invoice',
|
|
1056
|
-
* recordId: recordId,
|
|
1057
|
-
* fieldName: 'Documents'
|
|
1058
|
-
* });
|
|
1106
|
+
* const response = await entities.downloadAttachment(entityId, recordId, 'Documents');
|
|
1059
1107
|
*
|
|
1060
|
-
* // Or download using entity method
|
|
1061
|
-
* const entity = await entities.getById(
|
|
1108
|
+
* // Or download using entity method (entityId is already known)
|
|
1109
|
+
* const entity = await entities.getById(entityId);
|
|
1062
1110
|
* const blob = await entity.downloadAttachment(recordId, 'Documents');
|
|
1063
1111
|
*
|
|
1064
1112
|
* // Browser: Display Image
|
|
@@ -1080,43 +1128,74 @@ interface EntityServiceModel {
|
|
|
1080
1128
|
* fs.writeFileSync('attachment.pdf', buffer);
|
|
1081
1129
|
* ```
|
|
1082
1130
|
*/
|
|
1083
|
-
downloadAttachment(
|
|
1131
|
+
downloadAttachment(entityId: string, recordId: string, fieldName: string): Promise<Blob>;
|
|
1084
1132
|
/**
|
|
1085
1133
|
* Uploads an attachment to a File-type field of an entity record.
|
|
1086
1134
|
*
|
|
1087
1135
|
* Uses multipart/form-data to upload the file content to the specified field.
|
|
1088
1136
|
*
|
|
1089
|
-
* @param
|
|
1090
|
-
* @
|
|
1091
|
-
*
|
|
1137
|
+
* @param entityId - UUID of the entity
|
|
1138
|
+
* @param recordId - UUID of the record to upload the attachment to
|
|
1139
|
+
* @param fieldName - Name of the File-type field
|
|
1140
|
+
* @param file - File to upload (Blob, File, or Uint8Array)
|
|
1141
|
+
* @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel)
|
|
1142
|
+
* @returns Promise resolving to {@link EntityUploadAttachmentResponse}
|
|
1092
1143
|
* @example
|
|
1093
1144
|
* ```typescript
|
|
1094
1145
|
* import { Entities } from '@uipath/uipath-typescript/entities';
|
|
1095
1146
|
*
|
|
1096
1147
|
* const entities = new Entities(sdk);
|
|
1097
1148
|
*
|
|
1149
|
+
* // Get the entityId from getAll()
|
|
1150
|
+
* const allEntities = await entities.getAll();
|
|
1151
|
+
* const entityId = allEntities[0].id;
|
|
1152
|
+
*
|
|
1153
|
+
* // Get the recordId from getAllRecords()
|
|
1154
|
+
* const records = await entities.getAllRecords(entityId);
|
|
1155
|
+
* const recordId = records[0].id;
|
|
1156
|
+
*
|
|
1098
1157
|
* // Browser: Upload a file from an input element
|
|
1099
1158
|
* const fileInput = document.getElementById('file-input') as HTMLInputElement;
|
|
1100
1159
|
* const file = fileInput.files[0];
|
|
1101
|
-
* const response = await entities.uploadAttachment(
|
|
1102
|
-
* entityName: 'Invoice',
|
|
1103
|
-
* recordId: '<recordId>',
|
|
1104
|
-
* fieldName: 'Documents',
|
|
1105
|
-
* file: file
|
|
1106
|
-
* });
|
|
1160
|
+
* const response = await entities.uploadAttachment(entityId, recordId, 'Documents', file);
|
|
1107
1161
|
*
|
|
1108
1162
|
* // Node.js: Upload a file from disk
|
|
1109
1163
|
* const fileBuffer = fs.readFileSync('document.pdf');
|
|
1110
1164
|
* const blob = new Blob([fileBuffer], { type: 'application/pdf' });
|
|
1111
|
-
* const response = await entities.uploadAttachment(
|
|
1112
|
-
* entityName: 'Invoice',
|
|
1113
|
-
* recordId: '<recordId>',
|
|
1114
|
-
* fieldName: 'Documents',
|
|
1115
|
-
* file: blob
|
|
1116
|
-
* });
|
|
1165
|
+
* const response = await entities.uploadAttachment(entityId, recordId, 'Documents', blob);
|
|
1117
1166
|
* ```
|
|
1118
1167
|
*/
|
|
1119
|
-
uploadAttachment(
|
|
1168
|
+
uploadAttachment(entityId: string, recordId: string, fieldName: string, file: EntityFileType, options?: EntityUploadAttachmentOptions): Promise<EntityUploadAttachmentResponse>;
|
|
1169
|
+
/**
|
|
1170
|
+
* Removes an attachment from a File-type field of an entity record.
|
|
1171
|
+
*
|
|
1172
|
+
* @param entityId - UUID of the entity
|
|
1173
|
+
* @param recordId - UUID of the record containing the attachment
|
|
1174
|
+
* @param fieldName - Name of the File-type field containing the attachment
|
|
1175
|
+
* @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
|
|
1176
|
+
* @example
|
|
1177
|
+
* ```typescript
|
|
1178
|
+
* import { Entities } from '@uipath/uipath-typescript/entities';
|
|
1179
|
+
*
|
|
1180
|
+
* const entities = new Entities(sdk);
|
|
1181
|
+
*
|
|
1182
|
+
* // Get the entityId from getAll()
|
|
1183
|
+
* const allEntities = await entities.getAll();
|
|
1184
|
+
* const entityId = allEntities[0].id;
|
|
1185
|
+
*
|
|
1186
|
+
* // Get the recordId from getAllRecords()
|
|
1187
|
+
* const records = await entities.getAllRecords(entityId);
|
|
1188
|
+
* const recordId = records[0].id;
|
|
1189
|
+
*
|
|
1190
|
+
* // Delete attachment for a specific record and field
|
|
1191
|
+
* await entities.deleteAttachment(entityId, recordId, 'Documents');
|
|
1192
|
+
*
|
|
1193
|
+
* // Or delete using entity method (entityId is already known)
|
|
1194
|
+
* const entity = await entities.getById(entityId);
|
|
1195
|
+
* await entity.deleteAttachment(recordId, 'Documents');
|
|
1196
|
+
* ```
|
|
1197
|
+
*/
|
|
1198
|
+
deleteAttachment(entityId: string, recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
|
|
1120
1199
|
}
|
|
1121
1200
|
/**
|
|
1122
1201
|
* Entity methods interface - defines operations that can be performed on an entity
|
|
@@ -1144,9 +1223,24 @@ interface EntityMethods {
|
|
|
1144
1223
|
* @returns Promise resolving to batch insert response
|
|
1145
1224
|
*/
|
|
1146
1225
|
insertRecords(data: Record<string, any>[], options?: EntityInsertRecordsOptions): Promise<EntityBatchInsertResponse>;
|
|
1226
|
+
/**
|
|
1227
|
+
* Update a single record in this entity
|
|
1228
|
+
*
|
|
1229
|
+
* Note: Data Fabric supports trigger events only on individual updates, not on updating multiple records.
|
|
1230
|
+
* Use this method if you need trigger events to fire for the updated record.
|
|
1231
|
+
*
|
|
1232
|
+
* @param recordId - UUID of the record to update
|
|
1233
|
+
* @param data - Key-value pairs of fields to update
|
|
1234
|
+
* @param options - Update options
|
|
1235
|
+
* @returns Promise resolving to the updated record
|
|
1236
|
+
*/
|
|
1237
|
+
updateRecord(recordId: string, data: Record<string, any>, options?: EntityUpdateRecordOptions): Promise<EntityUpdateRecordResponse>;
|
|
1147
1238
|
/**
|
|
1148
1239
|
* Update data in this entity
|
|
1149
1240
|
*
|
|
1241
|
+
* Note: Records updated using updateRecords will not trigger Data Fabric trigger events. Use {@link updateRecord} if you need
|
|
1242
|
+
* trigger events to fire for each updated record.
|
|
1243
|
+
*
|
|
1150
1244
|
* @param data - Array of records to update. Each record MUST contain the record Id,
|
|
1151
1245
|
* otherwise the update will fail.
|
|
1152
1246
|
* @param options - Update options
|
|
@@ -1190,10 +1284,18 @@ interface EntityMethods {
|
|
|
1190
1284
|
* @param recordId - UUID of the record to upload the attachment to
|
|
1191
1285
|
* @param fieldName - Name of the File-type field
|
|
1192
1286
|
* @param file - File to upload (Blob, File, or Uint8Array)
|
|
1193
|
-
* @param
|
|
1194
|
-
* @returns Promise resolving to
|
|
1287
|
+
* @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel)
|
|
1288
|
+
* @returns Promise resolving to {@link EntityUploadAttachmentResponse}
|
|
1195
1289
|
*/
|
|
1196
|
-
uploadAttachment(recordId: string, fieldName: string, file:
|
|
1290
|
+
uploadAttachment(recordId: string, fieldName: string, file: EntityFileType, options?: EntityUploadAttachmentOptions): Promise<EntityUploadAttachmentResponse>;
|
|
1291
|
+
/**
|
|
1292
|
+
* Deletes an attachment from a File-type field of an entity record
|
|
1293
|
+
*
|
|
1294
|
+
* @param recordId - UUID of the record containing the attachment
|
|
1295
|
+
* @param fieldName - Name of the File-type field containing the attachment
|
|
1296
|
+
* @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
|
|
1297
|
+
*/
|
|
1298
|
+
deleteAttachment(recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
|
|
1197
1299
|
/**
|
|
1198
1300
|
* @deprecated Use {@link insertRecord} instead.
|
|
1199
1301
|
* @hidden
|
|
@@ -1374,6 +1476,31 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
1374
1476
|
* ```
|
|
1375
1477
|
*/
|
|
1376
1478
|
insertRecordsById(id: string, data: Record<string, any>[], options?: EntityInsertRecordsOptions): Promise<EntityBatchInsertResponse>;
|
|
1479
|
+
/**
|
|
1480
|
+
* Updates a single record in an entity by entity ID
|
|
1481
|
+
*
|
|
1482
|
+
* @param entityId - UUID of the entity
|
|
1483
|
+
* @param recordId - UUID of the record to update
|
|
1484
|
+
* @param data - Key-value pairs of fields to update
|
|
1485
|
+
* @param options - Update options
|
|
1486
|
+
* @returns Promise resolving to the updated record
|
|
1487
|
+
*
|
|
1488
|
+
* @example
|
|
1489
|
+
* ```typescript
|
|
1490
|
+
* import { Entities } from '@uipath/uipath-typescript/entities';
|
|
1491
|
+
*
|
|
1492
|
+
* const entities = new Entities(sdk);
|
|
1493
|
+
*
|
|
1494
|
+
* // Basic usage
|
|
1495
|
+
* const result = await entities.updateRecordById("<entityId>", "<recordId>", { name: "John Updated", age: 31 });
|
|
1496
|
+
*
|
|
1497
|
+
* // With options
|
|
1498
|
+
* const result = await entities.updateRecordById("<entityId>", "<recordId>", { name: "John Updated", age: 31 }, {
|
|
1499
|
+
* expansionLevel: 1
|
|
1500
|
+
* });
|
|
1501
|
+
* ```
|
|
1502
|
+
*/
|
|
1503
|
+
updateRecordById(entityId: string, recordId: string, data: Record<string, any>, options?: EntityUpdateRecordOptions): Promise<EntityUpdateRecordResponse>;
|
|
1377
1504
|
/**
|
|
1378
1505
|
* Updates data in an entity by entity ID
|
|
1379
1506
|
*
|
|
@@ -1449,7 +1576,9 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
1449
1576
|
/**
|
|
1450
1577
|
* Downloads an attachment from an entity record field
|
|
1451
1578
|
*
|
|
1452
|
-
* @param
|
|
1579
|
+
* @param entityId - UUID of the entity
|
|
1580
|
+
* @param recordId - UUID of the record containing the attachment
|
|
1581
|
+
* @param fieldName - Name of the File-type field containing the attachment
|
|
1453
1582
|
* @returns Promise resolving to Blob containing the file content
|
|
1454
1583
|
*
|
|
1455
1584
|
* @example
|
|
@@ -1458,19 +1587,28 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
1458
1587
|
*
|
|
1459
1588
|
* const entities = new Entities(sdk);
|
|
1460
1589
|
*
|
|
1590
|
+
* // Get the entityId from getAll()
|
|
1591
|
+
* const allEntities = await entities.getAll();
|
|
1592
|
+
* const entityId = allEntities[0].id;
|
|
1593
|
+
*
|
|
1594
|
+
* // Get the recordId from getAllRecords()
|
|
1595
|
+
* const records = await entities.getAllRecords(entityId);
|
|
1596
|
+
* const recordId = records[0].id;
|
|
1597
|
+
*
|
|
1461
1598
|
* // Download attachment for a specific record and field
|
|
1462
|
-
* const blob = await entities.downloadAttachment(
|
|
1463
|
-
*
|
|
1464
|
-
* recordId: '<record-uuid>',
|
|
1465
|
-
* fieldName: 'Documents'
|
|
1466
|
-
* });
|
|
1599
|
+
* const blob = await entities.downloadAttachment(entityId, recordId, 'Documents');
|
|
1600
|
+
* ```
|
|
1467
1601
|
*/
|
|
1468
|
-
downloadAttachment(
|
|
1602
|
+
downloadAttachment(entityId: string, recordId: string, fieldName: string): Promise<Blob>;
|
|
1469
1603
|
/**
|
|
1470
1604
|
* Uploads an attachment to a File-type field of an entity record
|
|
1471
1605
|
*
|
|
1472
|
-
* @param
|
|
1473
|
-
* @
|
|
1606
|
+
* @param entityId - UUID of the entity
|
|
1607
|
+
* @param recordId - UUID of the record to upload the attachment to
|
|
1608
|
+
* @param fieldName - Name of the File-type field
|
|
1609
|
+
* @param file - File to upload (Blob, File, or Uint8Array)
|
|
1610
|
+
* @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel)
|
|
1611
|
+
* @returns Promise resolving to {@link EntityUploadAttachmentResponse}
|
|
1474
1612
|
*
|
|
1475
1613
|
* @example
|
|
1476
1614
|
* ```typescript
|
|
@@ -1478,16 +1616,46 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
1478
1616
|
*
|
|
1479
1617
|
* const entities = new Entities(sdk);
|
|
1480
1618
|
*
|
|
1619
|
+
* // Get the entityId from getAll()
|
|
1620
|
+
* const allEntities = await entities.getAll();
|
|
1621
|
+
* const entityId = allEntities[0].id;
|
|
1622
|
+
*
|
|
1623
|
+
* // Get the recordId from getAllRecords()
|
|
1624
|
+
* const records = await entities.getAllRecords(entityId);
|
|
1625
|
+
* const recordId = records[0].id;
|
|
1626
|
+
*
|
|
1481
1627
|
* // Upload a file attachment
|
|
1482
|
-
* const response = await entities.uploadAttachment(
|
|
1483
|
-
* entityName: 'Invoice',
|
|
1484
|
-
* recordId: '<record-uuid>',
|
|
1485
|
-
* fieldName: 'Documents',
|
|
1486
|
-
* file: file
|
|
1487
|
-
* });
|
|
1628
|
+
* const response = await entities.uploadAttachment(entityId, recordId, 'Documents', file);
|
|
1488
1629
|
* ```
|
|
1489
1630
|
*/
|
|
1490
|
-
uploadAttachment(
|
|
1631
|
+
uploadAttachment(entityId: string, recordId: string, fieldName: string, file: EntityFileType, options?: EntityUploadAttachmentOptions): Promise<EntityUploadAttachmentResponse>;
|
|
1632
|
+
/**
|
|
1633
|
+
* Removes an attachment from a File-type field of an entity record
|
|
1634
|
+
*
|
|
1635
|
+
* @param entityId - UUID of the entity
|
|
1636
|
+
* @param recordId - UUID of the record containing the attachment
|
|
1637
|
+
* @param fieldName - Name of the File-type field containing the attachment
|
|
1638
|
+
* @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
|
|
1639
|
+
*
|
|
1640
|
+
* @example
|
|
1641
|
+
* ```typescript
|
|
1642
|
+
* import { Entities } from '@uipath/uipath-typescript/entities';
|
|
1643
|
+
*
|
|
1644
|
+
* const entities = new Entities(sdk);
|
|
1645
|
+
*
|
|
1646
|
+
* // Get the entityId from getAll()
|
|
1647
|
+
* const allEntities = await entities.getAll();
|
|
1648
|
+
* const entityId = allEntities[0].id;
|
|
1649
|
+
*
|
|
1650
|
+
* // Get the recordId from getAllRecords()
|
|
1651
|
+
* const records = await entities.getAllRecords(entityId);
|
|
1652
|
+
* const recordId = records[0].id;
|
|
1653
|
+
*
|
|
1654
|
+
* // Delete attachment for a specific record and field
|
|
1655
|
+
* await entities.deleteAttachment(entityId, recordId, 'Documents');
|
|
1656
|
+
* ```
|
|
1657
|
+
*/
|
|
1658
|
+
deleteAttachment(entityId: string, recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
|
|
1491
1659
|
/**
|
|
1492
1660
|
* @hidden
|
|
1493
1661
|
* @deprecated Use {@link getAllRecords} instead.
|
|
@@ -9249,6 +9417,37 @@ interface ConversationServiceModel {
|
|
|
9249
9417
|
* ```
|
|
9250
9418
|
*/
|
|
9251
9419
|
uploadAttachment(id: string, file: File): Promise<ConversationAttachmentUploadResponse>;
|
|
9420
|
+
/**
|
|
9421
|
+
* Registers a file attachment for a conversation and returns a URI along with
|
|
9422
|
+
* pre-signed upload access details. Use the returned `fileUploadAccess` to upload
|
|
9423
|
+
* the file content to blob storage, then reference `uri` in subsequent messages.
|
|
9424
|
+
*
|
|
9425
|
+
* @param conversationId - The ID of the conversation to attach the file to
|
|
9426
|
+
* @param fileName - The name of the file to attach
|
|
9427
|
+
* @returns Promise resolving to {@link ConversationAttachmentCreateResponse} containing
|
|
9428
|
+
* the attachment `uri` and `fileUploadAccess` details needed to upload the file content
|
|
9429
|
+
*
|
|
9430
|
+
* @example <caption>Step 1 — Get the attachment URI and upload access</caption>
|
|
9431
|
+
* ```typescript
|
|
9432
|
+
* const { uri, fileUploadAccess } = await conversationalAgent.conversations.getAttachmentUploadUri(conversationId, 'report.pdf');
|
|
9433
|
+
* console.log(`Attachment URI: ${uri}`);
|
|
9434
|
+
* ```
|
|
9435
|
+
*
|
|
9436
|
+
* @example <caption>Step 2 — Upload the file content to the returned URL</caption>
|
|
9437
|
+
* ```typescript
|
|
9438
|
+
* const { uri, fileUploadAccess } = await conversationalAgent.conversations.getAttachmentUploadUri(conversationId, file.name);
|
|
9439
|
+
*
|
|
9440
|
+
* await fetch(fileUploadAccess.url, {
|
|
9441
|
+
* method: fileUploadAccess.verb,
|
|
9442
|
+
* body: file,
|
|
9443
|
+
* headers: { 'Content-Type': file.type },
|
|
9444
|
+
* });
|
|
9445
|
+
*
|
|
9446
|
+
* // Reference the URI in a message after upload
|
|
9447
|
+
* console.log(`File ready at: ${uri}`);
|
|
9448
|
+
* ```
|
|
9449
|
+
*/
|
|
9450
|
+
getAttachmentUploadUri(conversationId: string, fileName: string): Promise<ConversationAttachmentCreateResponse>;
|
|
9252
9451
|
/**
|
|
9253
9452
|
* Starts a real-time chat session for a conversation
|
|
9254
9453
|
*
|
|
@@ -10386,7 +10585,7 @@ declare const telemetryClient: TelemetryClient;
|
|
|
10386
10585
|
* SDK Telemetry constants
|
|
10387
10586
|
*/
|
|
10388
10587
|
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";
|
|
10389
|
-
declare const SDK_VERSION = "1.1
|
|
10588
|
+
declare const SDK_VERSION = "1.2.1";
|
|
10390
10589
|
declare const VERSION = "Version";
|
|
10391
10590
|
declare const SERVICE = "Service";
|
|
10392
10591
|
declare const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
|
|
@@ -10402,4 +10601,4 @@ declare const SDK_RUN_EVENT = "Sdk.Run";
|
|
|
10402
10601
|
declare const UNKNOWN = "";
|
|
10403
10602
|
|
|
10404
10603
|
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, EntityFieldDataType, EntityType, ErrorType, EscalationActionType, EscalationRecipientScope, EscalationTriggerType, ExchangeMap, FeedbackRating, FieldDisplayType, HttpStatus, InputStreamSpeechSensitivity, InterruptType, JobPriority, JobState, JobType, JoinType, MAX_PAGE_SIZE, MessageMap, MessageRole, NetworkError, NotFoundError, PackageSourceType, PackageType, ProcessIncidentSeverity, ProcessIncidentStatus, ProcessIncidentType, RateLimitError, ReferenceType, RemoteControlAccess, RobotSize, SDK_LOGGER_NAME, SDK_RUN_EVENT, SDK_SERVICE_NAME, SDK_VERSION, SERVICE, SLADurationUnit, ServerError, SortOrder, StageTaskType, StartStrategy, StopStrategy, TargetFramework, TaskActivityType, TaskPriority, TaskSlaCriteria, TaskSlaStatus, TaskSourceName, TaskStatus, TaskType, UNKNOWN, UiPath, UiPathError, UiPathMetaTags, UserSettingsMap, VERSION, ValidationError, createAgentWithMethods, createCaseInstanceWithMethods, createConversationWithMethods, createEntityWithMethods, createProcessInstanceWithMethods, createProcessWithMethods, createTaskWithMethods, getAppBase, getAsset, getErrorDetails, getLimitedPageSize, isAuthenticationError, isAuthorizationError, isNetworkError, isNotFoundError, isRateLimitError, isServerError, isUiPathError, isValidationError, loadFromMetaTags, telemetryClient, track, trackEvent };
|
|
10405
|
-
export type { AgentAppearance, AgentConversationServiceModel, AgentCreateConversationOptions, AgentGetByIdResponse, AgentGetResponse, AgentMethods, AgentStartingPrompt, ArgumentMetadata, AssetGetAllOptions, AssetGetByIdOptions, AssetGetResponse, AssetServiceModel, AsyncInputStream, AsyncInputStreamChunkEvent, AsyncInputStreamEndEvent, AsyncInputStreamEvent, AsyncInputStreamStartEvent, AsyncToolCallStream, 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, EntityDeleteOptions, EntityDeleteRecordsOptions, EntityDeleteResponse,
|
|
10604
|
+
export type { AgentAppearance, AgentConversationServiceModel, AgentCreateConversationOptions, AgentGetByIdResponse, AgentGetResponse, AgentMethods, AgentStartingPrompt, ArgumentMetadata, AssetGetAllOptions, AssetGetByIdOptions, AssetGetResponse, AssetServiceModel, AsyncInputStream, AsyncInputStreamChunkEvent, AsyncInputStreamEndEvent, AsyncInputStreamEvent, AsyncInputStreamStartEvent, AsyncToolCallStream, 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, EntityDeleteAttachmentResponse, EntityDeleteOptions, EntityDeleteRecordsOptions, EntityDeleteResponse, EntityFileType, EntityGetAllRecordsOptions, EntityGetRecordByIdOptions, EntityGetRecordsByIdOptions, EntityGetResponse, EntityInsertOptions, EntityInsertRecordOptions, EntityInsertRecordsOptions, EntityInsertResponse, EntityMethods, EntityOperationOptions, EntityOperationResponse, EntityRecord, EntityServiceModel, 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, FeedbackCreateResponse, Field, FieldDataType, FieldMetaData, FileUploadAccess, FolderProperties, GenericInterruptStartEvent, GlobalVariableMetaData, HasPaginationOptions, Headers, HttpMethod, InlineOrExternalValue, InlineValue, Interrupt, InterruptEndEvent, InterruptEvent, InterruptStartEvent, JSONArray, JSONObject, JSONPrimitive, JSONValue, JobAttachment, JobError, 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, ProcessMethods, ProcessProperties, ProcessServiceModel, ProcessStartRequest, ProcessStartRequestWithKey, ProcessStartRequestWithName, ProcessStartResponse, QueryParams, QueueGetAllOptions, QueueGetByIdOptions, QueueGetResponse, QueueServiceModel, RawAgentGetByIdResponse, RawAgentGetResponse, RawCaseInstanceGetResponse, RawConversationGetResponse, RawEntityGetResponse, RawMaestroProcessGetAllResponse, RawProcessInstanceGetResponse, RawTaskCreateResponse, RawTaskGetResponse, RequestOptions, RequestSpec, ResponseDictionary, ResponseType, RetryOptions, RobotMetadata, SessionCapabilities, SessionEndEvent, SessionEndingEvent, SessionStartEvent, SessionStartedEvent, SessionStream, Simplify, SourceJoinCriteria, 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, UserServiceModel, UserSettingsGetResponse, UserSettingsUpdateOptions, UserSettingsUpdateResponse };
|