@5minds/processcube_engine_client 4.3.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.
Files changed (164) hide show
  1. package/.prettierrc.json +5 -0
  2. package/LICENSE +21 -0
  3. package/README.md +283 -0
  4. package/dist/Client.d.ts +44 -0
  5. package/dist/ClientFactory.d.ts +21 -0
  6. package/dist/Clients/AnonymousSessionHttpClient.d.ts +7 -0
  7. package/dist/Clients/ApplicationInfoHttpClient.d.ts +10 -0
  8. package/dist/Clients/BaseClient.d.ts +26 -0
  9. package/dist/Clients/CorrelationHttpClient.d.ts +15 -0
  10. package/dist/Clients/CronjobHttpClient.d.ts +29 -0
  11. package/dist/Clients/DataObjectInstanceHttpClient.d.ts +10 -0
  12. package/dist/Clients/EmptyActivityHttpClient.d.ts +22 -0
  13. package/dist/Clients/EventHttpClient.d.ts +55 -0
  14. package/dist/Clients/ExternalTaskApiHttpClient.d.ts +19 -0
  15. package/dist/Clients/ExternalTaskHttpClient.d.ts +12 -0
  16. package/dist/Clients/FlowNodeInstanceHttpClient.d.ts +23 -0
  17. package/dist/Clients/Lib/Mappers.d.ts +20 -0
  18. package/dist/Clients/Lib/SocketIoManager.d.ts +36 -0
  19. package/dist/Clients/ManualTaskHttpClient.d.ts +22 -0
  20. package/dist/Clients/NotificationHttpClient.d.ts +178 -0
  21. package/dist/Clients/ProcessDefinitionHttpClient.d.ts +31 -0
  22. package/dist/Clients/ProcessDefinitionHttpClientNode.d.ts +8 -0
  23. package/dist/Clients/ProcessInstanceHttpClient.d.ts +23 -0
  24. package/dist/Clients/ProcessModelHttpClient.d.ts +29 -0
  25. package/dist/Clients/UserMetadataStorageHttpClient.d.ts +22 -0
  26. package/dist/Clients/UserTaskHttpClient.d.ts +32 -0
  27. package/dist/Clients/index.d.ts +18 -0
  28. package/dist/ExternalTaskWorker.d.ts +32 -0
  29. package/dist/HttpClient.d.ts +26 -0
  30. package/dist/Types/CallbackTypes.d.ts +39 -0
  31. package/dist/Types/IExternalTaskWorker.d.ts +34 -0
  32. package/dist/Types/RestSettings.d.ts +674 -0
  33. package/dist/Types/SocketSettings.d.ts +59 -0
  34. package/dist/Types/index.d.ts +15 -0
  35. package/dist/amd/Client.js +104 -0
  36. package/dist/amd/Client.js.map +1 -0
  37. package/dist/amd/ClientFactory.js +56 -0
  38. package/dist/amd/ClientFactory.js.map +1 -0
  39. package/dist/amd/Clients/AnonymousSessionHttpClient.js +29 -0
  40. package/dist/amd/Clients/AnonymousSessionHttpClient.js.map +1 -0
  41. package/dist/amd/Clients/ApplicationInfoHttpClient.js +30 -0
  42. package/dist/amd/Clients/ApplicationInfoHttpClient.js.map +1 -0
  43. package/dist/amd/Clients/BaseClient.js +128 -0
  44. package/dist/amd/Clients/BaseClient.js.map +1 -0
  45. package/dist/amd/Clients/CorrelationHttpClient.js +29 -0
  46. package/dist/amd/Clients/CorrelationHttpClient.js.map +1 -0
  47. package/dist/amd/Clients/CronjobHttpClient.js +55 -0
  48. package/dist/amd/Clients/CronjobHttpClient.js.map +1 -0
  49. package/dist/amd/Clients/DataObjectInstanceHttpClient.js +19 -0
  50. package/dist/amd/Clients/DataObjectInstanceHttpClient.js.map +1 -0
  51. package/dist/amd/Clients/EmptyActivityHttpClient.js +38 -0
  52. package/dist/amd/Clients/EmptyActivityHttpClient.js.map +1 -0
  53. package/dist/amd/Clients/EventHttpClient.js +68 -0
  54. package/dist/amd/Clients/EventHttpClient.js.map +1 -0
  55. package/dist/amd/Clients/ExternalTaskApiHttpClient.js +86 -0
  56. package/dist/amd/Clients/ExternalTaskApiHttpClient.js.map +1 -0
  57. package/dist/amd/Clients/ExternalTaskHttpClient.js +27 -0
  58. package/dist/amd/Clients/ExternalTaskHttpClient.js.map +1 -0
  59. package/dist/amd/Clients/FlowNodeInstanceHttpClient.js +55 -0
  60. package/dist/amd/Clients/FlowNodeInstanceHttpClient.js.map +1 -0
  61. package/dist/amd/Clients/Lib/Mappers.js +290 -0
  62. package/dist/amd/Clients/Lib/Mappers.js.map +1 -0
  63. package/dist/amd/Clients/Lib/SocketIoManager.js +114 -0
  64. package/dist/amd/Clients/Lib/SocketIoManager.js.map +1 -0
  65. package/dist/amd/Clients/ManualTaskHttpClient.js +38 -0
  66. package/dist/amd/Clients/ManualTaskHttpClient.js.map +1 -0
  67. package/dist/amd/Clients/NotificationHttpClient.js +144 -0
  68. package/dist/amd/Clients/NotificationHttpClient.js.map +1 -0
  69. package/dist/amd/Clients/ProcessDefinitionHttpClient.js +92 -0
  70. package/dist/amd/Clients/ProcessDefinitionHttpClient.js.map +1 -0
  71. package/dist/amd/Clients/ProcessDefinitionHttpClientNode.js +25 -0
  72. package/dist/amd/Clients/ProcessDefinitionHttpClientNode.js.map +1 -0
  73. package/dist/amd/Clients/ProcessInstanceHttpClient.js +91 -0
  74. package/dist/amd/Clients/ProcessInstanceHttpClient.js.map +1 -0
  75. package/dist/amd/Clients/ProcessModelHttpClient.js +93 -0
  76. package/dist/amd/Clients/ProcessModelHttpClient.js.map +1 -0
  77. package/dist/amd/Clients/UserMetadataStorageHttpClient.js +42 -0
  78. package/dist/amd/Clients/UserMetadataStorageHttpClient.js.map +1 -0
  79. package/dist/amd/Clients/UserTaskHttpClient.js +56 -0
  80. package/dist/amd/Clients/UserTaskHttpClient.js.map +1 -0
  81. package/dist/amd/Clients/index.js +37 -0
  82. package/dist/amd/Clients/index.js.map +1 -0
  83. package/dist/amd/ExternalTaskWorker.js +141 -0
  84. package/dist/amd/ExternalTaskWorker.js.map +1 -0
  85. package/dist/amd/HttpClient.js +124 -0
  86. package/dist/amd/HttpClient.js.map +1 -0
  87. package/dist/amd/Types/CallbackTypes.js +5 -0
  88. package/dist/amd/Types/CallbackTypes.js.map +1 -0
  89. package/dist/amd/Types/IExternalTaskWorker.js +5 -0
  90. package/dist/amd/Types/IExternalTaskWorker.js.map +1 -0
  91. package/dist/amd/Types/RestSettings.js +709 -0
  92. package/dist/amd/Types/RestSettings.js.map +1 -0
  93. package/dist/amd/Types/SocketSettings.js +70 -0
  94. package/dist/amd/Types/SocketSettings.js.map +1 -0
  95. package/dist/amd/Types/index.js +30 -0
  96. package/dist/amd/Types/index.js.map +1 -0
  97. package/dist/amd/index.js +29 -0
  98. package/dist/amd/index.js.map +1 -0
  99. package/dist/commonjs/Client.js +104 -0
  100. package/dist/commonjs/Client.js.map +1 -0
  101. package/dist/commonjs/ClientFactory.js +56 -0
  102. package/dist/commonjs/ClientFactory.js.map +1 -0
  103. package/dist/commonjs/Clients/AnonymousSessionHttpClient.js +30 -0
  104. package/dist/commonjs/Clients/AnonymousSessionHttpClient.js.map +1 -0
  105. package/dist/commonjs/Clients/ApplicationInfoHttpClient.js +30 -0
  106. package/dist/commonjs/Clients/ApplicationInfoHttpClient.js.map +1 -0
  107. package/dist/commonjs/Clients/BaseClient.js +128 -0
  108. package/dist/commonjs/Clients/BaseClient.js.map +1 -0
  109. package/dist/commonjs/Clients/CorrelationHttpClient.js +29 -0
  110. package/dist/commonjs/Clients/CorrelationHttpClient.js.map +1 -0
  111. package/dist/commonjs/Clients/CronjobHttpClient.js +56 -0
  112. package/dist/commonjs/Clients/CronjobHttpClient.js.map +1 -0
  113. package/dist/commonjs/Clients/DataObjectInstanceHttpClient.js +20 -0
  114. package/dist/commonjs/Clients/DataObjectInstanceHttpClient.js.map +1 -0
  115. package/dist/commonjs/Clients/EmptyActivityHttpClient.js +40 -0
  116. package/dist/commonjs/Clients/EmptyActivityHttpClient.js.map +1 -0
  117. package/dist/commonjs/Clients/EventHttpClient.js +70 -0
  118. package/dist/commonjs/Clients/EventHttpClient.js.map +1 -0
  119. package/dist/commonjs/Clients/ExternalTaskApiHttpClient.js +87 -0
  120. package/dist/commonjs/Clients/ExternalTaskApiHttpClient.js.map +1 -0
  121. package/dist/commonjs/Clients/ExternalTaskHttpClient.js +26 -0
  122. package/dist/commonjs/Clients/ExternalTaskHttpClient.js.map +1 -0
  123. package/dist/commonjs/Clients/FlowNodeInstanceHttpClient.js +56 -0
  124. package/dist/commonjs/Clients/FlowNodeInstanceHttpClient.js.map +1 -0
  125. package/dist/commonjs/Clients/Lib/Mappers.js +289 -0
  126. package/dist/commonjs/Clients/Lib/Mappers.js.map +1 -0
  127. package/dist/commonjs/Clients/Lib/SocketIoManager.js +116 -0
  128. package/dist/commonjs/Clients/Lib/SocketIoManager.js.map +1 -0
  129. package/dist/commonjs/Clients/ManualTaskHttpClient.js +40 -0
  130. package/dist/commonjs/Clients/ManualTaskHttpClient.js.map +1 -0
  131. package/dist/commonjs/Clients/NotificationHttpClient.js +144 -0
  132. package/dist/commonjs/Clients/NotificationHttpClient.js.map +1 -0
  133. package/dist/commonjs/Clients/ProcessDefinitionHttpClient.js +94 -0
  134. package/dist/commonjs/Clients/ProcessDefinitionHttpClient.js.map +1 -0
  135. package/dist/commonjs/Clients/ProcessDefinitionHttpClientNode.js +25 -0
  136. package/dist/commonjs/Clients/ProcessDefinitionHttpClientNode.js.map +1 -0
  137. package/dist/commonjs/Clients/ProcessInstanceHttpClient.js +93 -0
  138. package/dist/commonjs/Clients/ProcessInstanceHttpClient.js.map +1 -0
  139. package/dist/commonjs/Clients/ProcessModelHttpClient.js +95 -0
  140. package/dist/commonjs/Clients/ProcessModelHttpClient.js.map +1 -0
  141. package/dist/commonjs/Clients/UserMetadataStorageHttpClient.js +42 -0
  142. package/dist/commonjs/Clients/UserMetadataStorageHttpClient.js.map +1 -0
  143. package/dist/commonjs/Clients/UserTaskHttpClient.js +58 -0
  144. package/dist/commonjs/Clients/UserTaskHttpClient.js.map +1 -0
  145. package/dist/commonjs/Clients/index.js +35 -0
  146. package/dist/commonjs/Clients/index.js.map +1 -0
  147. package/dist/commonjs/ExternalTaskWorker.js +142 -0
  148. package/dist/commonjs/ExternalTaskWorker.js.map +1 -0
  149. package/dist/commonjs/HttpClient.js +124 -0
  150. package/dist/commonjs/HttpClient.js.map +1 -0
  151. package/dist/commonjs/Types/CallbackTypes.js +3 -0
  152. package/dist/commonjs/Types/CallbackTypes.js.map +1 -0
  153. package/dist/commonjs/Types/IExternalTaskWorker.js +3 -0
  154. package/dist/commonjs/Types/IExternalTaskWorker.js.map +1 -0
  155. package/dist/commonjs/Types/RestSettings.js +707 -0
  156. package/dist/commonjs/Types/RestSettings.js.map +1 -0
  157. package/dist/commonjs/Types/SocketSettings.js +68 -0
  158. package/dist/commonjs/Types/SocketSettings.js.map +1 -0
  159. package/dist/commonjs/Types/index.js +30 -0
  160. package/dist/commonjs/Types/index.js.map +1 -0
  161. package/dist/commonjs/index.js +28 -0
  162. package/dist/commonjs/index.js.map +1 -0
  163. package/dist/index.d.ts +6 -0
  164. package/package.json +43 -0
@@ -0,0 +1,709 @@
1
+ define(["require", "exports"], function (require, exports) {
2
+ "use strict";
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.restSettings = void 0;
5
+ const params = {
6
+ // Id of a Correlation.
7
+ correlationId: ':correlation_id',
8
+ // Instance Id of an EmptyActivity.
9
+ emptyActivityInstanceId: ':empty_activity_instance_id',
10
+ // Id of an Event.
11
+ eventId: ':event_id',
12
+ // Name of an Event.
13
+ eventName: ':event_name',
14
+ // Id of an External Task.
15
+ externalTaskId: ':external_task_id',
16
+ // Id of a FlowNode.
17
+ flowNodeId: ':flow_node_id',
18
+ // Id of a FlowNodeInstance.
19
+ flowNodeInstanceId: ':flow_node_instance_id',
20
+ // Id of a ManualTask.
21
+ manualTaskInstanceId: ':manual_task_instance_id',
22
+ // Instance Id of a Process.
23
+ processInstanceId: ':process_instance_id',
24
+ // Id of a ProcessModel.
25
+ processDefinitionId: ':process_definition_id',
26
+ // Id of a ProcessModel.
27
+ processModelId: ':process_model_id',
28
+ // Id of an anonymous session.
29
+ sessionId: ':session_id',
30
+ // Id of a user.
31
+ userId: ':user_id',
32
+ // Id of a UserTaskInstance.
33
+ userTaskInstanceId: ':user_task_instance_id',
34
+ // Key of a metadata value
35
+ userMetadataKey: ':user_metadata_key',
36
+ };
37
+ const paths = {
38
+ // ApplicationInfo
39
+ /**
40
+ * Gets some basic info about the host application.
41
+ * @tags ApplicationInfo
42
+ * @method get
43
+ * @responseType ApplicationInfo
44
+ */
45
+ getApplicationInfo: '/info',
46
+ /**
47
+ * Gets the address of the authority that the host application uses for claim checks.
48
+ * @tags ApplicationInfo
49
+ * @method get
50
+ * @responseType string
51
+ */
52
+ getAuthorityAddress: '/authority',
53
+ // Anonymous Sessions
54
+ /**
55
+ * Returns the anonymous session with the given ID.
56
+ * @tags AnonymousSessions
57
+ * @method get
58
+ * @responseType AnonymousSession
59
+ */
60
+ getAnonymousSessionById: `/anonymous_session/session/${params.sessionId}`,
61
+ /**
62
+ * Returns all anonymous sessions of the given User ID.
63
+ * @tags AnonymousSessions
64
+ * @method get
65
+ * @responseType Array<AnonymousSession>
66
+ */
67
+ getAnonymousSessionsByUserId: `/anonymous_session/user/${params.userId}`,
68
+ /**
69
+ * Creates a new anonymous session and returns its ID.
70
+ * @tags AnonymousSessions
71
+ * @method post
72
+ * @responseType string
73
+ */
74
+ createAnonymousSession: '/anonymous_session',
75
+ // Correlations
76
+ /**
77
+ * Gets all Correlations.
78
+ * @tags Correlations
79
+ * @method get
80
+ * @queryParams limit: number, offset: number, includeProcessInstances: boolean
81
+ * @responseType CorrelationList
82
+ */
83
+ getCorrelations: '/correlations',
84
+ /**
85
+ * Gets a Correlation by its ID.
86
+ * @tags Correlations
87
+ * @method get
88
+ * @queryParams includeProcessInstances: boolean
89
+ * @responseType Correlation
90
+ */
91
+ getCorrelationById: `/correlations/${params.correlationId}`,
92
+ // Cronjobs
93
+ /**
94
+ * Queries a list of deployed Cronjobs.
95
+ * @tags Cronjobs
96
+ * @method get
97
+ * @queryParams limit: number, offset: number, processDefinitionId: string, processModelID: string, startEventId: string, crontab: string, nextExecution: string
98
+ * @responseType DeployedCronjobList
99
+ */
100
+ getDeployedCronjobs: '/cronjobs/query',
101
+ /**
102
+ * Gets all active Cronjobs. DEPRECATED - Use "/cronjobs/query" instead
103
+ * @tags Cronjobs
104
+ * @method get
105
+ * @queryParams limit: number, offset: number
106
+ * @responseType CronjobList
107
+ */
108
+ getActiveCronjobs: '/cronjobs',
109
+ /**
110
+ * Queries a list of cronjob history entries that match the given query.
111
+ * @tags Cronjobs
112
+ * @method get
113
+ * @queryParams limit: number, offset: number: string, processDefinitionId: string, processModelId: string, startEventId: string, crontab: string, executedAt: string, createdAt: string, updatedAt: string
114
+ * @responseType CronjobHistoryList
115
+ */
116
+ getCronjobHistory: '/cronjobs/history',
117
+ /**
118
+ * Enables the given Cronjob for the given Process Model.
119
+ * @tags ProcessModels
120
+ * @method post
121
+ */
122
+ enableCronjob: `/cronjobs/process_models/${params.processModelId}/flow_node/${params.flowNodeId}/enable`,
123
+ /**
124
+ * Disables the given Cronjob for the given ProcessModel.
125
+ * @tags ProcessModels
126
+ * @method post
127
+ */
128
+ disableCronjob: `/cronjobs/process_models/${params.processModelId}/flow_node/${params.flowNodeId}/disable`,
129
+ // DataObjects
130
+ /**
131
+ * Gets the DataObjectInstances that match the given query.
132
+ * @tags DataObjectInstances
133
+ * @method get
134
+ * @queryParams limit: number, offset: number: string, dataObjectId: string, processDefinitionId: string, processModelId: string, processInstanceId: string, flowNodeInstanceId: string, createdAt: string
135
+ * @responseType DataObjectInstanceList
136
+ */
137
+ getDataObjects: '/data_object_instances/query',
138
+ // FlowNodeInstance
139
+ /**
140
+ * Gets all FlowNodeInstances that match the given query.
141
+ * @tags FlowNodeInstances
142
+ * @method get
143
+ * @queryParams limit: number, offset: number, flowNodeInstanceId: string, flowNodeId: string, flowNodeName: string, flowNodeLane: string, flowNodeType: string, eventType: string, correlationId: string, processDefinitionId: string, processModelId: string, processInstanceId: string, ownerId: string, state: string, previousFlowNodeInstanceId: string, parentProcessInstanceId: string, createdAt: string, updatedAt: string, triggeredByFlowNodeInstance: Array<string> | string | SearchQuery
144
+ * @responseType FlowNodeInstanceList
145
+ */
146
+ queryFlowNodeInstances: '/flow_node_instances',
147
+ /**
148
+ * Triggers a MessageEvent by its name.
149
+ * @tags Events
150
+ * @queryParams processInstanceId: string
151
+ * @requestBody {"required": false, "bodyType": "application/json", "contentType": {"payload": {"type": "string"}}}
152
+ * @method post
153
+ */
154
+ triggerMessageEvent: `/messages/${params.eventName}/trigger`,
155
+ /**
156
+ * Triggers a SignalEvent by its name.
157
+ * @tags Events
158
+ * @method post
159
+ * @queryParams process_instance_id: string
160
+ * @requestBody {"required": false, "bodyType": "application/json", "contentType": {}}
161
+ */
162
+ triggerSignalEvent: `/signals/${params.eventName}/trigger`,
163
+ /**
164
+ * Finishes a specific EmptyActivity by its EmptyActivityInstanceId.
165
+ * @tags EmptyActivities
166
+ * @method put
167
+ */
168
+ finishEmptyActivity: `/empty_activities/${params.emptyActivityInstanceId}/finish`,
169
+ /**
170
+ * Finishes a specific ManualTask by its ManualTaskInstanceId.
171
+ * @tags ManualTasks
172
+ * @method put
173
+ */
174
+ finishManualTask: `/manual_tasks/${params.manualTaskInstanceId}/finish`,
175
+ /**
176
+ * Finishes a specific UserTask by its UserTaskInstanceId.
177
+ * @tags UserTasks
178
+ * @method put
179
+ */
180
+ finishUserTask: `/user_tasks/${params.userTaskInstanceId}/finish`,
181
+ /**
182
+ * Reserves a UserTask for a specific User.
183
+ * @tags UserTasks
184
+ * @method put
185
+ * @requestBody {"required": true, "bodyType": "application/json", "contentType": {"actualOwnerId": {"type": "string", "required": true}}}
186
+ */
187
+ reserveUserTaskInstance: `/user_tasks/${params.userTaskInstanceId}/reserve`,
188
+ /**
189
+ * Cancels the reservation of the given UserTask instance.
190
+ * @tags UserTasks
191
+ * @method delete
192
+ */
193
+ cancelUserTaskInstanceReservation: `/user_tasks/${params.userTaskInstanceId}/cancel-reservation`,
194
+ // External Tasks
195
+ /**
196
+ * Fetches a list of all ExternalTask topics from all deployed Process Models.
197
+ * @tags ExternalTasks
198
+ * @method get
199
+ * @responseType Array<string>
200
+ */
201
+ getAllDeployedTopics: '/external_tasks/deployed_topics',
202
+ /**
203
+ * Fetches the tasks available for an ExternalTaskWorker and locks them for a defined time.
204
+ * @tags ExternalTasks
205
+ * @method post
206
+ * @requestBody {"required": true, "bodyType": "application/json", "contentType": "FetchAndLockRequestPayload", "example": "{\"workerId\": \"string\", \"topicName\": \"string | Array<string>\", \"maxTasks\": 10, \"longPollingTimeout\": 2000, \"lockDuration\": 10000, \"payloadFilter\": \"string\"}"}
207
+ * @responseType Array<ExternalTask>
208
+ */
209
+ fetchAndLockExternalTasks: '/external_tasks/fetch_and_lock',
210
+ /**
211
+ * Extends the lock duration of an ExternalTask by a given amount of time.
212
+ * @tags ExternalTasks
213
+ * @method put
214
+ * @requestBody {"required": true, "bodyType": "application/json", "contentType": "ExtendLockRequestPayload"}
215
+ */
216
+ extendExternalTaskLock: `/external_tasks/${params.externalTaskId}/extend_lock`,
217
+ /**
218
+ * DEPRECATED - Use `PUT /external_tasks/:external_task_id/error` instead.
219
+ * @tags ExternalTasks
220
+ * @method put
221
+ * @requestBody {"required": true, "bodyType": "application/json", "contentType": "HandleBpmnErrorRequestPayload"}
222
+ */
223
+ finishExternalTaskWithBpmnError: `/external_tasks/${params.externalTaskId}/handle_bpmn_error`,
224
+ /**
225
+ * DEPRECATED - Use `PUT /external_tasks/:external_task_id/error` instead.
226
+ * @tags ExternalTasks
227
+ * @method put
228
+ * @requestBody {"required": true, "bodyType": "application/json", "contentType": "HandleServiceErrorRequestPayload"}
229
+ */
230
+ finishExternalTaskWithServiceError: `/external_tasks/${params.externalTaskId}/handle_service_error`,
231
+ /**
232
+ * Finishes the given External Task with the given Error.
233
+ * @tags ExternalTasks
234
+ * @method put
235
+ * @requestBody {"required": true, "bodyType": "application/json", "contentType": "HandleServiceErrorRequestPayload"}
236
+ */
237
+ finishExternalTaskWithError: `/external_tasks/${params.externalTaskId}/error`,
238
+ /**
239
+ * Finishes the ExternalTask with the given ID.
240
+ * @tags ExternalTasks
241
+ * @method put
242
+ * @requestBody {"required": true, "bodyType": "application/json", "contentType": "FinishExternalTaskRequestPayload"}
243
+ */
244
+ finishExternalTask: `/external_tasks/${params.externalTaskId}/finish`,
245
+ // ProcessDefinition
246
+ /**
247
+ * Creates or updates a ProcessDefinition or a list of ProcessDefinitions.
248
+ * @tags ProcessDefinitions
249
+ * @method post
250
+ * @requestBody {"required": true, "bodyType": "application/json", "contentType": "PersistProcessDefinitionsPayload", "example": "{\"xml\": \"string | Array<string>\", \"overrideExisting\": true}"}
251
+ */
252
+ persistProcessDefinitions: '/process_definitions',
253
+ /**
254
+ * Gets all ProcessDefinitions the requesting user is allowed to see.
255
+ * @tags ProcessDefinitions
256
+ * @method get
257
+ * @queryParams offset: number, limit: number
258
+ * @responseType ProcessDefinitionList
259
+ */
260
+ getProcessDefinitions: '/process_definitions',
261
+ /**
262
+ * Gets a ProcessDefinition by its id.
263
+ * @tags ProcessDefinitions
264
+ * @method get
265
+ * @responseType ProcessDefinition
266
+ */
267
+ getProcessDefinitionById: `/process_definitions/${params.processDefinitionId}`,
268
+ /**
269
+ * Deletes the ProcessDefinition with the given ID.
270
+ * Per default, a Process is only flagged as deleted. To actually delete the Process and all related data, set "delete_all_related_data" to "true".
271
+ * @tags ProcessDefinitions
272
+ * @method delete
273
+ * @queryParams delete_all_related_data: boolean
274
+ */
275
+ deleteProcessDefinition: `/process_definitions/${params.processDefinitionId}`,
276
+ // ProcessModels
277
+ /**
278
+ * Gets all currently deployed Process Models.
279
+ * @tags ProcessModels
280
+ * @method get
281
+ * @responseType ProcessModelList
282
+ */
283
+ getAllProcessModels: '/process_models',
284
+ /**
285
+ * Gets a deployed Process Model by its ID.
286
+ * @tags ProcessModels
287
+ * @method get
288
+ * @responseType ProcessModel
289
+ */
290
+ getProcessModelById: `/process_models/${params.processModelId}/`,
291
+ /**
292
+ * Gets a ProcessDefinition for a given ProcessModel.
293
+ * @tags ProcessModels
294
+ * @method get
295
+ * @responseType ProcessDefinition
296
+ */
297
+ getProcessDefinitionForProcessModel: `/process_models/${params.processModelId}/process_definition`,
298
+ /**
299
+ * Starts a new instance from the given set of parameters.
300
+ * @tags ProcessModels
301
+ * @method post
302
+ * @requestBody {"required": true, "bodyType": "application/json", "contentType": "ProcessStartRequest"}
303
+ * @responseType ProcessStartResponse
304
+ */
305
+ startProcessInstance: `/process_models/${params.processModelId}/start`,
306
+ /**
307
+ * Deletes the ProcessDefinition that contains the Process Model with the given ID.
308
+ * Per default, a Process is only flagged as deleted. To actually delete the Process and all related data, set "delete_all_related_data" to "true".
309
+ * @tags ProcessModels
310
+ * @method delete
311
+ * @queryParams delete_all_related_data: boolean
312
+ */
313
+ deleteProcessDefinitionByProcessModelId: `/process_models/${params.processModelId}`,
314
+ /**
315
+ * Enables the given Process Model.
316
+ * @tags ProcessModels
317
+ * @method post
318
+ */
319
+ enableProcessModel: `/process_models/${params.processModelId}/enable`,
320
+ /**
321
+ * Disables the given Process Model.
322
+ * @tags ProcessModels
323
+ * @method post
324
+ */
325
+ disableProcessModel: `/process_models/${params.processModelId}/disable`,
326
+ // ProcessInstance
327
+ /**
328
+ * Gets all ProcessInstances that match the given query.
329
+ * @tags ProcessInstances
330
+ * @method get
331
+ * @queryParams offset: number, limit: number, correlationId: Array<string> | string | SearchQuery, processInstanceId: Array<string> | string | SearchQuery, processDefinitionId: Array<string> | string | SearchQuery, processModelId: Array<string> | string | SearchQuery, processModelName: Array<string> | string | SearchQuery, processModelHash: Array<string> | string | SearchQuery, ownerId: Array<string> | string | SearchQuery, state: Array<string> | string | SearchQuery, parentProcessInstanceId: Array<string> | string | SearchQuery, terminatedByUserId: Array<string> | string | SearchQuery, createdBefore: Date, createdAt: Array<Date> | Date, createdAfter: Date, updatedBefore: Date, updatedAt: Array<Date> | Date, updatedAfter: Date, finishedBefore: Date, finishedAt: Array<Date> | Date, finishedAfter: Date, triggeredByFlowNodeInstance: Array<string> | string | SearchQuery
332
+ * @responseType ProcessInstanceList
333
+ */
334
+ queryProcessInstances: '/process_instances/query',
335
+ /**
336
+ * Gets the ProcessDefinition for a given ProcessInstance.
337
+ * @tags ProcessInstances
338
+ * @method get
339
+ * @responseType ProcessDefinition
340
+ */
341
+ getProcessDefinitionForProcessInstance: `/process_instances/${params.processInstanceId}/process_definition`,
342
+ /**
343
+ * Gets the ProcessModel for a given ProcessInstance.
344
+ * @tags ProcessInstances
345
+ * @method get
346
+ * @responseType ProcessModel
347
+ */
348
+ getProcessModelForProcessInstance: `/process_instances/${params.processInstanceId}/process_model`,
349
+ /**
350
+ * Changes the owner of the ProcessInstance with the given ID.
351
+ * @tags ProcessInstances
352
+ * @method post
353
+ * @requestBody {"required": true, "bodyType": "application/json", "contentType": {"newOwner": {"type": "Identity"}}}
354
+ */
355
+ changeProcessInstanceOwner: `/process_instances/${params.processInstanceId}/change_owner`,
356
+ /**
357
+ * Terminates the ProcessInstance with the given ID.
358
+ * @tags ProcessInstances
359
+ * @method put
360
+ */
361
+ terminateProcessInstances: `/process_instances/${params.processInstanceId}/terminate`,
362
+ /**
363
+ * Retries a failed or terminated Process Instance from the original point of failure.
364
+ * Alternatively, the Process Instance can be reset to a specific flow Node Instance, provided with the "flow_node_instance_id" Query parameter
365
+ * @tags ProcessInstances
366
+ * @method put
367
+ * @queryParams flow_node_instance_id: string
368
+ * @requestBody {"required": false, "bodyType": "application/json", "contentType": {"newStartToken": {"type": "object"}}}
369
+ */
370
+ retryProcessInstance: `/process_instances/${params.processInstanceId}/retry`,
371
+ /**
372
+ * Deletes the given Set of Process Instances. Multiple ProcessInstanceIds can be provided with ";" as separator.
373
+ * Per default, a Process Instance is only flagged as deleted. To actually delete the Process Instances and all related data, set "delete_all_related_data" to "true".
374
+ * @tags ProcessInstances
375
+ * @method delete
376
+ * @queryParams process_instance_ids: string | Array<string>, delete_all_related_data: boolean
377
+ */
378
+ deleteProcessInstances: `/process_instances`,
379
+ // UserMetadataStorage
380
+ /**
381
+ * Queries all values by the given keys
382
+ * @tags UserMetadata
383
+ * @method get
384
+ * @queryParams keys: string | Array<string>
385
+ */
386
+ queryUserMetadata: '/user_metadata/query',
387
+ /**
388
+ * Gets a value by the given key
389
+ * @tags UserMetadata
390
+ * @method get
391
+ */
392
+ getUserMetadata: `/user_metadata/${params.userMetadataKey}`,
393
+ /**
394
+ * Sets a value for the given key
395
+ * @tags UserMetadata
396
+ * @method post
397
+ */
398
+ setUserMetadata: `/user_metadata/${params.userMetadataKey}`,
399
+ /**
400
+ * Removes a value for the given key
401
+ * @tags UserMetadata
402
+ * @method delete
403
+ */
404
+ removeUserMetadata: `/user_metadata/${params.userMetadataKey}`,
405
+ // Long Polling Notifications
406
+ /**
407
+ * Wait for a CronjobCreated notification and resolves with the notification's content.
408
+ * @tags Notifications
409
+ * @method get
410
+ * @responseType CronjobEventMessage
411
+ */
412
+ onCronjobCreated: '/notifications/long_polling/cronjob_created',
413
+ /**
414
+ * Wait for a CronjobExecuted notification and resolves with the notification's content.
415
+ * @tags Notifications
416
+ * @method get
417
+ * @responseType CronjobEventMessage
418
+ */
419
+ onCronjobExecuted: '/notifications/long_polling/cronjob_executed',
420
+ /**
421
+ * Wait for a CronjobStopped notification and resolves with the notification's content.
422
+ * @tags Notifications
423
+ * @method get
424
+ * @responseType CronjobEventMessage
425
+ */
426
+ onCronjobStopped: '/notifications/long_polling/cronjob_stopped',
427
+ /**
428
+ * Wait for a CronjobUpdated notification and resolves with the notification's content.
429
+ * @tags Notifications
430
+ * @method get
431
+ * @responseType CronjobEventMessage
432
+ */
433
+ onCronjobUpdated: '/notifications/long_polling/cronjob_updated',
434
+ /**
435
+ * Wait for a CronjobRemoved notification and resolves with the notification's content.
436
+ * @tags Notifications
437
+ * @method get
438
+ * @responseType CronjobEventMessage
439
+ */
440
+ onCronjobRemoved: '/notifications/long_polling/cronjob_removed',
441
+ /**
442
+ * Wait for a ProcessDeployed notification and resolves with the notification's content.
443
+ * @tags Notifications
444
+ * @method get
445
+ * @responseType ProcessDeploymentMessage
446
+ */
447
+ onProcessDeployed: '/notifications/long_polling/process_deployed',
448
+ /**
449
+ * Wait for a ProcessIsExecutableChanged notification and resolves with the notification's content.
450
+ * @tags Notifications
451
+ * @method get
452
+ * @responseType ProcessIsExecutableChangedMessage
453
+ */
454
+ onProcessIsExecutableChanged: '/notifications/long_polling/process_is_executable_changed',
455
+ /**
456
+ * Wait for a CronjobEnabledChanged notification and resolves with the notification's content.
457
+ * @tags Notifications
458
+ * @method get
459
+ * @responseType CronjobEnabledChangedMessage
460
+ */
461
+ onCronjobEnabledChanged: '/notifications/long_polling/cronjob_enabled_changed',
462
+ /**
463
+ * Wait for a ProcessUndeployed notification and resolves with the notification's content.
464
+ * @tags Notifications
465
+ * @method get
466
+ * @responseType ProcessDeploymentMessage
467
+ */
468
+ onProcessUndeployed: '/notifications/long_polling/process_undeployed',
469
+ /**
470
+ * Wait for a ProcessStarting notification and resolves with the notification's content.
471
+ * @tags Notifications
472
+ * @method get
473
+ * @responseType EventMessage
474
+ */
475
+ onProcessStarting: '/notifications/long_polling/process_starting',
476
+ /**
477
+ * Wait for a ProcessStarted notification and resolves with the notification's content.
478
+ * @tags Notifications
479
+ * @method get
480
+ * @responseType EventMessage
481
+ */
482
+ onProcessStarted: '/notifications/long_polling/process_started',
483
+ /**
484
+ * Wait for a ProcessResumed notification and resolves with the notification's content.
485
+ * @tags Notifications
486
+ * @method get
487
+ * @responseType EventMessage
488
+ */
489
+ onProcessResumed: '/notifications/long_polling/process_resumed',
490
+ /**
491
+ * Wait for a ProcessEnded notification and resolves with the notification's content.
492
+ * @tags Notifications
493
+ * @method get
494
+ * @responseType EventMessage
495
+ */
496
+ onProcessEnded: '/notifications/long_polling/process_ended',
497
+ /**
498
+ * Wait for a ProcessOwnerChanged notification and resolves with the notification's content.
499
+ * @tags Notifications
500
+ * @method get
501
+ * @responseType EventMessage
502
+ */
503
+ onProcessOwnerChanged: '/notifications/long_polling/process_owner_changed',
504
+ /**
505
+ * Wait for a ProcessTerminated notification and resolves with the notification's content.
506
+ * @tags Notifications
507
+ * @method get
508
+ * @responseType EventMessage
509
+ */
510
+ onProcessTerminated: '/notifications/long_polling/process_terminated',
511
+ /**
512
+ * Wait for a ProcessError notification and resolves with the notification's content.
513
+ * @tags Notifications
514
+ * @method get
515
+ * @responseType EventMessage
516
+ */
517
+ onProcessError: '/notifications/long_polling/process_error',
518
+ /**
519
+ * Wait for a ProcessInstancesDeleted notification and resolves with the notification's content.
520
+ * @tags Notifications
521
+ * @method get
522
+ * @responseType EventMessage
523
+ */
524
+ onProcessInstancesDeleted: '/notifications/long_polling/process_instances_deleted',
525
+ /**
526
+ * Wait for an ExternalTaskCreated notification and resolves with the notification's content.
527
+ * @tags Notifications
528
+ * @method get
529
+ * @responseType ExternalTaskCreatedMessage
530
+ */
531
+ onExternalTaskCreated: '/notifications/long_polling/external_task_created',
532
+ /**
533
+ * Wait for a ExternalTaskLocked notification and resolves with the notification's content.
534
+ * @tags Notifications
535
+ * @method get
536
+ * @responseType ExternalTaskLockedMessage
537
+ */
538
+ onExternalTaskLocked: '/notifications/long_polling/external_task_locked',
539
+ /**
540
+ * Wait for a ExternalTaskUnlocked notification and resolves with the notification's content.
541
+ * @tags Notifications
542
+ * @method get
543
+ * @responseType ExternalTaskUnlockedMessage
544
+ */
545
+ onExternalTaskUnlocked: '/notifications/long_polling/external_task_unlocked',
546
+ /**
547
+ * Wait for a ExternalTaskExpired notification and resolves with the notification's content.
548
+ * @tags Notifications
549
+ * @method get
550
+ * @responseType ExternalTaskExpiredMessage
551
+ */
552
+ onExternalTaskExpired: '/notifications/long_polling/external_task_expired',
553
+ /**
554
+ * Wait for an ActivityReached notification and resolves with the notification's content.
555
+ * @tags Notifications
556
+ * @method get
557
+ * @responseType EventMessage
558
+ */
559
+ onActivityReached: '/notifications/long_polling/activity_reached',
560
+ /**
561
+ * Wait for an ActivityFinished notification and resolves with the notification's content.
562
+ * @tags Notifications
563
+ * @method get
564
+ * @responseType EventMessage
565
+ */
566
+ onActivityFinished: '/notifications/long_polling/activity_finished',
567
+ /**
568
+ * Wait for an EmptyActivityWaiting notification and resolves with the notification's content.
569
+ * @tags Notifications
570
+ * @method get
571
+ * @responseType EventMessage
572
+ */
573
+ onEmptyActivityWaiting: '/notifications/long_polling/empty_activity_waiting',
574
+ /**
575
+ * Wait for an EmptyActivityFinished notification and resolves with the notification's content.
576
+ * @tags Notifications
577
+ * @method get
578
+ * @responseType EventMessage
579
+ */
580
+ onEmptyActivityFinished: '/notifications/long_polling/empty_activity_finished',
581
+ /**
582
+ * Wait for a ManualTaskWaiting notification and resolves with the notification's content.
583
+ * @tags Notifications
584
+ * @method get
585
+ * @responseType EventMessage
586
+ */
587
+ onManualTaskWaiting: '/notifications/long_polling/manual_task_waiting',
588
+ /**
589
+ * Wait for a ManualTaskFinied notification and resolves with the notification's content.
590
+ * @tags Notifications
591
+ * @method get
592
+ * @responseType EventMessage
593
+ */
594
+ onManualTaskFinished: '/notifications/long_polling/manual_task_finished',
595
+ /**
596
+ * Wait for a UserTaskWaiting notification and resolves with the notification's content.
597
+ * @tags Notifications
598
+ * @method get
599
+ * @responseType EventMessage
600
+ */
601
+ onUserTaskWaiting: '/notifications/long_polling/user_task_waiting',
602
+ /**
603
+ * Wait for a UserTaskFinished notification and resolves with the notification's content.
604
+ * @tags Notifications
605
+ * @method get
606
+ * @responseType EventMessage
607
+ */
608
+ onUserTaskFinished: '/notifications/long_polling/user_task_finished',
609
+ /**
610
+ * Wait for a UserTaskReserved notification and resolves with the notification's content.
611
+ * @tags Notifications
612
+ * @method get
613
+ * @responseType EventMessage
614
+ */
615
+ onUserTaskReserved: '/notifications/long_polling/user_task_reserved',
616
+ /**
617
+ * Wait for a UserTaskReservationCanceled notification and resolves with the notification's content.
618
+ * @tags Notifications
619
+ * @method get
620
+ * @responseType EventMessage
621
+ */
622
+ onUserTaskReservationCanceled: '/notifications/long_polling/user_task_reservation_canceled',
623
+ /**
624
+ * Wait for a BoundaryEventTriggered notification and resolves with the notification's content.
625
+ * @tags Notifications
626
+ * @method get
627
+ * @responseType EventMessage
628
+ */
629
+ onBoundaryEventTriggered: '/notifications/long_polling/boundary_event_triggered',
630
+ /**
631
+ * Wait for an IntermediateThrowEventTriggered notification and resolves with the notification's content.
632
+ * @tags Notifications
633
+ * @method get
634
+ * @responseType EventMessage
635
+ */
636
+ onIntermediateThrowEventTriggered: '/notifications/long_polling/intermediate_throw_event_triggered',
637
+ /**
638
+ * Wait for an IntermediateCatchEventReached notification and resolves with the notification's content.
639
+ * @tags Notifications
640
+ * @method get
641
+ * @responseType EventMessage
642
+ */
643
+ onIntermediateCatchEventReached: '/notifications/long_polling/intermediate_catch_event_reached',
644
+ /**
645
+ *
646
+ * Wait for a IntermediateCatchEventFinished notification and resolves with the notification's content.
647
+ * @tags Notifications
648
+ * @method get
649
+ * @responseType EventMessage
650
+ */
651
+ onIntermediateCatchEventFinished: '/notifications/long_polling/intermediate_catch_event_finished',
652
+ /**
653
+ *
654
+ * Wait for a FlowNodeEventRetrySending notification and resolves with the notification's content.
655
+ * @tags Notifications
656
+ * @method get
657
+ * @responseType EventMessage
658
+ */
659
+ onFlowNodeEventRetrySending: '/notifications/long_polling/flow_node_event_retry_sending',
660
+ /**
661
+ * Wait for an MessageTriggered notification and resolves with the notification's content.
662
+ * @tags Notifications
663
+ * @method get
664
+ * @responseType EventMessage
665
+ */
666
+ onMessageTriggered: '/notifications/long_polling/message_triggered',
667
+ /**
668
+ * Wait for an SignalTriggered notification and resolves with the notification's content.
669
+ * @tags Notifications
670
+ * @method get
671
+ * @responseType EventMessage
672
+ */
673
+ onSignalTriggered: '/notifications/long_polling/signal_triggered',
674
+ /**
675
+ * Wait for an EndEventFinished notification and resolves with the notification's content.
676
+ * @tags Notifications
677
+ * @method get
678
+ * @responseType EventMessage
679
+ */
680
+ onEndEventFinished: '/notifications/long_polling/end_event_finished',
681
+ /**
682
+ * Wait for an StartEventFinished notification and resolves with the notification's content.
683
+ * @tags Notifications
684
+ * @method get
685
+ * @responseType EventMessage
686
+ */
687
+ onStartEventFinished: '/notifications/long_polling/start_event_finished',
688
+ /**
689
+ * Wait for a ProcessInstanceMetadataChanged notification and resolves with the notification's content.
690
+ * @tags Notifications
691
+ * @method get
692
+ * @responseType MetadataChangedMessage
693
+ */
694
+ onProcessInstanceMetadataChanged: '/notifications/long_polling/process_instance_metadata_changed',
695
+ /**
696
+ * Wait for a CorrelationMetadataChanged notification and resolves with the notification's content.
697
+ * @tags Notifications
698
+ * @method get
699
+ * @responseType MetadataChangedMessage
700
+ */
701
+ onCorrelationMetadataChanged: '/notifications/long_polling/correlation_metadata_changed',
702
+ };
703
+ exports.restSettings = {
704
+ params: params,
705
+ paths: paths,
706
+ baseRoute: 'atlas_engine/api',
707
+ };
708
+ });
709
+ //# sourceMappingURL=RestSettings.js.map