@5minds/processcube_engine_client 5.0.0-feature-e6859c-lpscoj75 → 5.0.0-feature-ce7dfd-lpv6rsi8

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