@uipath/uipath-typescript 1.0.0-beta.16 → 1.0.0-beta.17
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/index.cjs +4052 -87
- package/dist/index.d.cts +306 -22
- package/dist/index.d.mts +306 -22
- package/dist/index.d.ts +306 -22
- package/dist/index.mjs +4052 -87
- package/dist/index.umd.js +3788 -3602
- package/package.json +5 -3
package/dist/index.d.mts
CHANGED
|
@@ -8,23 +8,7 @@ declare const ConfigSchema: z.ZodObject<{
|
|
|
8
8
|
clientId: z.ZodOptional<z.ZodString>;
|
|
9
9
|
redirectUri: z.ZodOptional<z.ZodString>;
|
|
10
10
|
scope: z.ZodOptional<z.ZodString>;
|
|
11
|
-
},
|
|
12
|
-
baseUrl: string;
|
|
13
|
-
orgName: string;
|
|
14
|
-
tenantName: string;
|
|
15
|
-
secret?: string | undefined;
|
|
16
|
-
clientId?: string | undefined;
|
|
17
|
-
redirectUri?: string | undefined;
|
|
18
|
-
scope?: string | undefined;
|
|
19
|
-
}, {
|
|
20
|
-
orgName: string;
|
|
21
|
-
tenantName: string;
|
|
22
|
-
baseUrl?: string | undefined;
|
|
23
|
-
secret?: string | undefined;
|
|
24
|
-
clientId?: string | undefined;
|
|
25
|
-
redirectUri?: string | undefined;
|
|
26
|
-
scope?: string | undefined;
|
|
27
|
-
}>;
|
|
11
|
+
}, z.core.$strip>;
|
|
28
12
|
type Config = z.infer<typeof ConfigSchema>;
|
|
29
13
|
|
|
30
14
|
/**
|
|
@@ -109,6 +93,9 @@ interface PaginationServiceAccess {
|
|
|
109
93
|
get<T>(path: string, options?: any): Promise<{
|
|
110
94
|
data: T;
|
|
111
95
|
}>;
|
|
96
|
+
post<T>(path: string, body?: any, options?: any): Promise<{
|
|
97
|
+
data: T;
|
|
98
|
+
}>;
|
|
112
99
|
requestWithPagination<T>(method: string, path: string, paginationOptions: PaginationOptions, options: RequestWithPaginationOptions): Promise<PaginatedResponse<T>>;
|
|
113
100
|
}
|
|
114
101
|
/**
|
|
@@ -484,6 +471,17 @@ interface EntityDeleteOptions {
|
|
|
484
471
|
/** Whether to fail on first error (default: false) */
|
|
485
472
|
failOnFirst?: boolean;
|
|
486
473
|
}
|
|
474
|
+
/**
|
|
475
|
+
* Options for downloading an attachment from an entity record
|
|
476
|
+
*/
|
|
477
|
+
interface EntityDownloadAttachmentOptions {
|
|
478
|
+
/** Entity name */
|
|
479
|
+
entityName: string;
|
|
480
|
+
/** Record ID */
|
|
481
|
+
recordId: string;
|
|
482
|
+
/** Field name containing the attachment */
|
|
483
|
+
fieldName: string;
|
|
484
|
+
}
|
|
487
485
|
/**
|
|
488
486
|
* Represents a failure record in an entity operation
|
|
489
487
|
*/
|
|
@@ -738,6 +736,12 @@ interface EntityServiceModel {
|
|
|
738
736
|
* // Call operations directly on the entity
|
|
739
737
|
* const records = await entity.getRecords();
|
|
740
738
|
*
|
|
739
|
+
* // If a field references a ChoiceSet, get the choiceSetId from records.fields
|
|
740
|
+
* const choiceSetId = records.fields[0].referenceChoiceSet?.id;
|
|
741
|
+
* if (choiceSetId) {
|
|
742
|
+
* const choiceSetValues = await sdk.entities.choicesets.getById(choiceSetId);
|
|
743
|
+
* }
|
|
744
|
+
*
|
|
741
745
|
* const insertResult = await entity.insert([
|
|
742
746
|
* { name: "John", age: 30 }
|
|
743
747
|
* ]);
|
|
@@ -846,6 +850,49 @@ interface EntityServiceModel {
|
|
|
846
850
|
* ```
|
|
847
851
|
*/
|
|
848
852
|
deleteById(id: string, recordIds: string[], options?: EntityDeleteOptions): Promise<EntityDeleteResponse>;
|
|
853
|
+
/**
|
|
854
|
+
* Downloads an attachment stored in a File-type field of an entity record.
|
|
855
|
+
*
|
|
856
|
+
* @param options - Options containing entityName, recordId, and fieldName
|
|
857
|
+
* @returns Promise resolving to Blob containing the file content
|
|
858
|
+
* @example
|
|
859
|
+
* ```typescript
|
|
860
|
+
* // First, get records to obtain the record ID
|
|
861
|
+
* const records = await sdk.entities.getRecordsById(<entityId>);
|
|
862
|
+
* // Get the recordId for the record that contains the attachment
|
|
863
|
+
* const recordId = records.items[0].id;
|
|
864
|
+
*
|
|
865
|
+
* // Download attachment using SDK method
|
|
866
|
+
* const response = await sdk.entities.downloadAttachment({
|
|
867
|
+
* entityName: 'Invoice',
|
|
868
|
+
* recordId: recordId,
|
|
869
|
+
* fieldName: 'Documents'
|
|
870
|
+
* });
|
|
871
|
+
*
|
|
872
|
+
* // Or download using entity method
|
|
873
|
+
* const entity = await sdk.entities.getById(<entityId>);
|
|
874
|
+
* const response = await entity.downloadAttachment(recordId, 'Documents');
|
|
875
|
+
*
|
|
876
|
+
* // Browser: Display Image
|
|
877
|
+
* const url = URL.createObjectURL(response);
|
|
878
|
+
* document.getElementById('image').src = url;
|
|
879
|
+
* // Call URL.revokeObjectURL(url) when done
|
|
880
|
+
*
|
|
881
|
+
* // Browser: Display PDF in iframe
|
|
882
|
+
* const url = URL.createObjectURL(response);
|
|
883
|
+
* document.getElementById('pdf-viewer').src = url;
|
|
884
|
+
* // Call URL.revokeObjectURL(url) when done
|
|
885
|
+
*
|
|
886
|
+
* // Browser: Render PDF with PDF.js
|
|
887
|
+
* const arrayBuffer = await response.arrayBuffer();
|
|
888
|
+
* const pdf = await pdfjsLib.getDocument({ data: arrayBuffer }).promise;
|
|
889
|
+
*
|
|
890
|
+
* // Node.js: Save to file
|
|
891
|
+
* const buffer = Buffer.from(await response.arrayBuffer());
|
|
892
|
+
* fs.writeFileSync('attachment.pdf', buffer);
|
|
893
|
+
* ```
|
|
894
|
+
*/
|
|
895
|
+
downloadAttachment(options: EntityDownloadAttachmentOptions): Promise<Blob>;
|
|
849
896
|
}
|
|
850
897
|
/**
|
|
851
898
|
* Entity methods interface - defines operations that can be performed on an entity
|
|
@@ -883,6 +930,14 @@ interface EntityMethods {
|
|
|
883
930
|
* @returns Promise resolving to query response
|
|
884
931
|
*/
|
|
885
932
|
getRecords<T extends EntityGetRecordsByIdOptions = EntityGetRecordsByIdOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<EntityRecord> : NonPaginatedResponse<EntityRecord>>;
|
|
933
|
+
/**
|
|
934
|
+
* Downloads an attachment stored in a File-type field of an entity record
|
|
935
|
+
*
|
|
936
|
+
* @param recordId - UUID of the record containing the attachment
|
|
937
|
+
* @param fieldName - Name of the File-type field containing the attachment
|
|
938
|
+
* @returns Promise resolving to Blob containing the file content
|
|
939
|
+
*/
|
|
940
|
+
downloadAttachment(recordId: string, fieldName: string): Promise<Blob>;
|
|
886
941
|
}
|
|
887
942
|
/**
|
|
888
943
|
* Entity with methods combining metadata with operation methods
|
|
@@ -1043,6 +1098,22 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
1043
1098
|
* ```
|
|
1044
1099
|
*/
|
|
1045
1100
|
getAll(): Promise<EntityGetResponse[]>;
|
|
1101
|
+
/**
|
|
1102
|
+
* Downloads an attachment from an entity record field
|
|
1103
|
+
*
|
|
1104
|
+
* @param options - Options containing entityName, recordId, and fieldName
|
|
1105
|
+
* @returns Promise resolving to Blob containing the file content
|
|
1106
|
+
*
|
|
1107
|
+
* @example
|
|
1108
|
+
* ```typescript
|
|
1109
|
+
* // Download attachment for a specific record and field
|
|
1110
|
+
* const blob = await sdk.entities.downloadAttachment({
|
|
1111
|
+
* entityName: 'Invoice',
|
|
1112
|
+
* recordId: '<record-uuid>',
|
|
1113
|
+
* fieldName: 'Documents'
|
|
1114
|
+
* });
|
|
1115
|
+
*/
|
|
1116
|
+
downloadAttachment(options: EntityDownloadAttachmentOptions): Promise<Blob>;
|
|
1046
1117
|
/**
|
|
1047
1118
|
* Orchestrates all field mapping transformations
|
|
1048
1119
|
*
|
|
@@ -1070,6 +1141,189 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
1070
1141
|
private mapExternalFields;
|
|
1071
1142
|
}
|
|
1072
1143
|
|
|
1144
|
+
/**
|
|
1145
|
+
* ChoiceSet Get All Response
|
|
1146
|
+
* Only exposes essential fields to SDK users
|
|
1147
|
+
*/
|
|
1148
|
+
interface ChoiceSetGetAllResponse {
|
|
1149
|
+
/** Name identifier of the choice set */
|
|
1150
|
+
name: string;
|
|
1151
|
+
/** Human-readable display name of the choice set*/
|
|
1152
|
+
displayName: string;
|
|
1153
|
+
/** Description of the choice set */
|
|
1154
|
+
description: string;
|
|
1155
|
+
/** Folder ID where the choice set is located */
|
|
1156
|
+
folderId: string;
|
|
1157
|
+
/** User ID who created the choice set */
|
|
1158
|
+
createdBy: string;
|
|
1159
|
+
/** User ID who last updated the choice set */
|
|
1160
|
+
updatedBy: string;
|
|
1161
|
+
/** Creation timestamp */
|
|
1162
|
+
createdTime: string;
|
|
1163
|
+
/** Last update timestamp */
|
|
1164
|
+
updatedTime: string;
|
|
1165
|
+
}
|
|
1166
|
+
/**
|
|
1167
|
+
* Represents a single choice set value/record
|
|
1168
|
+
*/
|
|
1169
|
+
interface ChoiceSetGetResponse {
|
|
1170
|
+
/** Unique identifier for the choice set value */
|
|
1171
|
+
id: string;
|
|
1172
|
+
/** Name of the choice set value */
|
|
1173
|
+
name: string;
|
|
1174
|
+
/** Human-readable display name of the choice set value*/
|
|
1175
|
+
displayName: string;
|
|
1176
|
+
/** Numeric identifier */
|
|
1177
|
+
numberId: number;
|
|
1178
|
+
/** Creation timestamp */
|
|
1179
|
+
createdTime: string;
|
|
1180
|
+
/** Last update timestamp */
|
|
1181
|
+
updatedTime: string;
|
|
1182
|
+
/** User ID who created this value */
|
|
1183
|
+
createdBy?: string;
|
|
1184
|
+
/** User ID who last updated this value */
|
|
1185
|
+
updatedBy?: string;
|
|
1186
|
+
/** User ID of the record owner */
|
|
1187
|
+
recordOwner?: string;
|
|
1188
|
+
}
|
|
1189
|
+
/**
|
|
1190
|
+
* Options for getting choice set values by choice set ID
|
|
1191
|
+
*/
|
|
1192
|
+
type ChoiceSetGetByIdOptions = PaginationOptions;
|
|
1193
|
+
|
|
1194
|
+
/**
|
|
1195
|
+
* Service for managing UiPath Data Fabric Choice Sets
|
|
1196
|
+
*
|
|
1197
|
+
* Choice Sets are enumerated lists of values that can be used as field types in entities. They enable single-select or multi-select fields, such as expense types, categories, or status values. [UiPath Choice Sets Guide](https://docs.uipath.com/data-service/automation-cloud/latest/user-guide/choice-sets)
|
|
1198
|
+
*/
|
|
1199
|
+
interface ChoiceSetServiceModel {
|
|
1200
|
+
/**
|
|
1201
|
+
* Gets all choice sets in the org
|
|
1202
|
+
*
|
|
1203
|
+
* @returns Promise resolving to an array of choice set metadata
|
|
1204
|
+
* {@link ChoiceSetGetAllResponse}
|
|
1205
|
+
* @example
|
|
1206
|
+
* ```typescript
|
|
1207
|
+
* // Get all choice sets
|
|
1208
|
+
* const choiceSets = await sdk.entities.choicesets.getAll();
|
|
1209
|
+
*
|
|
1210
|
+
* // Iterate through choice sets
|
|
1211
|
+
* choiceSets.forEach(choiceSet => {
|
|
1212
|
+
* console.log(`ChoiceSet: ${choiceSet.displayName} (${choiceSet.name})`);
|
|
1213
|
+
* console.log(`Description: ${choiceSet.description}`);
|
|
1214
|
+
* console.log(`Created by: ${choiceSet.createdBy}`);
|
|
1215
|
+
* });
|
|
1216
|
+
*
|
|
1217
|
+
* // Find a specific choice set by name
|
|
1218
|
+
* const expenseTypes = choiceSets.find(cs => cs.name === 'ExpenseTypes');
|
|
1219
|
+
*
|
|
1220
|
+
* // Check choice set details
|
|
1221
|
+
* if (expenseTypes) {
|
|
1222
|
+
* console.log(`Last updated: ${expenseTypes.updatedTime}`);
|
|
1223
|
+
* console.log(`Updated by: ${expenseTypes.updatedBy}`);
|
|
1224
|
+
* }
|
|
1225
|
+
* ```
|
|
1226
|
+
*/
|
|
1227
|
+
getAll(): Promise<ChoiceSetGetAllResponse[]>;
|
|
1228
|
+
/**
|
|
1229
|
+
* Gets choice set values by choice set ID with optional pagination
|
|
1230
|
+
*
|
|
1231
|
+
* The method returns either:
|
|
1232
|
+
* - A NonPaginatedResponse with items array (when no pagination parameters are provided)
|
|
1233
|
+
* - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
|
|
1234
|
+
*
|
|
1235
|
+
* @param choiceSetId - UUID of the choice set
|
|
1236
|
+
* @param options - Pagination options
|
|
1237
|
+
* @returns Promise resolving to choice set values or paginated result
|
|
1238
|
+
* {@link ChoiceSetGetResponse}
|
|
1239
|
+
* @example
|
|
1240
|
+
* ```typescript
|
|
1241
|
+
* // First, get the choice set ID using getAll()
|
|
1242
|
+
* const choiceSets = await sdk.entities.choicesets.getAll();
|
|
1243
|
+
* const expenseTypes = choiceSets.find(cs => cs.name === 'ExpenseTypes');
|
|
1244
|
+
* const choiceSetId = expenseTypes.id;
|
|
1245
|
+
*
|
|
1246
|
+
* // Get all values (non-paginated)
|
|
1247
|
+
* const values = await sdk.entities.choicesets.getById(choiceSetId);
|
|
1248
|
+
*
|
|
1249
|
+
* // Iterate through choice set values
|
|
1250
|
+
* for (const value of values.items) {
|
|
1251
|
+
* console.log(`Value: ${value.displayName}`);
|
|
1252
|
+
* }
|
|
1253
|
+
*
|
|
1254
|
+
* // First page with pagination
|
|
1255
|
+
* const page1 = await sdk.entities.choicesets.getById(choiceSetId, { pageSize: 10 });
|
|
1256
|
+
*
|
|
1257
|
+
* // Navigate using cursor
|
|
1258
|
+
* if (page1.hasNextPage) {
|
|
1259
|
+
* const page2 = await sdk.entities.choicesets.getById(choiceSetId, { cursor: page1.nextCursor });
|
|
1260
|
+
* }
|
|
1261
|
+
* ```
|
|
1262
|
+
*/
|
|
1263
|
+
getById<T extends ChoiceSetGetByIdOptions = ChoiceSetGetByIdOptions>(choiceSetId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ChoiceSetGetResponse> : NonPaginatedResponse<ChoiceSetGetResponse>>;
|
|
1264
|
+
}
|
|
1265
|
+
|
|
1266
|
+
declare class ChoiceSetService extends BaseService implements ChoiceSetServiceModel {
|
|
1267
|
+
/**
|
|
1268
|
+
* @hideconstructor
|
|
1269
|
+
*/
|
|
1270
|
+
constructor(config: Config, executionContext: ExecutionContext, tokenManager: TokenManager);
|
|
1271
|
+
/**
|
|
1272
|
+
* Gets all choice sets in the system
|
|
1273
|
+
*
|
|
1274
|
+
* @returns Promise resolving to an array of choice set metadata
|
|
1275
|
+
*
|
|
1276
|
+
* @example
|
|
1277
|
+
* ```typescript
|
|
1278
|
+
* // Get all choice sets
|
|
1279
|
+
* const choiceSets = await sdk.entities.choicesets.getAll();
|
|
1280
|
+
*
|
|
1281
|
+
* // Iterate through choice sets
|
|
1282
|
+
* choiceSets.forEach(choiceSet => {
|
|
1283
|
+
* console.log(`ChoiceSet: ${choiceSet.displayName} (${choiceSet.name})`);
|
|
1284
|
+
* console.log(`Description: ${choiceSet.description}`);
|
|
1285
|
+
* });
|
|
1286
|
+
* ```
|
|
1287
|
+
*/
|
|
1288
|
+
getAll(): Promise<ChoiceSetGetAllResponse[]>;
|
|
1289
|
+
/**
|
|
1290
|
+
* Gets choice set values by choice set ID with optional pagination
|
|
1291
|
+
*
|
|
1292
|
+
* The method returns either:
|
|
1293
|
+
* - A NonPaginatedResponse with items array (when no pagination parameters are provided)
|
|
1294
|
+
* - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
|
|
1295
|
+
*
|
|
1296
|
+
* @param choiceSetId - UUID of the choice set
|
|
1297
|
+
* @param options - Pagination options
|
|
1298
|
+
* @returns Promise resolving to choice set values or paginated result
|
|
1299
|
+
*
|
|
1300
|
+
* @example
|
|
1301
|
+
* ```typescript
|
|
1302
|
+
* // First, get the choice set ID using getAll()
|
|
1303
|
+
* const choiceSets = await sdk.entities.choicesets.getAll();
|
|
1304
|
+
* const expenseTypes = choiceSets.find(cs => cs.name === 'ExpenseTypes');
|
|
1305
|
+
* const choiceSetId = expenseTypes.id;
|
|
1306
|
+
*
|
|
1307
|
+
* // Get all values (non-paginated)
|
|
1308
|
+
* const values = await sdk.entities.choicesets.getById(choiceSetId);
|
|
1309
|
+
*
|
|
1310
|
+
* // Iterate through choice set values
|
|
1311
|
+
* for (const value of values.items) {
|
|
1312
|
+
* console.log(`Value: ${value.displayName} (${value.name})`);
|
|
1313
|
+
* }
|
|
1314
|
+
*
|
|
1315
|
+
* // First page with pagination
|
|
1316
|
+
* const page1 = await sdk.entities.choicesets.getById(choiceSetId, { pageSize: 10 });
|
|
1317
|
+
*
|
|
1318
|
+
* // Navigate using cursor
|
|
1319
|
+
* if (page1.hasNextPage) {
|
|
1320
|
+
* const page2 = await sdk.entities.choicesets.getById(choiceSetId, { cursor: page1.nextCursor });
|
|
1321
|
+
* }
|
|
1322
|
+
* ```
|
|
1323
|
+
*/
|
|
1324
|
+
getById<T extends ChoiceSetGetByIdOptions = ChoiceSetGetByIdOptions>(choiceSetId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ChoiceSetGetResponse> : NonPaginatedResponse<ChoiceSetGetResponse>>;
|
|
1325
|
+
}
|
|
1326
|
+
|
|
1073
1327
|
/**
|
|
1074
1328
|
* Maestro Process Types
|
|
1075
1329
|
* Types and interfaces for Maestro process management
|
|
@@ -2249,6 +2503,14 @@ type TaskGetAllOptions = RequestOptions & PaginationOptions & {
|
|
|
2249
2503
|
* Optional folder ID to filter tasks by folder
|
|
2250
2504
|
*/
|
|
2251
2505
|
folderId?: number;
|
|
2506
|
+
/**
|
|
2507
|
+
* Optional flag to fetch tasks using admin permissions
|
|
2508
|
+
* When true, fetches tasks across folders
|
|
2509
|
+
* where the user has at least Task.View, Task.Edit and TaskAssignment.Create permissions
|
|
2510
|
+
* When false or omitted, fetches tasks across folders
|
|
2511
|
+
* where the user has at least Task.View and Task.Edit permissions
|
|
2512
|
+
*/
|
|
2513
|
+
asTaskAdmin?: boolean;
|
|
2252
2514
|
};
|
|
2253
2515
|
/**
|
|
2254
2516
|
* Query options for getting a task by ID
|
|
@@ -2269,7 +2531,7 @@ interface TaskServiceModel {
|
|
|
2269
2531
|
/**
|
|
2270
2532
|
* Gets all tasks across folders with optional filtering
|
|
2271
2533
|
*
|
|
2272
|
-
* @param options - Query options including optional folderId and pagination options
|
|
2534
|
+
* @param options - Query options including optional folderId, asTaskAdmin flag and pagination options
|
|
2273
2535
|
* @returns Promise resolving to either an array of tasks NonPaginatedResponse<TaskGetResponse> or a PaginatedResponse<TaskGetResponse> when pagination options are used.
|
|
2274
2536
|
* {@link TaskGetResponse}
|
|
2275
2537
|
* @example
|
|
@@ -2282,6 +2544,18 @@ interface TaskServiceModel {
|
|
|
2282
2544
|
* folderId: 123
|
|
2283
2545
|
* });
|
|
2284
2546
|
*
|
|
2547
|
+
* // Get tasks with admin permissions
|
|
2548
|
+
* // This fetches tasks across folders where the user has Task.View, Task.Edit and TaskAssignment.Create permissions
|
|
2549
|
+
* const tasks = await sdk.tasks.getAll({
|
|
2550
|
+
* asTaskAdmin: true
|
|
2551
|
+
* });
|
|
2552
|
+
*
|
|
2553
|
+
* // Get tasks without admin permissions (default)
|
|
2554
|
+
* // This fetches tasks across folders where the user has Task.View and Task.Edit permissions
|
|
2555
|
+
* const tasks = await sdk.tasks.getAll({
|
|
2556
|
+
* asTaskAdmin: false
|
|
2557
|
+
* });
|
|
2558
|
+
*
|
|
2285
2559
|
* // First page with pagination
|
|
2286
2560
|
* const page1 = await sdk.tasks.getAll({ pageSize: 10 });
|
|
2287
2561
|
*
|
|
@@ -4502,7 +4776,7 @@ declare class TaskService extends BaseService implements TaskServiceModel {
|
|
|
4502
4776
|
* - An array of tasks (when no pagination parameters are provided)
|
|
4503
4777
|
* - A paginated result with navigation cursors (when any pagination parameter is provided)
|
|
4504
4778
|
*
|
|
4505
|
-
* @param options - Query options including optional folderId and pagination options
|
|
4779
|
+
* @param options - Query options including optional folderId, asTaskAdmin flag and pagination options
|
|
4506
4780
|
* @returns Promise resolving to an array of tasks or paginated result
|
|
4507
4781
|
*
|
|
4508
4782
|
* @example
|
|
@@ -4515,6 +4789,11 @@ declare class TaskService extends BaseService implements TaskServiceModel {
|
|
|
4515
4789
|
* folderId: 123
|
|
4516
4790
|
* });
|
|
4517
4791
|
*
|
|
4792
|
+
* // Get tasks with admin permissions
|
|
4793
|
+
* const tasks = await sdk.tasks.getAll({
|
|
4794
|
+
* asTaskAdmin: true
|
|
4795
|
+
* });
|
|
4796
|
+
*
|
|
4518
4797
|
* // First page with pagination
|
|
4519
4798
|
* const page1 = await sdk.tasks.getAll({ pageSize: 10 });
|
|
4520
4799
|
*
|
|
@@ -4769,7 +5048,12 @@ declare class UiPath {
|
|
|
4769
5048
|
/**
|
|
4770
5049
|
* Access to Entity service
|
|
4771
5050
|
*/
|
|
4772
|
-
get entities(): EntityService
|
|
5051
|
+
get entities(): EntityService & {
|
|
5052
|
+
/**
|
|
5053
|
+
* Access to ChoiceSet service for managing choice sets
|
|
5054
|
+
*/
|
|
5055
|
+
choicesets: ChoiceSetService;
|
|
5056
|
+
};
|
|
4773
5057
|
/**
|
|
4774
5058
|
* Access to Tasks service
|
|
4775
5059
|
*/
|
|
@@ -5073,7 +5357,7 @@ declare const telemetryClient: TelemetryClient;
|
|
|
5073
5357
|
* SDK Telemetry constants
|
|
5074
5358
|
*/
|
|
5075
5359
|
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";
|
|
5076
|
-
declare const SDK_VERSION = "1.0.0-beta.
|
|
5360
|
+
declare const SDK_VERSION = "1.0.0-beta.17";
|
|
5077
5361
|
declare const VERSION = "Version";
|
|
5078
5362
|
declare const SERVICE = "Service";
|
|
5079
5363
|
declare const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
|
|
@@ -5089,4 +5373,4 @@ declare const SDK_RUN_EVENT = "Sdk.Run";
|
|
|
5089
5373
|
declare const UNKNOWN = "";
|
|
5090
5374
|
|
|
5091
5375
|
export { APP_NAME, AssetValueScope, AssetValueType, AuthenticationError, AuthorizationError, BucketOptions, CLOUD_CLIENT_ID, CLOUD_ORGANIZATION_NAME, CLOUD_REDIRECT_URI, CLOUD_ROLE_NAME, CLOUD_TENANT_NAME, CLOUD_URL, CONNECTION_STRING, DEFAULT_ITEMS_FIELD, DEFAULT_PAGE_SIZE, DEFAULT_TOTAL_COUNT_FIELD, DataDirectionType, DebugMode, EntityFieldDataType, EntityType, ErrorType, EscalationActionType, EscalationRecipientScope, EscalationTriggerType, FieldDisplayType, HttpStatus, JobPriority, JobState, JobType, JoinType, MAX_PAGE_SIZE, 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, StageTaskType, StartStrategy, StopStrategy, TargetFramework, TaskActivityType, TaskPriority, TaskSlaCriteria, TaskSlaStatus, TaskSourceName, TaskStatus, TaskType, UNKNOWN, UiPath, UiPathError, VERSION, ValidationError, createCaseInstanceWithMethods, createEntityWithMethods, createProcessInstanceWithMethods, createProcessWithMethods, createTaskWithMethods, getErrorDetails, getLimitedPageSize, isAuthenticationError, isAuthorizationError, isNetworkError, isNotFoundError, isRateLimitError, isServerError, isUiPathError, isValidationError, telemetryClient, track, trackEvent };
|
|
5092
|
-
export type { ArgumentMetadata, AssetGetAllOptions, AssetGetByIdOptions, AssetGetResponse, AssetServiceModel, BaseConfig, BaseOptions, 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, CaseInstanceRun, CaseInstancesServiceModel, CasesServiceModel, CollectionResponse, CustomKeyValuePair, ElementExecutionMetadata, ElementMetaData, ElementRunMetadata, EntityDeleteOptions, EntityDeleteResponse, EntityGetRecordsByIdOptions, EntityGetResponse, EntityInsertOptions, EntityInsertResponse, EntityMethods, EntityOperationOptions, EntityOperationResponse, EntityRecord, EntityServiceModel, EntityUpdateOptions, EntityUpdateResponse, EscalationAction, EscalationRecipient, EscalationRule, EscalationTriggerMetadata, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, FailureRecord, Field, FieldDataType, FieldMetaData, FolderProperties, GlobalVariableMetaData, HasPaginationOptions, Headers, HttpMethod, JobAttachment, JobError, Machine, MaestroProcessGetAllResponse, MaestroProcessesServiceModel, NonPaginatedResponse, OAuthFields, OperationResponse, PaginatedResponse, PaginationCursor, PaginationMetadata, PaginationMethodUnion, PaginationOptions, ProcessGetAllOptions, ProcessGetByIdOptions, ProcessGetResponse, ProcessIncidentGetAllResponse, ProcessIncidentGetResponse, ProcessIncidentsServiceModel, ProcessInstanceExecutionHistoryResponse, ProcessInstanceGetAllOptions, ProcessInstanceGetAllWithPaginationOptions, ProcessInstanceGetResponse, ProcessInstanceGetVariablesOptions, ProcessInstanceGetVariablesResponse, ProcessInstanceMethods, ProcessInstanceOperationOptions, ProcessInstanceOperationResponse, ProcessInstanceRun, ProcessInstancesServiceModel, ProcessMethods, ProcessProperties, ProcessServiceModel, ProcessStartRequest, ProcessStartResponse, QueryParams, QueueGetAllOptions, QueueGetByIdOptions, QueueGetResponse, QueueServiceModel, RawCaseInstanceGetResponse, RawEntityGetResponse, RawMaestroProcessGetAllResponse, RawProcessInstanceGetResponse, RawTaskCreateResponse, RawTaskGetResponse, RequestOptions, RequestSpec, ResponseDictionary, ResponseType, RetryOptions, RobotMetadata, SourceJoinCriteria, StageSLA, StageTask, Tag, TaskActivity, TaskAssignOptions, TaskAssignment, TaskAssignmentOptions, TaskAssignmentResponse, TaskBaseResponse, TaskCompleteOptions, TaskCompletionOptions, TaskCreateOptions, TaskCreateResponse, TaskGetAllOptions, TaskGetByIdOptions, TaskGetResponse, TaskGetUsersOptions, TaskMethods, TaskServiceModel, TaskSlaDetail, TaskSource, TasksUnassignOptions, TimeoutOptions, UiPathSDKConfig, UserLoginInfo };
|
|
5376
|
+
export type { ArgumentMetadata, AssetGetAllOptions, AssetGetByIdOptions, AssetGetResponse, AssetServiceModel, BaseConfig, BaseOptions, 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, CaseInstanceRun, CaseInstancesServiceModel, CasesServiceModel, ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, CollectionResponse, CustomKeyValuePair, ElementExecutionMetadata, ElementMetaData, ElementRunMetadata, EntityDeleteOptions, EntityDeleteResponse, EntityDownloadAttachmentOptions, EntityGetRecordsByIdOptions, EntityGetResponse, EntityInsertOptions, EntityInsertResponse, EntityMethods, EntityOperationOptions, EntityOperationResponse, EntityRecord, EntityServiceModel, EntityUpdateOptions, EntityUpdateResponse, EscalationAction, EscalationRecipient, EscalationRule, EscalationTriggerMetadata, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, FailureRecord, Field, FieldDataType, FieldMetaData, FolderProperties, GlobalVariableMetaData, HasPaginationOptions, Headers, HttpMethod, JobAttachment, JobError, Machine, MaestroProcessGetAllResponse, MaestroProcessesServiceModel, NonPaginatedResponse, OAuthFields, OperationResponse, PaginatedResponse, PaginationCursor, PaginationMetadata, PaginationMethodUnion, PaginationOptions, ProcessGetAllOptions, ProcessGetByIdOptions, ProcessGetResponse, ProcessIncidentGetAllResponse, ProcessIncidentGetResponse, ProcessIncidentsServiceModel, ProcessInstanceExecutionHistoryResponse, ProcessInstanceGetAllOptions, ProcessInstanceGetAllWithPaginationOptions, ProcessInstanceGetResponse, ProcessInstanceGetVariablesOptions, ProcessInstanceGetVariablesResponse, ProcessInstanceMethods, ProcessInstanceOperationOptions, ProcessInstanceOperationResponse, ProcessInstanceRun, ProcessInstancesServiceModel, ProcessMethods, ProcessProperties, ProcessServiceModel, ProcessStartRequest, ProcessStartResponse, QueryParams, QueueGetAllOptions, QueueGetByIdOptions, QueueGetResponse, QueueServiceModel, RawCaseInstanceGetResponse, RawEntityGetResponse, RawMaestroProcessGetAllResponse, RawProcessInstanceGetResponse, RawTaskCreateResponse, RawTaskGetResponse, RequestOptions, RequestSpec, ResponseDictionary, ResponseType, RetryOptions, RobotMetadata, SourceJoinCriteria, StageSLA, StageTask, Tag, TaskActivity, TaskAssignOptions, TaskAssignment, TaskAssignmentOptions, TaskAssignmentResponse, TaskBaseResponse, TaskCompleteOptions, TaskCompletionOptions, TaskCreateOptions, TaskCreateResponse, TaskGetAllOptions, TaskGetByIdOptions, TaskGetResponse, TaskGetUsersOptions, TaskMethods, TaskServiceModel, TaskSlaDetail, TaskSource, TasksUnassignOptions, TimeoutOptions, UiPathSDKConfig, UserLoginInfo };
|