@uipath/uipath-typescript 1.0.0-beta.14 → 1.0.0-beta.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +201 -132
- package/dist/{index.js → index.cjs} +446 -186
- package/dist/index.d.cts +5091 -0
- package/dist/index.d.mts +5091 -0
- package/dist/index.d.ts +517 -136
- package/dist/{index.esm.js → index.mjs} +446 -168
- package/dist/index.umd.js +17784 -0
- package/package.json +18 -22
package/dist/index.d.ts
CHANGED
|
@@ -1077,7 +1077,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
|
|
|
1077
1077
|
/**
|
|
1078
1078
|
* Process information with instance statistics
|
|
1079
1079
|
*/
|
|
1080
|
-
interface
|
|
1080
|
+
interface RawMaestroProcessGetAllResponse {
|
|
1081
1081
|
/** Unique key identifying the process */
|
|
1082
1082
|
processKey: string;
|
|
1083
1083
|
/** Package identifier */
|
|
@@ -1114,6 +1114,68 @@ interface MaestroProcessGetAllResponse {
|
|
|
1114
1114
|
cancelingCount: number;
|
|
1115
1115
|
}
|
|
1116
1116
|
|
|
1117
|
+
/**
|
|
1118
|
+
* Process Incident Status
|
|
1119
|
+
*/
|
|
1120
|
+
declare enum ProcessIncidentStatus {
|
|
1121
|
+
Open = "Open",
|
|
1122
|
+
Closed = "Closed"
|
|
1123
|
+
}
|
|
1124
|
+
/**
|
|
1125
|
+
* Process Incident Type
|
|
1126
|
+
*/
|
|
1127
|
+
declare enum ProcessIncidentType {
|
|
1128
|
+
System = "System",
|
|
1129
|
+
User = "User",
|
|
1130
|
+
Deployment = "Deployment"
|
|
1131
|
+
}
|
|
1132
|
+
/**
|
|
1133
|
+
* Process Incident Severity
|
|
1134
|
+
*/
|
|
1135
|
+
declare enum ProcessIncidentSeverity {
|
|
1136
|
+
Error = "Error",
|
|
1137
|
+
Warning = "Warning"
|
|
1138
|
+
}
|
|
1139
|
+
/**
|
|
1140
|
+
* Process Incident Debug Mode
|
|
1141
|
+
*/
|
|
1142
|
+
declare enum DebugMode {
|
|
1143
|
+
None = "None",
|
|
1144
|
+
Default = "Default",
|
|
1145
|
+
StepByStep = "StepByStep",
|
|
1146
|
+
SingleStep = "SingleStep"
|
|
1147
|
+
}
|
|
1148
|
+
/**
|
|
1149
|
+
* Process Incident Get Response
|
|
1150
|
+
*/
|
|
1151
|
+
interface ProcessIncidentGetResponse {
|
|
1152
|
+
instanceId: string;
|
|
1153
|
+
elementId: string;
|
|
1154
|
+
folderKey: string;
|
|
1155
|
+
processKey: string;
|
|
1156
|
+
incidentId: string;
|
|
1157
|
+
incidentStatus: ProcessIncidentStatus;
|
|
1158
|
+
incidentType: ProcessIncidentType | null;
|
|
1159
|
+
errorCode: string;
|
|
1160
|
+
errorMessage: string;
|
|
1161
|
+
errorTime: string;
|
|
1162
|
+
errorDetails: string;
|
|
1163
|
+
debugMode: DebugMode;
|
|
1164
|
+
incidentSeverity: ProcessIncidentSeverity | null;
|
|
1165
|
+
incidentElementActivityType: string;
|
|
1166
|
+
incidentElementActivityName: string;
|
|
1167
|
+
}
|
|
1168
|
+
/**
|
|
1169
|
+
* Process Incident Summary Get Response
|
|
1170
|
+
*/
|
|
1171
|
+
interface ProcessIncidentGetAllResponse {
|
|
1172
|
+
count: number;
|
|
1173
|
+
errorMessage: string;
|
|
1174
|
+
errorCode: string;
|
|
1175
|
+
firstOccuranceTime: string;
|
|
1176
|
+
processKey: string;
|
|
1177
|
+
}
|
|
1178
|
+
|
|
1117
1179
|
/**
|
|
1118
1180
|
* Maestro Process Models
|
|
1119
1181
|
* Model classes for Maestro processes
|
|
@@ -1126,24 +1188,66 @@ interface MaestroProcessGetAllResponse {
|
|
|
1126
1188
|
*/
|
|
1127
1189
|
interface MaestroProcessesServiceModel {
|
|
1128
1190
|
/**
|
|
1129
|
-
* @returns Promise resolving to array of MaestroProcess objects
|
|
1191
|
+
* @returns Promise resolving to array of MaestroProcess objects with methods
|
|
1130
1192
|
* {@link MaestroProcessGetAllResponse}
|
|
1131
1193
|
* @example
|
|
1132
1194
|
* ```typescript
|
|
1133
1195
|
* // Get all processes
|
|
1134
1196
|
* const processes = await sdk.maestro.processes.getAll();
|
|
1135
1197
|
*
|
|
1136
|
-
* // Access process information
|
|
1198
|
+
* // Access process information and incidents
|
|
1137
1199
|
* for (const process of processes) {
|
|
1138
1200
|
* console.log(`Process: ${process.processKey}`);
|
|
1139
1201
|
* console.log(`Running instances: ${process.runningCount}`);
|
|
1140
1202
|
* console.log(`Faulted instances: ${process.faultedCount}`);
|
|
1203
|
+
*
|
|
1204
|
+
* // Get incidents for this process
|
|
1205
|
+
* const incidents = await process.getIncidents();
|
|
1206
|
+
* console.log(`Incidents: ${incidents.length}`);
|
|
1141
1207
|
* }
|
|
1142
1208
|
*
|
|
1143
1209
|
* ```
|
|
1144
1210
|
*/
|
|
1145
1211
|
getAll(): Promise<MaestroProcessGetAllResponse[]>;
|
|
1212
|
+
/**
|
|
1213
|
+
* Get incidents for a specific process
|
|
1214
|
+
*
|
|
1215
|
+
* @param processKey The key of the process to get incidents for
|
|
1216
|
+
* @param folderKey The folder key for authorization
|
|
1217
|
+
* @returns Promise resolving to array of incidents for the process
|
|
1218
|
+
* {@link ProcessIncidentGetResponse}
|
|
1219
|
+
* @example
|
|
1220
|
+
* ```typescript
|
|
1221
|
+
* // Get incidents for a specific process
|
|
1222
|
+
* const incidents = await sdk.maestro.processes.getIncidents('<processKey>', '<folderKey>');
|
|
1223
|
+
*
|
|
1224
|
+
* // Access incident details
|
|
1225
|
+
* for (const incident of incidents) {
|
|
1226
|
+
* console.log(`Element: ${incident.incidentElementActivityName} (${incident.incidentElementActivityType})`);
|
|
1227
|
+
* console.log(`Status: ${incident.incidentStatus}`);
|
|
1228
|
+
* console.log(`Error: ${incident.errorMessage}`);
|
|
1229
|
+
* }
|
|
1230
|
+
* ```
|
|
1231
|
+
*/
|
|
1232
|
+
getIncidents(processKey: string, folderKey: string): Promise<ProcessIncidentGetResponse[]>;
|
|
1233
|
+
}
|
|
1234
|
+
interface ProcessMethods {
|
|
1235
|
+
/**
|
|
1236
|
+
* Gets incidents for this process
|
|
1237
|
+
*
|
|
1238
|
+
* @returns Promise resolving to array of process incidents
|
|
1239
|
+
*/
|
|
1240
|
+
getIncidents(): Promise<ProcessIncidentGetResponse[]>;
|
|
1146
1241
|
}
|
|
1242
|
+
type MaestroProcessGetAllResponse = RawMaestroProcessGetAllResponse & ProcessMethods;
|
|
1243
|
+
/**
|
|
1244
|
+
* Creates an actionable process by combining API process data with operational methods.
|
|
1245
|
+
*
|
|
1246
|
+
* @param processData - The process data from API
|
|
1247
|
+
* @param service - The process service instance
|
|
1248
|
+
* @returns A process object with added methods
|
|
1249
|
+
*/
|
|
1250
|
+
declare function createProcessWithMethods(processData: MaestroProcessGetAllResponse, service: MaestroProcessesServiceModel): MaestroProcessGetAllResponse;
|
|
1147
1251
|
|
|
1148
1252
|
/**
|
|
1149
1253
|
* Constants used throughout the pagination system
|
|
@@ -1453,32 +1557,23 @@ interface ProcessInstancesServiceModel {
|
|
|
1453
1557
|
* <folderKey>
|
|
1454
1558
|
* );
|
|
1455
1559
|
*
|
|
1456
|
-
*
|
|
1457
|
-
* console.log(`Instance ${result.data.instanceId} now has status: ${result.data.status}`);
|
|
1458
|
-
* }
|
|
1560
|
+
* or
|
|
1459
1561
|
*
|
|
1460
|
-
*
|
|
1461
|
-
* const result = await sdk.maestro.processes.instances.cancel(
|
|
1562
|
+
* const instance = await sdk.maestro.processes.instances.getById(
|
|
1462
1563
|
* <instanceId>,
|
|
1463
|
-
* <folderKey
|
|
1464
|
-
* { comment: <comment> }
|
|
1564
|
+
* <folderKey>
|
|
1465
1565
|
* );
|
|
1566
|
+
* const result = await instance.cancel();
|
|
1466
1567
|
*
|
|
1467
|
-
*
|
|
1468
|
-
*
|
|
1469
|
-
*
|
|
1568
|
+
* console.log(`Cancelled: ${result.success}`);
|
|
1569
|
+
*
|
|
1570
|
+
* // Cancel with a comment
|
|
1571
|
+
* const result = await instance.cancel({
|
|
1572
|
+
* comment: 'Cancelling due to invalid input data'
|
|
1470
1573
|
* });
|
|
1471
1574
|
*
|
|
1472
|
-
*
|
|
1473
|
-
*
|
|
1474
|
-
* instance.instanceId,
|
|
1475
|
-
* instance.folderKey,
|
|
1476
|
-
* { comment: <comment> }
|
|
1477
|
-
* );
|
|
1478
|
-
*
|
|
1479
|
-
* if (result.success) {
|
|
1480
|
-
* console.log(`Cancelled instance: ${result.data.instanceId}`);
|
|
1481
|
-
* }
|
|
1575
|
+
* if (result.success) {
|
|
1576
|
+
* console.log(`Instance ${result.data.instanceId} status: ${result.data.status}`);
|
|
1482
1577
|
* }
|
|
1483
1578
|
* ```
|
|
1484
1579
|
*/
|
|
@@ -1535,6 +1630,27 @@ interface ProcessInstancesServiceModel {
|
|
|
1535
1630
|
* ```
|
|
1536
1631
|
*/
|
|
1537
1632
|
getVariables(instanceId: string, folderKey: string, options?: ProcessInstanceGetVariablesOptions): Promise<ProcessInstanceGetVariablesResponse>;
|
|
1633
|
+
/**
|
|
1634
|
+
* Get incidents for a process instance
|
|
1635
|
+
*
|
|
1636
|
+
* @param instanceId The ID of the instance to get incidents for
|
|
1637
|
+
* @param folderKey The folder key for authorization
|
|
1638
|
+
* @returns Promise resolving to array of incidents for the processinstance
|
|
1639
|
+
* {@link ProcessIncidentGetResponse}
|
|
1640
|
+
* @example
|
|
1641
|
+
* ```typescript
|
|
1642
|
+
* // Get incidents for a specific instance
|
|
1643
|
+
* const incidents = await sdk.maestro.processes.instances.getIncidents('<instanceId>', '<folderKey>');
|
|
1644
|
+
*
|
|
1645
|
+
* // Access process incident details
|
|
1646
|
+
* for (const incident of incidents) {
|
|
1647
|
+
* console.log(`Element: ${incident.incidentElementActivityName} (${incident.incidentElementActivityType})`);
|
|
1648
|
+
* console.log(`Severity: ${incident.incidentSeverity}`);
|
|
1649
|
+
* console.log(`Error: ${incident.errorMessage}`);
|
|
1650
|
+
* }
|
|
1651
|
+
* ```
|
|
1652
|
+
*/
|
|
1653
|
+
getIncidents(instanceId: string, folderKey: string): Promise<ProcessIncidentGetResponse[]>;
|
|
1538
1654
|
}
|
|
1539
1655
|
interface ProcessInstanceMethods {
|
|
1540
1656
|
/**
|
|
@@ -1558,6 +1674,31 @@ interface ProcessInstanceMethods {
|
|
|
1558
1674
|
* @returns Promise resolving to operation result
|
|
1559
1675
|
*/
|
|
1560
1676
|
resume(options?: ProcessInstanceOperationOptions): Promise<OperationResponse<ProcessInstanceOperationResponse>>;
|
|
1677
|
+
/**
|
|
1678
|
+
* Gets incidents for this process instance
|
|
1679
|
+
*
|
|
1680
|
+
* @returns Promise resolving to array of incidents for this instance
|
|
1681
|
+
*/
|
|
1682
|
+
getIncidents(): Promise<ProcessIncidentGetResponse[]>;
|
|
1683
|
+
/**
|
|
1684
|
+
* Gets execution history (spans) for this process instance
|
|
1685
|
+
*
|
|
1686
|
+
* @returns Promise resolving to execution history
|
|
1687
|
+
*/
|
|
1688
|
+
getExecutionHistory(): Promise<ProcessInstanceExecutionHistoryResponse[]>;
|
|
1689
|
+
/**
|
|
1690
|
+
* Gets BPMN XML file for this process instance
|
|
1691
|
+
*
|
|
1692
|
+
* @returns Promise resolving to BPMN XML file
|
|
1693
|
+
*/
|
|
1694
|
+
getBpmn(): Promise<BpmnXmlString>;
|
|
1695
|
+
/**
|
|
1696
|
+
* Gets global variables for this process instance
|
|
1697
|
+
*
|
|
1698
|
+
* @param options - Optional options including parentElementId to filter by parent element
|
|
1699
|
+
* @returns Promise resolving to variables response with elements and globals
|
|
1700
|
+
*/
|
|
1701
|
+
getVariables(options?: ProcessInstanceGetVariablesOptions): Promise<ProcessInstanceGetVariablesResponse>;
|
|
1561
1702
|
}
|
|
1562
1703
|
type ProcessInstanceGetResponse = RawProcessInstanceGetResponse & ProcessInstanceMethods;
|
|
1563
1704
|
/**
|
|
@@ -1569,6 +1710,34 @@ type ProcessInstanceGetResponse = RawProcessInstanceGetResponse & ProcessInstanc
|
|
|
1569
1710
|
*/
|
|
1570
1711
|
declare function createProcessInstanceWithMethods(instanceData: RawProcessInstanceGetResponse, service: ProcessInstancesServiceModel): ProcessInstanceGetResponse;
|
|
1571
1712
|
|
|
1713
|
+
/**
|
|
1714
|
+
* Service for managing UiPath Maestro Process incidents
|
|
1715
|
+
*
|
|
1716
|
+
* Maestro Process incidents helps you identify, investigate, and resolve errors that occur during process execution. [UiPath Maestro Process Incidents Guide](https://docs.uipath.com/maestro/automation-cloud/latest/user-guide/all-incidents-view)
|
|
1717
|
+
*/
|
|
1718
|
+
interface ProcessIncidentsServiceModel {
|
|
1719
|
+
/**
|
|
1720
|
+
* Get all process incidents across all folders
|
|
1721
|
+
*
|
|
1722
|
+
* @returns Promise resolving to array of process incident
|
|
1723
|
+
* {@link ProcessIncidentGetAllResponse}
|
|
1724
|
+
* @example
|
|
1725
|
+
* ```typescript
|
|
1726
|
+
* // Get all process incidents across all folders
|
|
1727
|
+
* const incidents = await sdk.maestro.processes.incidents.getAll();
|
|
1728
|
+
*
|
|
1729
|
+
* // Access process incident information
|
|
1730
|
+
* for (const incident of incidents) {
|
|
1731
|
+
* console.log(`Process: ${incident.processKey}`);
|
|
1732
|
+
* console.log(`Error: ${incident.errorMessage}`);
|
|
1733
|
+
* console.log(`Count: ${incident.count}`);
|
|
1734
|
+
* console.log(`First occurrence: ${incident.firstOccuranceTime}`);
|
|
1735
|
+
* }
|
|
1736
|
+
* ```
|
|
1737
|
+
*/
|
|
1738
|
+
getAll(): Promise<ProcessIncidentGetAllResponse[]>;
|
|
1739
|
+
}
|
|
1740
|
+
|
|
1572
1741
|
/**
|
|
1573
1742
|
* Maestro Cases Types
|
|
1574
1743
|
* Types and interfaces for Maestro case management
|
|
@@ -1973,14 +2142,12 @@ interface TaskBaseResponse {
|
|
|
1973
2142
|
title: string;
|
|
1974
2143
|
type: TaskType;
|
|
1975
2144
|
priority: TaskPriority;
|
|
1976
|
-
|
|
2145
|
+
folderId: number;
|
|
1977
2146
|
key: string;
|
|
1978
2147
|
isDeleted: boolean;
|
|
1979
2148
|
creationTime: string;
|
|
1980
|
-
creatorUserId: number;
|
|
1981
2149
|
id: number;
|
|
1982
2150
|
action: string | null;
|
|
1983
|
-
assignedToUserId: number | null;
|
|
1984
2151
|
externalTag: string | null;
|
|
1985
2152
|
lastAssignedTime: string | null;
|
|
1986
2153
|
completionTime: string | null;
|
|
@@ -2010,7 +2177,7 @@ interface RawTaskGetResponse extends TaskBaseResponse {
|
|
|
2010
2177
|
taskSlaDetail: TaskSlaDetail | null;
|
|
2011
2178
|
taskAssigneeName: string | null;
|
|
2012
2179
|
lastModifierUserId: number | null;
|
|
2013
|
-
assignedToUser
|
|
2180
|
+
assignedToUser: UserLoginInfo | null;
|
|
2014
2181
|
creatorUser?: UserLoginInfo;
|
|
2015
2182
|
lastModifierUser?: UserLoginInfo;
|
|
2016
2183
|
taskAssignments?: TaskAssignment[];
|
|
@@ -2026,11 +2193,24 @@ interface RawTaskGetResponse extends TaskBaseResponse {
|
|
|
2026
2193
|
processingTime?: number | null;
|
|
2027
2194
|
data?: Record<string, unknown> | null;
|
|
2028
2195
|
}
|
|
2029
|
-
|
|
2030
|
-
|
|
2196
|
+
/**
|
|
2197
|
+
* Options for task assignment operations when called from a task instance
|
|
2198
|
+
* Requires either userId or userNameOrEmail, but not both
|
|
2199
|
+
*/
|
|
2200
|
+
type TaskAssignOptions = {
|
|
2031
2201
|
userId: number;
|
|
2032
|
-
userNameOrEmail?:
|
|
2033
|
-
}
|
|
2202
|
+
userNameOrEmail?: never;
|
|
2203
|
+
} | {
|
|
2204
|
+
userId?: never;
|
|
2205
|
+
userNameOrEmail: string;
|
|
2206
|
+
};
|
|
2207
|
+
/**
|
|
2208
|
+
* Options for task assignment operations when called from the service
|
|
2209
|
+
* Extends TaskAssignOptions with the required taskId field
|
|
2210
|
+
*/
|
|
2211
|
+
type TaskAssignmentOptions = {
|
|
2212
|
+
taskId: number;
|
|
2213
|
+
} & TaskAssignOptions;
|
|
2034
2214
|
interface TasksUnassignOptions {
|
|
2035
2215
|
taskIds: number[];
|
|
2036
2216
|
}
|
|
@@ -2041,22 +2221,6 @@ interface TaskAssignmentResponse {
|
|
|
2041
2221
|
errorMessage?: string;
|
|
2042
2222
|
userNameOrEmail?: string;
|
|
2043
2223
|
}
|
|
2044
|
-
interface TaskCompletionOptions {
|
|
2045
|
-
taskId: number;
|
|
2046
|
-
data?: any;
|
|
2047
|
-
action?: string;
|
|
2048
|
-
}
|
|
2049
|
-
/**
|
|
2050
|
-
* Options for task assignment operations in the Task class
|
|
2051
|
-
* At least one identification parameter is required
|
|
2052
|
-
*/
|
|
2053
|
-
type TaskAssignOptions = {
|
|
2054
|
-
userId: number;
|
|
2055
|
-
userNameOrEmail?: string;
|
|
2056
|
-
} | {
|
|
2057
|
-
userId?: number;
|
|
2058
|
-
userNameOrEmail: string;
|
|
2059
|
-
};
|
|
2060
2224
|
/**
|
|
2061
2225
|
* Options for completing a task
|
|
2062
2226
|
*/
|
|
@@ -2069,6 +2233,13 @@ type TaskCompleteOptions = {
|
|
|
2069
2233
|
data: any;
|
|
2070
2234
|
action: string;
|
|
2071
2235
|
};
|
|
2236
|
+
/**
|
|
2237
|
+
* Options for completing a task when called from the service
|
|
2238
|
+
* Extends TaskCompleteOptions with the required taskId field
|
|
2239
|
+
*/
|
|
2240
|
+
type TaskCompletionOptions = TaskCompleteOptions & {
|
|
2241
|
+
taskId: number;
|
|
2242
|
+
};
|
|
2072
2243
|
/**
|
|
2073
2244
|
* Options for getting tasks across folders
|
|
2074
2245
|
*/
|
|
@@ -2100,16 +2271,188 @@ interface TaskServiceModel {
|
|
|
2100
2271
|
* @param options - Query options including optional folderId and pagination options
|
|
2101
2272
|
* @returns Promise resolving to either an array of tasks NonPaginatedResponse<TaskGetResponse> or a PaginatedResponse<TaskGetResponse> when pagination options are used.
|
|
2102
2273
|
* {@link TaskGetResponse}
|
|
2274
|
+
* @example
|
|
2275
|
+
* ```typescript
|
|
2276
|
+
* // Standard array return
|
|
2277
|
+
* const tasks = await sdk.tasks.getAll();
|
|
2278
|
+
*
|
|
2279
|
+
* // Get tasks within a specific folder
|
|
2280
|
+
* const tasks = await sdk.tasks.getAll({
|
|
2281
|
+
* folderId: 123
|
|
2282
|
+
* });
|
|
2283
|
+
*
|
|
2284
|
+
* // First page with pagination
|
|
2285
|
+
* const page1 = await sdk.tasks.getAll({ pageSize: 10 });
|
|
2286
|
+
*
|
|
2287
|
+
* // Navigate using cursor
|
|
2288
|
+
* if (page1.hasNextPage) {
|
|
2289
|
+
* const page2 = await sdk.tasks.getAll({ cursor: page1.nextCursor });
|
|
2290
|
+
* }
|
|
2291
|
+
*
|
|
2292
|
+
* // Jump to specific page
|
|
2293
|
+
* const page5 = await sdk.tasks.getAll({
|
|
2294
|
+
* jumpToPage: 5,
|
|
2295
|
+
* pageSize: 10
|
|
2296
|
+
* });
|
|
2297
|
+
* ```
|
|
2103
2298
|
*/
|
|
2104
2299
|
getAll<T extends TaskGetAllOptions = TaskGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<TaskGetResponse> : NonPaginatedResponse<TaskGetResponse>>;
|
|
2300
|
+
/**
|
|
2301
|
+
* Gets a task by ID
|
|
2302
|
+
* IMPORTANT: For form tasks, folderId must be provided.
|
|
2303
|
+
* @param id - The ID of the task to retrieve
|
|
2304
|
+
* @param options - Optional query parameters
|
|
2305
|
+
* @param folderId - Optional folder ID (REQUIRED for form tasks)
|
|
2306
|
+
* @returns Promise resolving to the task
|
|
2307
|
+
* {@link TaskGetResponse}
|
|
2308
|
+
* @example
|
|
2309
|
+
* ```typescript
|
|
2310
|
+
* // Get a task by ID
|
|
2311
|
+
* const task = await sdk.tasks.getById(<taskId>);
|
|
2312
|
+
*
|
|
2313
|
+
* // Get a form task by ID
|
|
2314
|
+
* const formTask = await sdk.tasks.getById(<taskId>, <folderId>);
|
|
2315
|
+
*
|
|
2316
|
+
* // Access form task properties
|
|
2317
|
+
* console.log(formTask.formLayout);
|
|
2318
|
+
* ```
|
|
2319
|
+
*/
|
|
2105
2320
|
getById(id: number, options?: TaskGetByIdOptions, folderId?: number): Promise<TaskGetResponse>;
|
|
2321
|
+
/**
|
|
2322
|
+
* Creates a new task
|
|
2323
|
+
*
|
|
2324
|
+
* @param options - The task to be created
|
|
2325
|
+
* @param folderId - Required folder ID
|
|
2326
|
+
* @returns Promise resolving to the created task
|
|
2327
|
+
* {@link TaskCreateResponse}
|
|
2328
|
+
* @example
|
|
2329
|
+
* ```typescript
|
|
2330
|
+
* import { TaskPriority } from '@uipath/uipath-typescript';
|
|
2331
|
+
* const task = await sdk.tasks.create({
|
|
2332
|
+
* title: "My Task",
|
|
2333
|
+
* priority: TaskPriority.Medium
|
|
2334
|
+
* }, <folderId>); // folderId is required
|
|
2335
|
+
* ```
|
|
2336
|
+
*/
|
|
2106
2337
|
create(options: TaskCreateOptions, folderId: number): Promise<TaskCreateResponse>;
|
|
2107
|
-
|
|
2108
|
-
|
|
2109
|
-
|
|
2338
|
+
/**
|
|
2339
|
+
* Assigns tasks to users
|
|
2340
|
+
*
|
|
2341
|
+
* @param options - Single task assignment or array of task assignments
|
|
2342
|
+
* @returns Promise resolving to array of task assignment results
|
|
2343
|
+
* {@link TaskAssignmentResponse}
|
|
2344
|
+
* @example
|
|
2345
|
+
* ```typescript
|
|
2346
|
+
* // Assign a single task to a user by ID
|
|
2347
|
+
* const result = await sdk.tasks.assign({
|
|
2348
|
+
* taskId: <taskId>,
|
|
2349
|
+
* userId: <userId>
|
|
2350
|
+
* });
|
|
2351
|
+
*
|
|
2352
|
+
* or
|
|
2353
|
+
*
|
|
2354
|
+
* const task = await sdk.tasks.getById(<taskId>);
|
|
2355
|
+
* const result = await task.assign({
|
|
2356
|
+
* userId: <userId>
|
|
2357
|
+
* });
|
|
2358
|
+
*
|
|
2359
|
+
* // Assign a single task to a user by email
|
|
2360
|
+
* const result = await sdk.tasks.assign({
|
|
2361
|
+
* taskId: <taskId>,
|
|
2362
|
+
* userNameOrEmail: "user@example.com"
|
|
2363
|
+
* });
|
|
2364
|
+
*
|
|
2365
|
+
* // Assign multiple tasks
|
|
2366
|
+
* const result = await sdk.tasks.assign([
|
|
2367
|
+
* { taskId: <taskId1>, userId: <userId> },
|
|
2368
|
+
* { taskId: <taskId2>, userNameOrEmail: "user@example.com" }
|
|
2369
|
+
* ]);
|
|
2370
|
+
* ```
|
|
2371
|
+
*/
|
|
2372
|
+
assign(options: TaskAssignmentOptions | TaskAssignmentOptions[]): Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>;
|
|
2373
|
+
/**
|
|
2374
|
+
* Reassigns tasks to new users
|
|
2375
|
+
*
|
|
2376
|
+
* @param options - Single task assignment or array of task assignments
|
|
2377
|
+
* @returns Promise resolving to array of task assignment results
|
|
2378
|
+
* {@link TaskAssignmentResponse}
|
|
2379
|
+
* @example
|
|
2380
|
+
* ```typescript
|
|
2381
|
+
* // Reassign a single task to a user by ID
|
|
2382
|
+
* const result = await sdk.tasks.reassign({
|
|
2383
|
+
* taskId: <taskId>,
|
|
2384
|
+
* userId: <userId>
|
|
2385
|
+
* });
|
|
2386
|
+
*
|
|
2387
|
+
* or
|
|
2388
|
+
*
|
|
2389
|
+
* const task = await sdk.tasks.getById(<taskId>);
|
|
2390
|
+
* const result = await task.reassign({
|
|
2391
|
+
* userId: <userId>
|
|
2392
|
+
* });
|
|
2393
|
+
*
|
|
2394
|
+
* // Reassign a single task to a user by email
|
|
2395
|
+
* const result = await sdk.tasks.reassign({
|
|
2396
|
+
* taskId: <taskId>,
|
|
2397
|
+
* userNameOrEmail: "user@example.com"
|
|
2398
|
+
* });
|
|
2399
|
+
*
|
|
2400
|
+
* // Reassign multiple tasks
|
|
2401
|
+
* const result = await sdk.tasks.reassign([
|
|
2402
|
+
* { taskId: <taskId1>, userId: <userId> },
|
|
2403
|
+
* { taskId: <taskId2>, userNameOrEmail: "user@example.com" }
|
|
2404
|
+
* ]);
|
|
2405
|
+
* ```
|
|
2406
|
+
*/
|
|
2407
|
+
reassign(options: TaskAssignmentOptions | TaskAssignmentOptions[]): Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>;
|
|
2408
|
+
/**
|
|
2409
|
+
* Unassigns tasks (removes current assignees)
|
|
2410
|
+
*
|
|
2411
|
+
* @param taskId - Single task ID or array of task IDs to unassign
|
|
2412
|
+
* @returns Promise resolving to array of task assignment results
|
|
2413
|
+
* {@link TaskAssignmentResponse}
|
|
2414
|
+
* @example
|
|
2415
|
+
* ```typescript
|
|
2416
|
+
* // Unassign a single task
|
|
2417
|
+
* const result = await sdk.tasks.unassign(<taskId>);
|
|
2418
|
+
*
|
|
2419
|
+
* or
|
|
2420
|
+
*
|
|
2421
|
+
* const task = await sdk.tasks.getById(<taskId>);
|
|
2422
|
+
* const result = await task.unassign();
|
|
2423
|
+
*
|
|
2424
|
+
* // Unassign multiple tasks
|
|
2425
|
+
* const result = await sdk.tasks.unassign([<taskId1>, <taskId2>, <taskId3>]);
|
|
2426
|
+
* ```
|
|
2427
|
+
*/
|
|
2428
|
+
unassign(taskId: number | number[]): Promise<OperationResponse<{
|
|
2110
2429
|
taskId: number;
|
|
2111
2430
|
}[] | TaskAssignmentResponse[]>>;
|
|
2112
|
-
|
|
2431
|
+
/**
|
|
2432
|
+
* Completes a task with the specified type and data
|
|
2433
|
+
*
|
|
2434
|
+
* @param options - The completion options including task type, taskId, data, and action
|
|
2435
|
+
* @param folderId - Required folder ID
|
|
2436
|
+
* @returns Promise resolving to completion result
|
|
2437
|
+
* {@link TaskCompleteOptions}
|
|
2438
|
+
* @example
|
|
2439
|
+
* ```typescript
|
|
2440
|
+
* // Complete an app task
|
|
2441
|
+
* await sdk.tasks.complete({
|
|
2442
|
+
* type: TaskType.App,
|
|
2443
|
+
* taskId: <taskId>,
|
|
2444
|
+
* data: {},
|
|
2445
|
+
* action: "submit"
|
|
2446
|
+
* }, <folderId>); // folderId is required
|
|
2447
|
+
*
|
|
2448
|
+
* // Complete an external task
|
|
2449
|
+
* await sdk.tasks.complete({
|
|
2450
|
+
* type: TaskType.External,
|
|
2451
|
+
* taskId: <taskId>
|
|
2452
|
+
* }, <folderId>); // folderId is required
|
|
2453
|
+
* ```
|
|
2454
|
+
*/
|
|
2455
|
+
complete(options: TaskCompletionOptions, folderId: number): Promise<OperationResponse<TaskCompletionOptions>>;
|
|
2113
2456
|
/**
|
|
2114
2457
|
* Gets users in the given folder who have Tasks.View and Tasks.Edit permissions
|
|
2115
2458
|
* Returns a NonPaginatedResponse with data and totalCount when no pagination parameters are provided,
|
|
@@ -2117,7 +2460,17 @@ interface TaskServiceModel {
|
|
|
2117
2460
|
*
|
|
2118
2461
|
* @param folderId - The folder ID to get users from
|
|
2119
2462
|
* @param options - Optional query and pagination parameters
|
|
2120
|
-
* @returns Promise resolving to NonPaginatedResponse or a
|
|
2463
|
+
* @returns Promise resolving to either an array of users NonPaginatedResponse<UserLoginInfo> or a PaginatedResponse<UserLoginInfo> when pagination options are used.
|
|
2464
|
+
* {@link UserLoginInfo}
|
|
2465
|
+
* @example
|
|
2466
|
+
* ```typescript
|
|
2467
|
+
* // Get users from a folder
|
|
2468
|
+
* const users = await sdk.tasks.getUsers(<folderId>);
|
|
2469
|
+
*
|
|
2470
|
+
* // Access user properties
|
|
2471
|
+
* console.log(users.items[0].name);
|
|
2472
|
+
* console.log(users.items[0].emailAddress);
|
|
2473
|
+
* ```
|
|
2121
2474
|
*/
|
|
2122
2475
|
getUsers<T extends TaskGetUsersOptions = TaskGetUsersOptions>(folderId: number, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<UserLoginInfo> : NonPaginatedResponse<UserLoginInfo>>;
|
|
2123
2476
|
}
|
|
@@ -2236,32 +2589,23 @@ interface CaseInstancesServiceModel {
|
|
|
2236
2589
|
* <folderKey>
|
|
2237
2590
|
* );
|
|
2238
2591
|
*
|
|
2239
|
-
*
|
|
2240
|
-
* console.log(`Instance ${result.data.instanceId} now has status: ${result.data.status}`);
|
|
2241
|
-
* }
|
|
2592
|
+
* or
|
|
2242
2593
|
*
|
|
2243
|
-
*
|
|
2244
|
-
* const result = await sdk.maestro.cases.instances.close(
|
|
2594
|
+
* const instance = await sdk.maestro.cases.instances.getById(
|
|
2245
2595
|
* <instanceId>,
|
|
2246
|
-
* <folderKey
|
|
2247
|
-
* { comment: <comment> }
|
|
2596
|
+
* <folderKey>
|
|
2248
2597
|
* );
|
|
2598
|
+
* const result = await instance.close();
|
|
2249
2599
|
*
|
|
2250
|
-
*
|
|
2251
|
-
*
|
|
2252
|
-
*
|
|
2600
|
+
* console.log(`Closed: ${result.success}`);
|
|
2601
|
+
*
|
|
2602
|
+
* // Close with a comment
|
|
2603
|
+
* const result = await instance.close({
|
|
2604
|
+
* comment: 'Closing due to invalid input data'
|
|
2253
2605
|
* });
|
|
2254
2606
|
*
|
|
2255
|
-
*
|
|
2256
|
-
*
|
|
2257
|
-
* instance.instanceId,
|
|
2258
|
-
* instance.folderKey,
|
|
2259
|
-
* { comment: <comment> }
|
|
2260
|
-
* );
|
|
2261
|
-
*
|
|
2262
|
-
* if (result.success) {
|
|
2263
|
-
* console.log(`Closed instance: ${result.data.instanceId}`);
|
|
2264
|
-
* }
|
|
2607
|
+
* if (result.success) {
|
|
2608
|
+
* console.log(`Instance ${result.data.instanceId} status: ${result.data.status}`);
|
|
2265
2609
|
* }
|
|
2266
2610
|
* ```
|
|
2267
2611
|
*/
|
|
@@ -2394,6 +2738,25 @@ interface CaseInstanceMethods {
|
|
|
2394
2738
|
* @returns Promise resolving to operation result
|
|
2395
2739
|
*/
|
|
2396
2740
|
resume(options?: CaseInstanceOperationOptions): Promise<OperationResponse<CaseInstanceOperationResponse>>;
|
|
2741
|
+
/**
|
|
2742
|
+
* Gets execution history for this case instance
|
|
2743
|
+
*
|
|
2744
|
+
* @returns Promise resolving to instance execution history
|
|
2745
|
+
*/
|
|
2746
|
+
getExecutionHistory(): Promise<CaseInstanceExecutionHistoryResponse>;
|
|
2747
|
+
/**
|
|
2748
|
+
* Gets stages and their associated tasks for this case instance
|
|
2749
|
+
*
|
|
2750
|
+
* @returns Promise resolving to an array of case stages with their tasks and status
|
|
2751
|
+
*/
|
|
2752
|
+
getStages(): Promise<CaseGetStageResponse[]>;
|
|
2753
|
+
/**
|
|
2754
|
+
* Gets human in the loop tasks associated with this case instance
|
|
2755
|
+
*
|
|
2756
|
+
* @param options - Optional filtering and pagination options
|
|
2757
|
+
* @returns Promise resolving to human in the loop tasks associated with the case instance
|
|
2758
|
+
*/
|
|
2759
|
+
getActionTasks<T extends TaskGetAllOptions = TaskGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<TaskGetResponse> : NonPaginatedResponse<TaskGetResponse>>;
|
|
2397
2760
|
}
|
|
2398
2761
|
type CaseInstanceGetResponse = RawCaseInstanceGetResponse & CaseInstanceMethods;
|
|
2399
2762
|
/**
|
|
@@ -2409,6 +2772,7 @@ declare function createCaseInstanceWithMethods(instanceData: RawCaseInstanceGetR
|
|
|
2409
2772
|
* Service for interacting with Maestro Processes
|
|
2410
2773
|
*/
|
|
2411
2774
|
declare class MaestroProcessesService extends BaseService implements MaestroProcessesServiceModel {
|
|
2775
|
+
private processInstancesService;
|
|
2412
2776
|
/**
|
|
2413
2777
|
* @hideconstructor
|
|
2414
2778
|
*/
|
|
@@ -2432,6 +2796,10 @@ declare class MaestroProcessesService extends BaseService implements MaestroProc
|
|
|
2432
2796
|
* ```
|
|
2433
2797
|
*/
|
|
2434
2798
|
getAll(): Promise<MaestroProcessGetAllResponse[]>;
|
|
2799
|
+
/**
|
|
2800
|
+
* Get incidents for a specific process
|
|
2801
|
+
*/
|
|
2802
|
+
getIncidents(processKey: string, folderKey: string): Promise<ProcessIncidentGetResponse[]>;
|
|
2435
2803
|
}
|
|
2436
2804
|
|
|
2437
2805
|
declare class ProcessInstancesService extends BaseService implements ProcessInstancesServiceModel {
|
|
@@ -2550,6 +2918,39 @@ declare class ProcessInstancesService extends BaseService implements ProcessInst
|
|
|
2550
2918
|
* @returns Promise<ProcessInstanceGetVariablesResponse>
|
|
2551
2919
|
*/
|
|
2552
2920
|
getVariables(instanceId: string, folderKey: string, options?: ProcessInstanceGetVariablesOptions): Promise<ProcessInstanceGetVariablesResponse>;
|
|
2921
|
+
/**
|
|
2922
|
+
* Get incidents for a process instance
|
|
2923
|
+
* @param instanceId The ID of the instance to get incidents for
|
|
2924
|
+
* @param folderKey The folder key for authorization
|
|
2925
|
+
* @returns Promise<ProcessIncidentGetResponse[]>
|
|
2926
|
+
*/
|
|
2927
|
+
getIncidents(instanceId: string, folderKey: string): Promise<ProcessIncidentGetResponse[]>;
|
|
2928
|
+
}
|
|
2929
|
+
|
|
2930
|
+
/**
|
|
2931
|
+
* Service class for Maestro Process Incidents
|
|
2932
|
+
*/
|
|
2933
|
+
declare class ProcessIncidentsService extends BaseService implements ProcessIncidentsServiceModel {
|
|
2934
|
+
/**
|
|
2935
|
+
* Get all process incidents across all folders
|
|
2936
|
+
*
|
|
2937
|
+
* @returns Promise resolving to array of process incident
|
|
2938
|
+
* {@link ProcessIncidentGetAllResponse}
|
|
2939
|
+
* @example
|
|
2940
|
+
* ```typescript
|
|
2941
|
+
* // Get all process incidents across all folders
|
|
2942
|
+
* const incidents = await sdk.maestro.processes.incidents.getAll();
|
|
2943
|
+
*
|
|
2944
|
+
* // Access process incident information
|
|
2945
|
+
* for (const incident of incidents) {
|
|
2946
|
+
* console.log(`Process: ${incident.processKey}`);
|
|
2947
|
+
* console.log(`Error: ${incident.errorMessage}`);
|
|
2948
|
+
* console.log(`Count: ${incident.count}`);
|
|
2949
|
+
* console.log(`First occurrence: ${incident.firstOccuranceTime}`);
|
|
2950
|
+
* }
|
|
2951
|
+
* ```
|
|
2952
|
+
*/
|
|
2953
|
+
getAll(): Promise<ProcessIncidentGetAllResponse[]>;
|
|
2553
2954
|
}
|
|
2554
2955
|
|
|
2555
2956
|
/**
|
|
@@ -3022,15 +3423,6 @@ interface BucketGetUriOptions extends BaseOptions {
|
|
|
3022
3423
|
* Request options for getting a read URI for a file in a bucket
|
|
3023
3424
|
*/
|
|
3024
3425
|
type BucketGetReadUriOptions = BucketGetUriOptions;
|
|
3025
|
-
/**
|
|
3026
|
-
* Request options for getting a write URI for a file in a bucket
|
|
3027
|
-
*/
|
|
3028
|
-
interface BucketGetWriteUriOptions extends BucketGetUriOptions {
|
|
3029
|
-
/**
|
|
3030
|
-
* ContentType for S3 access policy
|
|
3031
|
-
*/
|
|
3032
|
-
contentType?: string;
|
|
3033
|
-
}
|
|
3034
3426
|
/**
|
|
3035
3427
|
* Request options for getting files in a bucket
|
|
3036
3428
|
*/
|
|
@@ -3098,11 +3490,6 @@ interface BucketUploadFileOptions {
|
|
|
3098
3490
|
* File content to upload
|
|
3099
3491
|
*/
|
|
3100
3492
|
content: Blob | Buffer | File;
|
|
3101
|
-
/**
|
|
3102
|
-
* Optional MIME type of the file
|
|
3103
|
-
* If not provided, it will be auto-detected
|
|
3104
|
-
*/
|
|
3105
|
-
contentType?: string;
|
|
3106
3493
|
}
|
|
3107
3494
|
/**
|
|
3108
3495
|
* Response from file upload operations
|
|
@@ -3246,14 +3633,13 @@ interface BucketServiceModel {
|
|
|
3246
3633
|
* content: file
|
|
3247
3634
|
* });
|
|
3248
3635
|
*
|
|
3249
|
-
* // In Node env with
|
|
3636
|
+
* // In Node env with Buffer
|
|
3250
3637
|
* const buffer = Buffer.from('file content');
|
|
3251
3638
|
* const result = await sdk.buckets.uploadFile({
|
|
3252
3639
|
* bucketId: <bucketId>,
|
|
3253
3640
|
* folderId: <folderId>,
|
|
3254
3641
|
* path: '/folder/example.txt',
|
|
3255
3642
|
* content: buffer,
|
|
3256
|
-
* contentType: 'text/plain'
|
|
3257
3643
|
* });
|
|
3258
3644
|
* ```
|
|
3259
3645
|
*/
|
|
@@ -3370,36 +3756,38 @@ declare class BucketService extends FolderScopedService implements BucketService
|
|
|
3370
3756
|
* content: file
|
|
3371
3757
|
* });
|
|
3372
3758
|
*
|
|
3373
|
-
* // In Node env with
|
|
3759
|
+
* // In Node env with Buffer
|
|
3374
3760
|
* const buffer = Buffer.from('file content');
|
|
3375
3761
|
* const result = await sdk.buckets.uploadFile({
|
|
3376
3762
|
* bucketId: 123,
|
|
3377
3763
|
* folderId: 456,
|
|
3378
3764
|
* path: '/folder/example.txt',
|
|
3379
|
-
* content: buffer
|
|
3380
|
-
* contentType: 'text/plain'
|
|
3765
|
+
* content: buffer
|
|
3381
3766
|
* });
|
|
3382
3767
|
* ```
|
|
3383
3768
|
*/
|
|
3384
3769
|
uploadFile(options: BucketUploadFileOptions): Promise<BucketUploadResponse>;
|
|
3385
3770
|
/**
|
|
3386
|
-
*
|
|
3387
|
-
* Uses a hybrid approach:
|
|
3388
|
-
* 1. Checks Blob/File type if available (browser)
|
|
3389
|
-
* 2. Uses content-based detection with file-type (primarily Node.js)
|
|
3390
|
-
* 3. Falls back to extension-based detection with mime-types
|
|
3391
|
-
* 4. Finally defaults to application/octet-stream
|
|
3771
|
+
* Gets a direct download URL for a file in the bucket
|
|
3392
3772
|
*
|
|
3393
|
-
* @param
|
|
3394
|
-
* @
|
|
3395
|
-
*
|
|
3773
|
+
* @param options - Contains bucketId, folderId, file path and optional expiry time
|
|
3774
|
+
* @returns Promise resolving to blob file access information
|
|
3775
|
+
*
|
|
3776
|
+
* @example
|
|
3777
|
+
* ```typescript
|
|
3778
|
+
* // Get download URL for a file
|
|
3779
|
+
* const fileAccess = await sdk.buckets.getReadUri({
|
|
3780
|
+
* bucketId: 123,
|
|
3781
|
+
* folderId: 456,
|
|
3782
|
+
* path: '/folder/file.pdf'
|
|
3783
|
+
* });
|
|
3784
|
+
* ```
|
|
3396
3785
|
*/
|
|
3397
|
-
|
|
3786
|
+
getReadUri(options: BucketGetReadUriOptions): Promise<BucketGetUriResponse>;
|
|
3398
3787
|
/**
|
|
3399
3788
|
* Uploads content to the provided URI
|
|
3400
3789
|
* @param uriResponse - Response from getWriteUri containing URL and headers
|
|
3401
3790
|
* @param content - The content to upload
|
|
3402
|
-
* @param contentType - The content type of the file
|
|
3403
3791
|
* @returns The response from the upload request with status info
|
|
3404
3792
|
*/
|
|
3405
3793
|
private _uploadToUri;
|
|
@@ -3413,27 +3801,10 @@ declare class BucketService extends FolderScopedService implements BucketService
|
|
|
3413
3801
|
* @returns Promise resolving to blob file access information
|
|
3414
3802
|
*/
|
|
3415
3803
|
private _getUri;
|
|
3416
|
-
/**
|
|
3417
|
-
* Gets a direct download URL for a file in the bucket
|
|
3418
|
-
*
|
|
3419
|
-
* @param options - Contains bucketId, folderId, file path and optional expiry time
|
|
3420
|
-
* @returns Promise resolving to blob file access information
|
|
3421
|
-
*
|
|
3422
|
-
* @example
|
|
3423
|
-
* ```typescript
|
|
3424
|
-
* // Get download URL for a file
|
|
3425
|
-
* const fileAccess = await sdk.buckets.getReadUri({
|
|
3426
|
-
* bucketId: 123,
|
|
3427
|
-
* folderId: 456,
|
|
3428
|
-
* path: '/folder/file.pdf'
|
|
3429
|
-
* });
|
|
3430
|
-
* ```
|
|
3431
|
-
*/
|
|
3432
|
-
getReadUri(options: BucketGetReadUriOptions): Promise<BucketGetUriResponse>;
|
|
3433
3804
|
/**
|
|
3434
3805
|
* Gets a direct upload URL for a file in the bucket
|
|
3435
3806
|
*
|
|
3436
|
-
* @param options - Contains bucketId, folderId, file path, optional expiry time
|
|
3807
|
+
* @param options - Contains bucketId, folderId, file path, optional expiry time
|
|
3437
3808
|
* @returns Promise resolving to blob file access information
|
|
3438
3809
|
*/
|
|
3439
3810
|
private _getWriteUri;
|
|
@@ -4161,10 +4532,11 @@ declare class TaskService extends BaseService implements TaskServiceModel {
|
|
|
4161
4532
|
getAll<T extends TaskGetAllOptions = TaskGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<TaskGetResponse> : NonPaginatedResponse<TaskGetResponse>>;
|
|
4162
4533
|
/**
|
|
4163
4534
|
* Gets a task by ID
|
|
4535
|
+
* IMPORTANT: For form tasks, folderId must be provided.
|
|
4164
4536
|
*
|
|
4165
4537
|
* @param id - The ID of the task to retrieve
|
|
4166
4538
|
* @param options - Optional query parameters
|
|
4167
|
-
* @param folderId - Optional folder ID
|
|
4539
|
+
* @param folderId - Optional folder ID (REQUIRED for form tasks)
|
|
4168
4540
|
* @returns Promise resolving to the task (form tasks will return form-specific data)
|
|
4169
4541
|
*
|
|
4170
4542
|
* @example
|
|
@@ -4180,7 +4552,6 @@ declare class TaskService extends BaseService implements TaskServiceModel {
|
|
|
4180
4552
|
* Assigns tasks to users
|
|
4181
4553
|
*
|
|
4182
4554
|
* @param taskAssignments - Single task assignment or array of task assignments
|
|
4183
|
-
* @param folderId - Optional folder ID
|
|
4184
4555
|
* @returns Promise resolving to array of task assignment results
|
|
4185
4556
|
*
|
|
4186
4557
|
* @example
|
|
@@ -4210,12 +4581,11 @@ declare class TaskService extends BaseService implements TaskServiceModel {
|
|
|
4210
4581
|
* ]);
|
|
4211
4582
|
* ```
|
|
4212
4583
|
*/
|
|
4213
|
-
assign(taskAssignments: TaskAssignmentOptions | TaskAssignmentOptions[]
|
|
4584
|
+
assign(taskAssignments: TaskAssignmentOptions | TaskAssignmentOptions[]): Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>;
|
|
4214
4585
|
/**
|
|
4215
4586
|
* Reassigns tasks to new users
|
|
4216
4587
|
*
|
|
4217
4588
|
* @param taskAssignments - Single task assignment or array of task assignments
|
|
4218
|
-
* @param folderId - Optional folder ID
|
|
4219
4589
|
* @returns Promise resolving to array of task assignment results
|
|
4220
4590
|
*
|
|
4221
4591
|
* @example
|
|
@@ -4245,12 +4615,11 @@ declare class TaskService extends BaseService implements TaskServiceModel {
|
|
|
4245
4615
|
* ]);
|
|
4246
4616
|
* ```
|
|
4247
4617
|
*/
|
|
4248
|
-
reassign(taskAssignments: TaskAssignmentOptions | TaskAssignmentOptions[]
|
|
4618
|
+
reassign(taskAssignments: TaskAssignmentOptions | TaskAssignmentOptions[]): Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>;
|
|
4249
4619
|
/**
|
|
4250
4620
|
* Unassigns tasks (removes current assignees)
|
|
4251
4621
|
*
|
|
4252
4622
|
* @param taskIds - Single task ID or array of task IDs to unassign
|
|
4253
|
-
* @param folderId - Optional folder ID
|
|
4254
4623
|
* @returns Promise resolving to array of task assignment results
|
|
4255
4624
|
*
|
|
4256
4625
|
* @example
|
|
@@ -4262,33 +4631,34 @@ declare class TaskService extends BaseService implements TaskServiceModel {
|
|
|
4262
4631
|
* const result = await sdk.tasks.unassign([123, 456, 789]);
|
|
4263
4632
|
* ```
|
|
4264
4633
|
*/
|
|
4265
|
-
unassign(taskIds: number | number[]
|
|
4634
|
+
unassign(taskIds: number | number[]): Promise<OperationResponse<{
|
|
4266
4635
|
taskId: number;
|
|
4267
4636
|
}[] | TaskAssignmentResponse[]>>;
|
|
4268
4637
|
/**
|
|
4269
4638
|
* Completes a task with the specified type and data
|
|
4270
4639
|
*
|
|
4271
|
-
* @param
|
|
4272
|
-
* @param options - The completion options
|
|
4640
|
+
* @param options - The completion options including task type, taskId, data, and action
|
|
4273
4641
|
* @param folderId - Required folder ID
|
|
4274
|
-
* @returns Promise resolving to
|
|
4642
|
+
* @returns Promise resolving to completion result
|
|
4275
4643
|
*
|
|
4276
4644
|
* @example
|
|
4277
4645
|
* ```typescript
|
|
4278
4646
|
* // Complete an app task
|
|
4279
|
-
* await sdk.tasks.complete(
|
|
4647
|
+
* await sdk.tasks.complete({
|
|
4648
|
+
* type: TaskType.App,
|
|
4280
4649
|
* taskId: 456,
|
|
4281
4650
|
* data: {},
|
|
4282
4651
|
* action: "submit"
|
|
4283
4652
|
* }, 123); // folderId is required
|
|
4284
4653
|
*
|
|
4285
4654
|
* // Complete an external task
|
|
4286
|
-
* await sdk.tasks.complete(
|
|
4655
|
+
* await sdk.tasks.complete({
|
|
4656
|
+
* type: TaskType.External,
|
|
4287
4657
|
* taskId: 789
|
|
4288
4658
|
* }, 123); // folderId is required
|
|
4289
4659
|
* ```
|
|
4290
4660
|
*/
|
|
4291
|
-
complete(
|
|
4661
|
+
complete(options: TaskCompletionOptions, folderId: number): Promise<OperationResponse<TaskCompletionOptions>>;
|
|
4292
4662
|
/**
|
|
4293
4663
|
* Gets a form task by ID (private method)
|
|
4294
4664
|
*
|
|
@@ -4306,6 +4676,13 @@ declare class TaskService extends BaseService implements TaskServiceModel {
|
|
|
4306
4676
|
* @private
|
|
4307
4677
|
*/
|
|
4308
4678
|
private processTaskParameters;
|
|
4679
|
+
/**
|
|
4680
|
+
* Adds default expand parameters to options
|
|
4681
|
+
* @param options - The options object to add default expand to
|
|
4682
|
+
* @returns Options with default expand parameters added
|
|
4683
|
+
* @private
|
|
4684
|
+
*/
|
|
4685
|
+
private addDefaultExpand;
|
|
4309
4686
|
}
|
|
4310
4687
|
|
|
4311
4688
|
interface BaseConfig {
|
|
@@ -4373,6 +4750,10 @@ declare class UiPath {
|
|
|
4373
4750
|
* Access to Process Instances service
|
|
4374
4751
|
*/
|
|
4375
4752
|
instances: ProcessInstancesService;
|
|
4753
|
+
/**
|
|
4754
|
+
* Access to Process Incidents service
|
|
4755
|
+
*/
|
|
4756
|
+
incidents: ProcessIncidentsService;
|
|
4376
4757
|
};
|
|
4377
4758
|
/**
|
|
4378
4759
|
* Access to Maestro Cases service
|
|
@@ -4691,7 +5072,7 @@ declare const telemetryClient: TelemetryClient;
|
|
|
4691
5072
|
* SDK Telemetry constants
|
|
4692
5073
|
*/
|
|
4693
5074
|
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";
|
|
4694
|
-
declare const SDK_VERSION = "1.0.0-beta.
|
|
5075
|
+
declare const SDK_VERSION = "1.0.0-beta.15";
|
|
4695
5076
|
declare const VERSION = "Version";
|
|
4696
5077
|
declare const SERVICE = "Service";
|
|
4697
5078
|
declare const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
|
|
@@ -4706,5 +5087,5 @@ declare const SDK_LOGGER_NAME = "uipath-ts-sdk-telemetry";
|
|
|
4706
5087
|
declare const SDK_RUN_EVENT = "Sdk.Run";
|
|
4707
5088
|
declare const UNKNOWN = "";
|
|
4708
5089
|
|
|
4709
|
-
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, EntityFieldDataType, EntityType, ErrorType, EscalationActionType, EscalationRecipientScope, EscalationTriggerType, FieldDisplayType, HttpStatus, JobPriority, JobState, JobType, JoinType, MAX_PAGE_SIZE, NetworkError, NotFoundError, PackageSourceType, PackageType, 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, createTaskWithMethods, getErrorDetails, getLimitedPageSize, isAuthenticationError, isAuthorizationError, isNetworkError, isNotFoundError, isRateLimitError, isServerError, isUiPathError, isValidationError, telemetryClient, track, trackEvent };
|
|
4710
|
-
export type { ArgumentMetadata, AssetGetAllOptions, AssetGetByIdOptions, AssetGetResponse, AssetServiceModel, BaseConfig, BaseOptions, BlobItem, BodyOptions, BpmnXmlString, BucketGetAllOptions, BucketGetByIdOptions, BucketGetFileMetaDataOptions, BucketGetFileMetaDataResponse, BucketGetFileMetaDataWithPaginationOptions, BucketGetReadUriOptions, BucketGetResponse, BucketGetUriOptions, BucketGetUriResponse,
|
|
5090
|
+
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 };
|
|
5091
|
+
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 };
|