@bpmnkit/api 0.0.8

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 (48) hide show
  1. package/README.md +150 -0
  2. package/dist/generated/admin-resources.d.ts +199 -0
  3. package/dist/generated/admin-resources.js +381 -0
  4. package/dist/generated/admin-types.d.ts +283 -0
  5. package/dist/generated/admin-types.js +4 -0
  6. package/dist/generated/resources.d.ts +1519 -0
  7. package/dist/generated/resources.js +2650 -0
  8. package/dist/generated/types.d.ts +11946 -0
  9. package/dist/generated/types.js +4 -0
  10. package/dist/index.d.ts +11 -0
  11. package/dist/index.js +10 -0
  12. package/dist/runtime/auth.d.ts +31 -0
  13. package/dist/runtime/auth.js +136 -0
  14. package/dist/runtime/cache.d.ts +13 -0
  15. package/dist/runtime/cache.js +48 -0
  16. package/dist/runtime/cache.test.d.ts +2 -0
  17. package/dist/runtime/cache.test.js +38 -0
  18. package/dist/runtime/client.d.ts +25 -0
  19. package/dist/runtime/client.js +33 -0
  20. package/dist/runtime/config.d.ts +15 -0
  21. package/dist/runtime/config.js +371 -0
  22. package/dist/runtime/errors.d.ts +53 -0
  23. package/dist/runtime/errors.js +101 -0
  24. package/dist/runtime/errors.test.d.ts +2 -0
  25. package/dist/runtime/errors.test.js +40 -0
  26. package/dist/runtime/events.d.ts +12 -0
  27. package/dist/runtime/events.js +48 -0
  28. package/dist/runtime/events.test.d.ts +2 -0
  29. package/dist/runtime/events.test.js +57 -0
  30. package/dist/runtime/http.d.ts +15 -0
  31. package/dist/runtime/http.js +210 -0
  32. package/dist/runtime/logger.d.ts +9 -0
  33. package/dist/runtime/logger.js +34 -0
  34. package/dist/runtime/relations.d.ts +43 -0
  35. package/dist/runtime/relations.js +54 -0
  36. package/dist/runtime/retry.d.ts +14 -0
  37. package/dist/runtime/retry.js +41 -0
  38. package/dist/runtime/retry.test.d.ts +2 -0
  39. package/dist/runtime/retry.test.js +46 -0
  40. package/dist/runtime/token-cache.d.ts +42 -0
  41. package/dist/runtime/token-cache.js +104 -0
  42. package/dist/runtime/types.d.ts +191 -0
  43. package/dist/runtime/types.js +2 -0
  44. package/dist/runtime/yaml.d.ts +14 -0
  45. package/dist/runtime/yaml.js +234 -0
  46. package/dist/runtime/yaml.test.d.ts +2 -0
  47. package/dist/runtime/yaml.test.js +93 -0
  48. package/package.json +31 -0
@@ -0,0 +1,1519 @@
1
+ import type { CamundaClientInput } from "../runtime/types.js";
2
+ import { CamundaBaseClient } from "../runtime/client.js";
3
+ import { ResourceBase } from "../runtime/client.js";
4
+ import type * as Types from "./types.js";
5
+ export declare class AuditLogResource extends ResourceBase {
6
+ /**
7
+ * Search audit logs
8
+ *
9
+ * Search for audit logs based on given criteria.
10
+ * @see POST /audit-logs/search
11
+ */
12
+ searchAuditLogs(body?: Types.AuditLogSearchQueryRequest): Promise<Types.AuditLogSearchQueryResult>;
13
+ /**
14
+ * Get audit log
15
+ *
16
+ * Get an audit log entry by auditLogKey.
17
+ * @see GET /audit-logs/{auditLogKey}
18
+ */
19
+ getAuditLog(auditLogKey: string): Promise<Types.AuditLogResult>;
20
+ }
21
+ export declare class AuthenticationResource extends ResourceBase {
22
+ /**
23
+ * Get current user
24
+ *
25
+ * Retrieves the current authenticated user.
26
+ * @see GET /authentication/me
27
+ */
28
+ getAuthentication(): Promise<Types.CamundaUserResult>;
29
+ }
30
+ export declare class AuthorizationResource extends ResourceBase {
31
+ /**
32
+ * Create authorization
33
+ *
34
+ * Create the authorization.
35
+ * @see POST /authorizations
36
+ */
37
+ createAuthorization(body: Types.AuthorizationRequest): Promise<Types.AuthorizationCreateResult>;
38
+ /**
39
+ * Search authorizations
40
+ *
41
+ * Search for authorizations based on given criteria.
42
+ * @see POST /authorizations/search
43
+ */
44
+ searchAuthorizations(body?: Types.AuthorizationSearchQuery): Promise<Types.AuthorizationSearchResult>;
45
+ /**
46
+ * Get authorization
47
+ *
48
+ * Get authorization by the given key.
49
+ * @see GET /authorizations/{authorizationKey}
50
+ */
51
+ getAuthorization(authorizationKey: string): Promise<Types.AuthorizationResult>;
52
+ /**
53
+ * Update authorization
54
+ *
55
+ * Update the authorization with the given key.
56
+ * @see PUT /authorizations/{authorizationKey}
57
+ */
58
+ updateAuthorization(authorizationKey: string, body: Types.AuthorizationRequest): Promise<void>;
59
+ /**
60
+ * Delete authorization
61
+ *
62
+ * Deletes the authorization with the given key.
63
+ * @see DELETE /authorizations/{authorizationKey}
64
+ */
65
+ deleteAuthorization(authorizationKey: string): Promise<void>;
66
+ }
67
+ export declare class BatchOperationResource extends ResourceBase {
68
+ /**
69
+ * Search batch operation items
70
+ *
71
+ * Search for batch operation items based on given criteria.
72
+ * @see POST /batch-operation-items/search
73
+ */
74
+ searchBatchOperationItems(body?: Types.BatchOperationItemSearchQuery): Promise<Types.BatchOperationItemSearchQueryResult>;
75
+ /**
76
+ * Search batch operations
77
+ *
78
+ * Search for batch operations based on given criteria.
79
+ * @see POST /batch-operations/search
80
+ */
81
+ searchBatchOperations(body?: Types.BatchOperationSearchQuery): Promise<Types.BatchOperationSearchQueryResult>;
82
+ /**
83
+ * Get batch operation
84
+ *
85
+ * Get batch operation by key.
86
+ * @see GET /batch-operations/{batchOperationKey}
87
+ */
88
+ getBatchOperation(batchOperationKey: string): Promise<Types.BatchOperationResponse>;
89
+ /**
90
+ * Cancel Batch operation
91
+ *
92
+ * Cancels a running batch operation.
93
+ * This is done asynchronously, the progress can be tracked using the batch operation status endpoint (/batch-operations/{batchOperationKey}).
94
+ * @see POST /batch-operations/{batchOperationKey}/cancellation
95
+ */
96
+ cancelBatchOperation(batchOperationKey: string): Promise<void>;
97
+ /**
98
+ * Resume Batch operation
99
+ *
100
+ * Resumes a suspended batch operation.
101
+ * This is done asynchronously, the progress can be tracked using the batch operation status endpoint (/batch-operations/{batchOperationKey}).
102
+ * @see POST /batch-operations/{batchOperationKey}/resumption
103
+ */
104
+ resumeBatchOperation(batchOperationKey: string): Promise<void>;
105
+ /**
106
+ * Suspend Batch operation
107
+ *
108
+ * Suspends a running batch operation.
109
+ * This is done asynchronously, the progress can be tracked using the batch operation status endpoint (/batch-operations/{batchOperationKey}).
110
+ * @see POST /batch-operations/{batchOperationKey}/suspension
111
+ */
112
+ suspendBatchOperation(batchOperationKey: string): Promise<void>;
113
+ }
114
+ export declare class ClockResource extends ResourceBase {
115
+ /**
116
+ * Pin internal clock (alpha)
117
+ *
118
+ * Set a precise, static time for the Zeebe engine's internal clock.
119
+ * When the clock is pinned, it remains at the specified time and does not advance.
120
+ * To change the time, the clock must be pinned again with a new timestamp.
121
+ * @see PUT /clock
122
+ */
123
+ pinClock(body: Types.ClockPinRequest): Promise<void>;
124
+ /**
125
+ * Reset internal clock (alpha)
126
+ *
127
+ * Resets the Zeebe engine's internal clock to the current system time, enabling it to tick in real-time.
128
+ * This operation is useful for returning the clock to
129
+ * normal behavior after it has been pinned to a specific time.
130
+ * @see POST /clock/reset
131
+ */
132
+ resetClock(): Promise<void>;
133
+ }
134
+ export declare class ClusterVariableResource extends ResourceBase {
135
+ /**
136
+ * Create a global-scoped cluster variable
137
+ *
138
+ * Create a global-scoped cluster variable.
139
+ * @see POST /cluster-variables/global
140
+ */
141
+ createGlobalClusterVariable(body: Types.CreateClusterVariableRequest): Promise<Types.ClusterVariableResult>;
142
+ /**
143
+ * Get a global-scoped cluster variable
144
+ *
145
+ * Get a global-scoped cluster variable.
146
+ * @see GET /cluster-variables/global/{name}
147
+ */
148
+ getGlobalClusterVariable(name: string): Promise<Types.ClusterVariableResult>;
149
+ /**
150
+ * Update a global-scoped cluster variable
151
+ *
152
+ * Updates the value of an existing global cluster variable.
153
+ * The variable must exist, otherwise a 404 error is returned.
154
+ * @see PUT /cluster-variables/global/{name}
155
+ */
156
+ updateGlobalClusterVariable(name: string, body: Types.UpdateClusterVariableRequest): Promise<Types.ClusterVariableResult>;
157
+ /**
158
+ * Delete a global-scoped cluster variable
159
+ *
160
+ * Delete a global-scoped cluster variable.
161
+ * @see DELETE /cluster-variables/global/{name}
162
+ */
163
+ deleteGlobalClusterVariable(name: string): Promise<void>;
164
+ /**
165
+ *
166
+ * Search for cluster variables based on given criteria. By default, long variable values in the response are truncated.
167
+ * @see POST /cluster-variables/search
168
+ */
169
+ searchClusterVariables(body?: Types.ClusterVariableSearchQueryRequest, query?: {
170
+ truncateValues?: boolean;
171
+ }): Promise<Types.ClusterVariableSearchQueryResult>;
172
+ /**
173
+ * Create a tenant-scoped cluster variable
174
+ *
175
+ * Create a new cluster variable for the given tenant.
176
+ * @see POST /cluster-variables/tenants/{tenantId}
177
+ */
178
+ createTenantClusterVariable(tenantId: string, body: Types.CreateClusterVariableRequest): Promise<Types.ClusterVariableResult>;
179
+ /**
180
+ * Get a tenant-scoped cluster variable
181
+ *
182
+ * Get a tenant-scoped cluster variable.
183
+ * @see GET /cluster-variables/tenants/{tenantId}/{name}
184
+ */
185
+ getTenantClusterVariable(tenantId: string, name: string): Promise<Types.ClusterVariableResult>;
186
+ /**
187
+ * Update a tenant-scoped cluster variable
188
+ *
189
+ * Updates the value of an existing tenant-scoped cluster variable.
190
+ * The variable must exist, otherwise a 404 error is returned.
191
+ * @see PUT /cluster-variables/tenants/{tenantId}/{name}
192
+ */
193
+ updateTenantClusterVariable(tenantId: string, name: string, body: Types.UpdateClusterVariableRequest): Promise<Types.ClusterVariableResult>;
194
+ /**
195
+ * Delete a tenant-scoped cluster variable
196
+ *
197
+ * Delete a tenant-scoped cluster variable.
198
+ * @see DELETE /cluster-variables/tenants/{tenantId}/{name}
199
+ */
200
+ deleteTenantClusterVariable(tenantId: string, name: string): Promise<void>;
201
+ }
202
+ export declare class ConditionalResource extends ResourceBase {
203
+ /**
204
+ * Evaluate root level conditional start events
205
+ *
206
+ * Evaluates root-level conditional start events for process definitions.
207
+ * If the evaluation is successful, it will return the keys of all created process instances, along with their associated process definition key.
208
+ * Multiple root-level conditional start events of the same process definition can trigger if their conditions evaluate to true.
209
+ * @see POST /conditionals/evaluation
210
+ */
211
+ evaluateConditionals(body: Types.ConditionalEvaluationInstruction): Promise<Types.EvaluateConditionalResult>;
212
+ }
213
+ export declare class MessageSubscriptionResource extends ResourceBase {
214
+ /**
215
+ * Search correlated message subscriptions
216
+ *
217
+ * Search correlated message subscriptions based on given criteria.
218
+ * @see POST /correlated-message-subscriptions/search
219
+ */
220
+ searchCorrelatedMessageSubscriptions(body?: Types.CorrelatedMessageSubscriptionSearchQuery): Promise<Types.CorrelatedMessageSubscriptionSearchQueryResult>;
221
+ /**
222
+ * Search message subscriptions
223
+ *
224
+ * Search for message subscriptions based on given criteria.
225
+ * @see POST /message-subscriptions/search
226
+ */
227
+ searchMessageSubscriptions(body?: Types.MessageSubscriptionSearchQuery): Promise<Types.MessageSubscriptionSearchQueryResult>;
228
+ }
229
+ export declare class DecisionDefinitionResource extends ResourceBase {
230
+ /**
231
+ * Evaluate decision
232
+ *
233
+ * Evaluates a decision.
234
+ * You specify the decision to evaluate either by using its unique key (as returned by
235
+ * DeployResource), or using the decision ID. When using the decision ID, the latest deployed
236
+ * @see POST /decision-definitions/evaluation
237
+ */
238
+ evaluateDecision(body: Types.DecisionEvaluationInstruction): Promise<Types.EvaluateDecisionResult>;
239
+ /**
240
+ * Search decision definitions
241
+ *
242
+ * Search for decision definitions based on given criteria.
243
+ * @see POST /decision-definitions/search
244
+ */
245
+ searchDecisionDefinitions(body?: Types.DecisionDefinitionSearchQuery): Promise<Types.DecisionDefinitionSearchQueryResult>;
246
+ /**
247
+ * Get decision definition
248
+ *
249
+ * Returns a decision definition by key.
250
+ * @see GET /decision-definitions/{decisionDefinitionKey}
251
+ */
252
+ getDecisionDefinition(decisionDefinitionKey: string): Promise<Types.DecisionDefinitionResult>;
253
+ /**
254
+ * Get decision definition XML
255
+ *
256
+ * Returns decision definition as XML.
257
+ * @see GET /decision-definitions/{decisionDefinitionKey}/xml
258
+ */
259
+ getDecisionDefinitionXML(decisionDefinitionKey: string): Promise<void>;
260
+ }
261
+ export declare class DecisionInstanceResource extends ResourceBase {
262
+ /**
263
+ * Search decision instances
264
+ *
265
+ * Search for decision instances based on given criteria.
266
+ * @see POST /decision-instances/search
267
+ */
268
+ searchDecisionInstances(body?: Types.DecisionInstanceSearchQuery): Promise<Types.DecisionInstanceSearchQueryResult>;
269
+ /**
270
+ * Get decision instance
271
+ *
272
+ * Returns a decision instance.
273
+ * @see GET /decision-instances/{decisionEvaluationInstanceKey}
274
+ */
275
+ getDecisionInstance(decisionEvaluationInstanceKey: string): Promise<Types.DecisionInstanceGetQueryResult>;
276
+ /**
277
+ * Delete decision instance
278
+ *
279
+ * Delete all associated decision evaluations based on provided key.
280
+ * @see POST /decision-instances/{decisionInstanceKey}/deletion
281
+ */
282
+ deleteDecisionInstance(decisionInstanceKey: string, body?: Types.DeleteDecisionInstanceRequest): Promise<void>;
283
+ /**
284
+ * Delete decision instances (batch)
285
+ *
286
+ * Delete multiple decision instances. This will delete the historic data from secondary storage.
287
+ * This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}).
288
+ * @see POST /decision-instances/deletion
289
+ */
290
+ deleteDecisionInstancesBatchOperation(body: Types.DecisionInstanceDeletionBatchOperationRequest): Promise<Types.BatchOperationCreatedResult>;
291
+ }
292
+ export declare class DecisionRequirementsResource extends ResourceBase {
293
+ /**
294
+ * Search decision requirements
295
+ *
296
+ * Search for decision requirements based on given criteria.
297
+ * @see POST /decision-requirements/search
298
+ */
299
+ searchDecisionRequirements(body?: Types.DecisionRequirementsSearchQuery): Promise<Types.DecisionRequirementsSearchQueryResult>;
300
+ /**
301
+ * Get decision requirements
302
+ *
303
+ * Returns Decision Requirements as JSON.
304
+ * @see GET /decision-requirements/{decisionRequirementsKey}
305
+ */
306
+ getDecisionRequirements(decisionRequirementsKey: string): Promise<Types.DecisionRequirementsResult>;
307
+ /**
308
+ * Get decision requirements XML
309
+ *
310
+ * Returns decision requirements as XML.
311
+ * @see GET /decision-requirements/{decisionRequirementsKey}/xml
312
+ */
313
+ getDecisionRequirementsXML(decisionRequirementsKey: string): Promise<void>;
314
+ }
315
+ export declare class ResourceResource extends ResourceBase {
316
+ /**
317
+ * Deploy resources
318
+ *
319
+ * Deploys one or more resources (e.g. processes, decision models, or forms).
320
+ * This is an atomic call, i.e. either all resources are deployed or none of them are.
321
+ * @see POST /deployments
322
+ */
323
+ createDeployment(): Promise<Types.DeploymentResult>;
324
+ /**
325
+ * Get resource
326
+ *
327
+ * Returns a deployed resource.
328
+ * :::info
329
+ * Currently, this endpoint only supports RPA resources.
330
+ * @see GET /resources/{resourceKey}
331
+ */
332
+ getResource(resourceKey: string): Promise<Types.ResourceResult>;
333
+ /**
334
+ * Get resource content
335
+ *
336
+ * Returns the content of a deployed resource.
337
+ * :::info
338
+ * Currently, this endpoint only supports RPA resources.
339
+ * @see GET /resources/{resourceKey}/content
340
+ */
341
+ getResourceContent(resourceKey: string): Promise<string>;
342
+ /**
343
+ * Delete resource
344
+ *
345
+ * Deletes a deployed resource. This can be a process definition, decision requirements
346
+ * definition, or form definition deployed using the deploy resources endpoint. Specify the
347
+ * resource you want to delete in the `resourceKey` parameter.
348
+ * @see POST /resources/{resourceKey}/deletion
349
+ */
350
+ deleteResource(resourceKey: string, body?: Types.DeleteResourceRequest): Promise<Types.DeleteResourceResponse>;
351
+ }
352
+ export declare class DocumentResource extends ResourceBase {
353
+ /**
354
+ * Upload document
355
+ *
356
+ * Upload a document to the Camunda 8 cluster.
357
+ *
358
+ * Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
359
+ * @see POST /documents
360
+ */
361
+ createDocument(query?: {
362
+ storeId?: string;
363
+ documentId?: Types.DocumentId;
364
+ }): Promise<Types.DocumentReference>;
365
+ /**
366
+ * Upload multiple documents
367
+ *
368
+ * Upload multiple documents to the Camunda 8 cluster.
369
+ *
370
+ * The caller must provide a file name for each document, which will be used in case of a multi-status response
371
+ * @see POST /documents/batch
372
+ */
373
+ createDocuments(query?: {
374
+ storeId?: string;
375
+ }): Promise<Types.DocumentCreationBatchResponse>;
376
+ /**
377
+ * Download document
378
+ *
379
+ * Download a document from the Camunda 8 cluster.
380
+ *
381
+ * Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
382
+ * @see GET /documents/{documentId}
383
+ */
384
+ getDocument(documentId: string, query?: {
385
+ storeId?: string;
386
+ contentHash?: string;
387
+ }): Promise<void>;
388
+ /**
389
+ * Delete document
390
+ *
391
+ * Delete a document from the Camunda 8 cluster.
392
+ *
393
+ * Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
394
+ * @see DELETE /documents/{documentId}
395
+ */
396
+ deleteDocument(documentId: string, query?: {
397
+ storeId?: string;
398
+ }): Promise<void>;
399
+ /**
400
+ * Create document link
401
+ *
402
+ * Create a link to a document in the Camunda 8 cluster.
403
+ *
404
+ * Note that this is currently supported for document stores of type: AWS, GCP
405
+ * @see POST /documents/{documentId}/links
406
+ */
407
+ createDocumentLink(documentId: string, body?: Types.DocumentLinkRequest, query?: {
408
+ storeId?: string;
409
+ contentHash?: string;
410
+ }): Promise<Types.DocumentLink>;
411
+ }
412
+ export declare class AdHocSubProcessResource extends ResourceBase {
413
+ /**
414
+ * Activate activities within an ad-hoc sub-process
415
+ *
416
+ * Activates selected activities within an ad-hoc sub-process identified by element ID.
417
+ * The provided element IDs must exist within the ad-hoc sub-process instance identified by the
418
+ * provided adHocSubProcessInstanceKey.
419
+ * @see POST /element-instances/ad-hoc-activities/{adHocSubProcessInstanceKey}/activation
420
+ */
421
+ activateAdHocSubProcessActivities(adHocSubProcessInstanceKey: string, body: Types.AdHocSubProcessActivateActivitiesInstruction): Promise<void>;
422
+ }
423
+ export declare class ElementInstanceResource extends ResourceBase {
424
+ /**
425
+ * Search element instances
426
+ *
427
+ * Search for element instances based on given criteria.
428
+ * @see POST /element-instances/search
429
+ */
430
+ searchElementInstances(body?: Types.ElementInstanceSearchQuery): Promise<Types.ElementInstanceSearchQueryResult>;
431
+ /**
432
+ * Get element instance
433
+ *
434
+ * Returns element instance as JSON.
435
+ * @see GET /element-instances/{elementInstanceKey}
436
+ */
437
+ getElementInstance(elementInstanceKey: string): Promise<Types.ElementInstanceResult>;
438
+ /**
439
+ * Search for incidents of a specific element instance
440
+ *
441
+ * Search for incidents caused by the specified element instance, including incidents of any child instances created from this element instance.
442
+ *
443
+ * Although the `elementInstanceKey` is provided as a path parameter to indicate the root element instance,
444
+ * @see POST /element-instances/{elementInstanceKey}/incidents/search
445
+ */
446
+ searchElementInstanceIncidents(elementInstanceKey: string, body: Types.IncidentSearchQuery): Promise<Types.IncidentSearchQueryResult>;
447
+ /**
448
+ * Update element instance variables
449
+ *
450
+ * Updates all the variables of a particular scope (for example, process instance, element instance) with the given variable data.
451
+ * Specify the element instance in the `elementInstanceKey` parameter.
452
+ * @see PUT /element-instances/{elementInstanceKey}/variables
453
+ */
454
+ createElementInstanceVariables(elementInstanceKey: string, body: Types.SetVariableRequest): Promise<void>;
455
+ }
456
+ export declare class ExpressionResource extends ResourceBase {
457
+ /**
458
+ * Evaluate an expression
459
+ *
460
+ * Evaluates a FEEL expression and returns the result. Supports references to tenant scoped cluster variables when a tenant ID is provided.
461
+ * @see POST /expression/evaluation
462
+ */
463
+ evaluateExpression(body: Types.ExpressionEvaluationRequest): Promise<Types.ExpressionEvaluationResult>;
464
+ }
465
+ export declare class GlobalListenerResource extends ResourceBase {
466
+ /**
467
+ * Create global user task listener
468
+ *
469
+ * Create a new global user task listener.
470
+ * @see POST /global-task-listeners
471
+ */
472
+ createGlobalTaskListener(body: Types.CreateGlobalTaskListenerRequest): Promise<Types.GlobalTaskListenerResult>;
473
+ /**
474
+ * Get global user task listener
475
+ *
476
+ * Get a global user task listener by its id.
477
+ * @see GET /global-task-listeners/{id}
478
+ */
479
+ getGlobalTaskListener(id: string): Promise<Types.GlobalTaskListenerResult>;
480
+ /**
481
+ * Update global user task listener
482
+ *
483
+ * Updates a global user task listener.
484
+ * @see PUT /global-task-listeners/{id}
485
+ */
486
+ updateGlobalTaskListener(id: string, body: Types.UpdateGlobalTaskListenerRequest): Promise<Types.GlobalTaskListenerResult>;
487
+ /**
488
+ * Delete global user task listener
489
+ *
490
+ * Deletes a global user task listener.
491
+ * @see DELETE /global-task-listeners/{id}
492
+ */
493
+ deleteGlobalTaskListener(id: string): Promise<void>;
494
+ /**
495
+ * Search global user task listeners
496
+ *
497
+ * Search for global user task listeners based on given criteria.
498
+ * @see POST /global-task-listeners/search
499
+ */
500
+ searchGlobalTaskListeners(body?: Types.GlobalTaskListenerSearchQueryRequest): Promise<Types.GlobalTaskListenerSearchQueryResult>;
501
+ }
502
+ export declare class GroupResource extends ResourceBase {
503
+ /**
504
+ * Create group
505
+ *
506
+ * Create a new group.
507
+ * @see POST /groups
508
+ */
509
+ createGroup(body?: Types.GroupCreateRequest): Promise<Types.GroupCreateResult>;
510
+ /**
511
+ * Search groups
512
+ *
513
+ * Search for groups based on given criteria.
514
+ * @see POST /groups/search
515
+ */
516
+ searchGroups(body?: Types.GroupSearchQueryRequest): Promise<Types.GroupSearchQueryResult>;
517
+ /**
518
+ * Get group
519
+ *
520
+ * Get a group by its ID.
521
+ * @see GET /groups/{groupId}
522
+ */
523
+ getGroup(groupId: string): Promise<Types.GroupResult>;
524
+ /**
525
+ * Update group
526
+ *
527
+ * Update a group with the given ID.
528
+ * @see PUT /groups/{groupId}
529
+ */
530
+ updateGroup(groupId: string, body: Types.GroupUpdateRequest): Promise<Types.GroupUpdateResult>;
531
+ /**
532
+ * Delete group
533
+ *
534
+ * Deletes the group with the given ID.
535
+ * @see DELETE /groups/{groupId}
536
+ */
537
+ deleteGroup(groupId: string): Promise<void>;
538
+ /**
539
+ * Search group clients
540
+ *
541
+ * Search clients assigned to a group.
542
+ * @see POST /groups/{groupId}/clients/search
543
+ */
544
+ searchClientsForGroup(groupId: string, body?: Types.GroupClientSearchQueryRequest): Promise<Types.GroupClientSearchResult>;
545
+ /**
546
+ * Assign a client to a group
547
+ *
548
+ * Assigns a client to a group, making it a member of the group.
549
+ * Members of the group inherit the group authorizations, roles, and tenant assignments.
550
+ * @see PUT /groups/{groupId}/clients/{clientId}
551
+ */
552
+ assignClientToGroup(groupId: string, clientId: string): Promise<void>;
553
+ /**
554
+ * Unassign a client from a group
555
+ *
556
+ * Unassigns a client from a group.
557
+ * The client is removed as a group member, with associated authorizations, roles, and tenant assignments no longer applied.
558
+ * @see DELETE /groups/{groupId}/clients/{clientId}
559
+ */
560
+ unassignClientFromGroup(groupId: string, clientId: string): Promise<void>;
561
+ /**
562
+ * Search group mapping rules
563
+ *
564
+ * Search mapping rules assigned to a group.
565
+ * @see POST /groups/{groupId}/mapping-rules/search
566
+ */
567
+ searchMappingRulesForGroup(groupId: string, body?: Types.MappingRuleSearchQueryRequest): Promise<Types.GroupMappingRuleSearchResult>;
568
+ /**
569
+ * Assign a mapping rule to a group
570
+ *
571
+ * Assigns a mapping rule to a group.
572
+ * @see PUT /groups/{groupId}/mapping-rules/{mappingRuleId}
573
+ */
574
+ assignMappingRuleToGroup(groupId: string, mappingRuleId: string): Promise<void>;
575
+ /**
576
+ * Unassign a mapping rule from a group
577
+ *
578
+ * Unassigns a mapping rule from a group.
579
+ * @see DELETE /groups/{groupId}/mapping-rules/{mappingRuleId}
580
+ */
581
+ unassignMappingRuleFromGroup(groupId: string, mappingRuleId: string): Promise<void>;
582
+ /**
583
+ * Search group roles
584
+ *
585
+ * Search roles assigned to a group.
586
+ * @see POST /groups/{groupId}/roles/search
587
+ */
588
+ searchRolesForGroup(groupId: string, body?: Types.RoleSearchQueryRequest): Promise<Types.GroupRoleSearchResult>;
589
+ /**
590
+ * Search group users
591
+ *
592
+ * Search users assigned to a group.
593
+ * @see POST /groups/{groupId}/users/search
594
+ */
595
+ searchUsersForGroup(groupId: string, body?: Types.GroupUserSearchQueryRequest): Promise<Types.GroupUserSearchResult>;
596
+ /**
597
+ * Assign a user to a group
598
+ *
599
+ * Assigns a user to a group, making the user a member of the group.
600
+ * Group members inherit the group authorizations, roles, and tenant assignments.
601
+ * @see PUT /groups/{groupId}/users/{username}
602
+ */
603
+ assignUserToGroup(groupId: string, username: string): Promise<void>;
604
+ /**
605
+ * Unassign a user from a group
606
+ *
607
+ * Unassigns a user from a group.
608
+ * The user is removed as a group member, with associated authorizations, roles, and tenant assignments no longer applied.
609
+ * @see DELETE /groups/{groupId}/users/{username}
610
+ */
611
+ unassignUserFromGroup(groupId: string, username: string): Promise<void>;
612
+ }
613
+ export declare class IncidentResource extends ResourceBase {
614
+ /**
615
+ * Search incidents
616
+ *
617
+ * Search for incidents based on given criteria.
618
+ * @see POST /incidents/search
619
+ */
620
+ searchIncidents(body?: Types.IncidentSearchQuery): Promise<Types.IncidentSearchQueryResult>;
621
+ /**
622
+ * Get incident
623
+ *
624
+ * Returns incident as JSON.
625
+ * @see GET /incidents/{incidentKey}
626
+ */
627
+ getIncident(incidentKey: string): Promise<Types.IncidentResult>;
628
+ /**
629
+ * Resolve incident
630
+ *
631
+ * Marks the incident as resolved; most likely a call to Update job will be necessary
632
+ * to reset the job's retries, followed by this call.
633
+ * @see POST /incidents/{incidentKey}/resolution
634
+ */
635
+ resolveIncident(incidentKey: string, body?: Types.IncidentResolutionRequest): Promise<void>;
636
+ /**
637
+ * Get process instance statistics by definition
638
+ *
639
+ * Returns statistics for active process instances with incidents, grouped by process
640
+ * definition. The result set is scoped to a specific incident error hash code, which must be
641
+ * provided as a filter in the request body.
642
+ * @see POST /incidents/statistics/process-instances-by-definition
643
+ */
644
+ getProcessInstanceStatisticsByDefinition(body: Types.IncidentProcessInstanceStatisticsByDefinitionQuery): Promise<Types.IncidentProcessInstanceStatisticsByDefinitionQueryResult>;
645
+ /**
646
+ * Get process instance statistics by error
647
+ *
648
+ * Returns statistics for active process instances that currently have active incidents,
649
+ * grouped by incident error hash code.
650
+ * @see POST /incidents/statistics/process-instances-by-error
651
+ */
652
+ getProcessInstanceStatisticsByError(body?: Types.IncidentProcessInstanceStatisticsByErrorQuery): Promise<Types.IncidentProcessInstanceStatisticsByErrorQueryResult>;
653
+ }
654
+ export declare class JobResource extends ResourceBase {
655
+ /**
656
+ * Activate jobs
657
+ *
658
+ * Iterate through all known partitions and activate jobs up to the requested maximum.
659
+ * @see POST /jobs/activation
660
+ */
661
+ activateJobs(body: Types.JobActivationRequest): Promise<Types.JobActivationResult>;
662
+ /**
663
+ * Search jobs
664
+ *
665
+ * Search for jobs based on given criteria.
666
+ * @see POST /jobs/search
667
+ */
668
+ searchJobs(body?: Types.JobSearchQuery): Promise<Types.JobSearchQueryResult>;
669
+ /**
670
+ * Update job
671
+ *
672
+ * Update a job with the given key.
673
+ * @see PATCH /jobs/{jobKey}
674
+ */
675
+ updateJob(jobKey: string, body: Types.JobUpdateRequest): Promise<void>;
676
+ /**
677
+ * Complete job
678
+ *
679
+ * Complete a job with the given payload, which allows completing the associated service task.
680
+ * @see POST /jobs/{jobKey}/completion
681
+ */
682
+ completeJob(jobKey: string, body?: Types.JobCompletionRequest): Promise<void>;
683
+ /**
684
+ * Throw error for job
685
+ *
686
+ * Reports a business error (i.e. non-technical) that occurs while processing a job.
687
+ * @see POST /jobs/{jobKey}/error
688
+ */
689
+ throwJobError(jobKey: string, body: Types.JobErrorRequest): Promise<void>;
690
+ /**
691
+ * Fail job
692
+ *
693
+ * Mark the job as failed.
694
+ * @see POST /jobs/{jobKey}/failure
695
+ */
696
+ failJob(jobKey: string, body?: Types.JobFailRequest): Promise<void>;
697
+ /**
698
+ * Global job statistics
699
+ *
700
+ * Returns global aggregated counts for jobs. Optionally filter by the creation time window and/or jobType.
701
+ * @see GET /jobs/statistics/global
702
+ */
703
+ getGlobalJobStatistics(query?: {
704
+ from: string;
705
+ to: string;
706
+ jobType?: string;
707
+ }): Promise<Types.GlobalJobStatisticsQueryResult>;
708
+ /**
709
+ * Get job statistics by type
710
+ *
711
+ * Get statistics about jobs, grouped by job type.
712
+ * @see POST /jobs/statistics/by-types
713
+ */
714
+ getJobTypeStatistics(body: Types.JobTypeStatisticsQuery): Promise<Types.JobTypeStatisticsQueryResult>;
715
+ /**
716
+ * Get job statistics by worker
717
+ *
718
+ * Returns aggregated metrics per worker for the given jobType.
719
+ * @see POST /jobs/statistics/by-workers
720
+ */
721
+ getJobWorkerStatistics(body: Types.JobWorkerStatisticsQuery): Promise<Types.JobWorkerStatisticsQueryResult>;
722
+ /**
723
+ * Get time-series metrics for a job type
724
+ *
725
+ * Returns a list of time-bucketed metrics ordered ascending by time.
726
+ * The `from` and `to` fields select the time window of interest.
727
+ * Each item in the response corresponds to one time bucket of the requested resolution.
728
+ * @see POST /jobs/statistics/time-series
729
+ */
730
+ getJobTimeSeriesStatistics(body: Types.JobTimeSeriesStatisticsQuery): Promise<Types.JobTimeSeriesStatisticsQueryResult>;
731
+ }
732
+ export declare class LicenseResource extends ResourceBase {
733
+ /**
734
+ * Get license status
735
+ *
736
+ * Obtains the status of the current Camunda license.
737
+ * @see GET /license
738
+ */
739
+ getLicense(): Promise<Types.LicenseResponse>;
740
+ }
741
+ export declare class MappingRuleResource extends ResourceBase {
742
+ /**
743
+ * Create mapping rule
744
+ *
745
+ * Create a new mapping rule
746
+ * @see POST /mapping-rules
747
+ */
748
+ createMappingRule(body?: Types.MappingRuleCreateRequest): Promise<Types.MappingRuleCreateResult>;
749
+ /**
750
+ * Search mapping rules
751
+ *
752
+ * Search for mapping rules based on given criteria.
753
+ * @see POST /mapping-rules/search
754
+ */
755
+ searchMappingRule(body?: Types.MappingRuleSearchQueryRequest): Promise<Types.MappingRuleSearchQueryResult>;
756
+ /**
757
+ * Get a mapping rule
758
+ *
759
+ * Gets the mapping rule with the given ID.
760
+ * @see GET /mapping-rules/{mappingRuleId}
761
+ */
762
+ getMappingRule(mappingRuleId: string): Promise<Types.MappingRuleResult>;
763
+ /**
764
+ * Update mapping rule
765
+ *
766
+ * Update a mapping rule.
767
+ * @see PUT /mapping-rules/{mappingRuleId}
768
+ */
769
+ updateMappingRule(mappingRuleId: string, body?: Types.MappingRuleUpdateRequest): Promise<Types.MappingRuleUpdateResult>;
770
+ /**
771
+ * Delete a mapping rule
772
+ *
773
+ * Deletes the mapping rule with the given ID.
774
+ * @see DELETE /mapping-rules/{mappingRuleId}
775
+ */
776
+ deleteMappingRule(mappingRuleId: string): Promise<void>;
777
+ }
778
+ export declare class MessageResource extends ResourceBase {
779
+ /**
780
+ * Correlate message
781
+ *
782
+ * Publishes a message and correlates it to a subscription.
783
+ * If correlation is successful it will return the first process instance key the message correlated with.
784
+ * The message is not buffered.
785
+ * @see POST /messages/correlation
786
+ */
787
+ correlateMessage(body: Types.MessageCorrelationRequest): Promise<Types.MessageCorrelationResult>;
788
+ /**
789
+ * Publish message
790
+ *
791
+ * Publishes a single message.
792
+ * Messages are published to specific partitions computed from their correlation keys.
793
+ * Messages can be buffered.
794
+ * @see POST /messages/publication
795
+ */
796
+ publishMessage(body: Types.MessagePublicationRequest): Promise<Types.MessagePublicationResult>;
797
+ }
798
+ export declare class ProcessDefinitionResource extends ResourceBase {
799
+ /**
800
+ * Search process definitions
801
+ *
802
+ * Search for process definitions based on given criteria.
803
+ * @see POST /process-definitions/search
804
+ */
805
+ searchProcessDefinitions(body?: Types.ProcessDefinitionSearchQuery): Promise<Types.ProcessDefinitionSearchQueryResult>;
806
+ /**
807
+ * Get message subscription statistics
808
+ *
809
+ * Get message subscription statistics, grouped by process definition.
810
+ * @see POST /process-definitions/statistics/message-subscriptions
811
+ */
812
+ getProcessDefinitionMessageSubscriptionStatistics(body?: Types.ProcessDefinitionMessageSubscriptionStatisticsQuery): Promise<Types.ProcessDefinitionMessageSubscriptionStatisticsQueryResult>;
813
+ /**
814
+ * Get process instance statistics
815
+ *
816
+ * Get statistics about process instances, grouped by process definition and tenant.
817
+ * @see POST /process-definitions/statistics/process-instances
818
+ */
819
+ getProcessDefinitionInstanceStatistics(body?: Types.ProcessDefinitionInstanceStatisticsQuery): Promise<Types.ProcessDefinitionInstanceStatisticsQueryResult>;
820
+ /**
821
+ * Get process definition
822
+ *
823
+ * Returns process definition as JSON.
824
+ * @see GET /process-definitions/{processDefinitionKey}
825
+ */
826
+ getProcessDefinition(processDefinitionKey: string): Promise<Types.ProcessDefinitionResult>;
827
+ /**
828
+ * Get process start form
829
+ *
830
+ * Get the start form of a process.
831
+ * Note that this endpoint will only return linked forms. This endpoint does not support embedded forms.
832
+ * @see GET /process-definitions/{processDefinitionKey}/form
833
+ */
834
+ getStartProcessForm(processDefinitionKey: string): Promise<Types.FormResult>;
835
+ /**
836
+ * Get process definition statistics
837
+ *
838
+ * Get statistics about elements in currently running process instances by process definition key and search filter.
839
+ * @see POST /process-definitions/{processDefinitionKey}/statistics/element-instances
840
+ */
841
+ getProcessDefinitionStatistics(processDefinitionKey: string, body?: Types.ProcessDefinitionElementStatisticsQuery): Promise<Types.ProcessDefinitionElementStatisticsQueryResult>;
842
+ /**
843
+ * Get process definition XML
844
+ *
845
+ * Returns process definition as XML.
846
+ * @see GET /process-definitions/{processDefinitionKey}/xml
847
+ */
848
+ getProcessDefinitionXML(processDefinitionKey: string): Promise<void>;
849
+ /**
850
+ * Get process instance statistics by version
851
+ *
852
+ * Get statistics about process instances, grouped by version for a given process definition.
853
+ * The process definition ID must be provided as a required field in the request body filter.
854
+ * @see POST /process-definitions/statistics/process-instances-by-version
855
+ */
856
+ getProcessDefinitionInstanceVersionStatistics(body: Types.ProcessDefinitionInstanceVersionStatisticsQuery): Promise<Types.ProcessDefinitionInstanceVersionStatisticsQueryResult>;
857
+ }
858
+ export declare class ProcessInstanceResource extends ResourceBase {
859
+ /**
860
+ * Create process instance
861
+ *
862
+ * Creates and starts an instance of the specified process.
863
+ * The process definition to use to create the instance can be specified either using its unique key
864
+ * (as returned by Deploy resources), or using the BPMN process id and a version.
865
+ * @see POST /process-instances
866
+ */
867
+ createProcessInstance(body: Types.ProcessInstanceCreationInstruction): Promise<Types.CreateProcessInstanceResult>;
868
+ /**
869
+ * Cancel process instances (batch)
870
+ *
871
+ * Cancels multiple running process instances.
872
+ * Since only ACTIVE root instances can be cancelled, any given filters for state and
873
+ * parentProcessInstanceKey are ignored and overridden during this batch operation.
874
+ * @see POST /process-instances/cancellation
875
+ */
876
+ cancelProcessInstancesBatchOperation(body: Types.ProcessInstanceCancellationBatchOperationRequest): Promise<Types.BatchOperationCreatedResult>;
877
+ /**
878
+ * Delete process instances (batch)
879
+ *
880
+ * Delete multiple process instances. This will delete the historic data from secondary storage.
881
+ * Only process instances in a final state (COMPLETED or TERMINATED) can be deleted.
882
+ * This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}).
883
+ * @see POST /process-instances/deletion
884
+ */
885
+ deleteProcessInstancesBatchOperation(body: Types.ProcessInstanceDeletionBatchOperationRequest): Promise<Types.BatchOperationCreatedResult>;
886
+ /**
887
+ * Resolve related incidents (batch)
888
+ *
889
+ * Resolves multiple instances of process instances.
890
+ * Since only process instances with ACTIVE state can have unresolved incidents, any given
891
+ * filters for state are ignored and overridden during this batch operation.
892
+ * @see POST /process-instances/incident-resolution
893
+ */
894
+ resolveIncidentsBatchOperation(body?: Types.ProcessInstanceIncidentResolutionBatchOperationRequest): Promise<Types.BatchOperationCreatedResult>;
895
+ /**
896
+ * Migrate process instances (batch)
897
+ *
898
+ * Migrate multiple process instances.
899
+ * Since only process instances with ACTIVE state can be migrated, any given
900
+ * filters for state are ignored and overridden during this batch operation.
901
+ * @see POST /process-instances/migration
902
+ */
903
+ migrateProcessInstancesBatchOperation(body: Types.ProcessInstanceMigrationBatchOperationRequest): Promise<Types.BatchOperationCreatedResult>;
904
+ /**
905
+ * Modify process instances (batch)
906
+ *
907
+ * Modify multiple process instances.
908
+ * Since only process instances with ACTIVE state can be modified, any given
909
+ * filters for state are ignored and overridden during this batch operation.
910
+ * @see POST /process-instances/modification
911
+ */
912
+ modifyProcessInstancesBatchOperation(body: Types.ProcessInstanceModificationBatchOperationRequest): Promise<Types.BatchOperationCreatedResult>;
913
+ /**
914
+ * Search process instances
915
+ *
916
+ * Search for process instances based on given criteria.
917
+ * @see POST /process-instances/search
918
+ */
919
+ searchProcessInstances(body?: Types.ProcessInstanceSearchQuery): Promise<Types.ProcessInstanceSearchQueryResult>;
920
+ /**
921
+ * Get process instance
922
+ *
923
+ * Get the process instance by the process instance key.
924
+ * @see GET /process-instances/{processInstanceKey}
925
+ */
926
+ getProcessInstance(processInstanceKey: string): Promise<Types.ProcessInstanceResult>;
927
+ /**
928
+ * Get call hierarchy
929
+ *
930
+ * Returns the call hierarchy for a given process instance, showing its ancestry up to the root instance.
931
+ * @see GET /process-instances/{processInstanceKey}/call-hierarchy
932
+ */
933
+ getProcessInstanceCallHierarchy(processInstanceKey: string): Promise<Array<Types.ProcessInstanceCallHierarchyEntry>>;
934
+ /**
935
+ * Cancel process instance
936
+ *
937
+ * Cancels a running process instance. As a cancellation includes more than just the removal of the process instance resource, the cancellation resource must be posted.
938
+ * @see POST /process-instances/{processInstanceKey}/cancellation
939
+ */
940
+ cancelProcessInstance(processInstanceKey: string, body?: Types.CancelProcessInstanceRequest): Promise<void>;
941
+ /**
942
+ * Delete process instance
943
+ *
944
+ * Deletes a process instance. Only instances that are completed or terminated can be deleted.
945
+ * @see POST /process-instances/{processInstanceKey}/deletion
946
+ */
947
+ deleteProcessInstance(processInstanceKey: string, body?: Types.DeleteProcessInstanceRequest): Promise<void>;
948
+ /**
949
+ * Resolve related incidents
950
+ *
951
+ * Creates a batch operation to resolve multiple incidents of a process instance.
952
+ * @see POST /process-instances/{processInstanceKey}/incident-resolution
953
+ */
954
+ resolveProcessInstanceIncidents(processInstanceKey: string): Promise<Types.BatchOperationCreatedResult>;
955
+ /**
956
+ * Search related incidents
957
+ *
958
+ * Search for incidents caused by the process instance or any of its called process or decision instances.
959
+ *
960
+ * Although the `processInstanceKey` is provided as a path parameter to indicate the root process instance,
961
+ * @see POST /process-instances/{processInstanceKey}/incidents/search
962
+ */
963
+ searchProcessInstanceIncidents(processInstanceKey: string, body?: Types.IncidentSearchQuery): Promise<Types.IncidentSearchQueryResult>;
964
+ /**
965
+ * Migrate process instance
966
+ *
967
+ * Migrates a process instance to a new process definition.
968
+ * This request can contain multiple mapping instructions to define mapping between the active
969
+ * process instance's elements and target process definition elements.
970
+ * @see POST /process-instances/{processInstanceKey}/migration
971
+ */
972
+ migrateProcessInstance(processInstanceKey: string, body: Types.ProcessInstanceMigrationInstruction): Promise<void>;
973
+ /**
974
+ * Modify process instance
975
+ *
976
+ * Modifies a running process instance.
977
+ * This request can contain multiple instructions to activate an element of the process or
978
+ * to terminate an active instance of an element.
979
+ * @see POST /process-instances/{processInstanceKey}/modification
980
+ */
981
+ modifyProcessInstance(processInstanceKey: string, body: Types.ProcessInstanceModificationInstruction): Promise<void>;
982
+ /**
983
+ * Get sequence flows
984
+ *
985
+ * Get sequence flows taken by the process instance.
986
+ * @see GET /process-instances/{processInstanceKey}/sequence-flows
987
+ */
988
+ getProcessInstanceSequenceFlows(processInstanceKey: string): Promise<Types.ProcessInstanceSequenceFlowsQueryResult>;
989
+ /**
990
+ * Get element instance statistics
991
+ *
992
+ * Get statistics about elements by the process instance key.
993
+ * @see GET /process-instances/{processInstanceKey}/statistics/element-instances
994
+ */
995
+ getProcessInstanceStatistics(processInstanceKey: string): Promise<Types.ProcessInstanceElementStatisticsQueryResult>;
996
+ }
997
+ export declare class RoleResource extends ResourceBase {
998
+ /**
999
+ * Create role
1000
+ *
1001
+ * Create a new role.
1002
+ * @see POST /roles
1003
+ */
1004
+ createRole(body?: Types.RoleCreateRequest): Promise<Types.RoleCreateResult>;
1005
+ /**
1006
+ * Search roles
1007
+ *
1008
+ * Search for roles based on given criteria.
1009
+ * @see POST /roles/search
1010
+ */
1011
+ searchRoles(body?: Types.RoleSearchQueryRequest): Promise<Types.RoleSearchQueryResult>;
1012
+ /**
1013
+ * Get role
1014
+ *
1015
+ * Get a role by its ID.
1016
+ * @see GET /roles/{roleId}
1017
+ */
1018
+ getRole(roleId: string): Promise<Types.RoleResult>;
1019
+ /**
1020
+ * Update role
1021
+ *
1022
+ * Update a role with the given ID.
1023
+ * @see PUT /roles/{roleId}
1024
+ */
1025
+ updateRole(roleId: string, body: Types.RoleUpdateRequest): Promise<Types.RoleUpdateResult>;
1026
+ /**
1027
+ * Delete role
1028
+ *
1029
+ * Deletes the role with the given ID.
1030
+ * @see DELETE /roles/{roleId}
1031
+ */
1032
+ deleteRole(roleId: string): Promise<void>;
1033
+ /**
1034
+ * Search role clients
1035
+ *
1036
+ * Search clients with assigned role.
1037
+ * @see POST /roles/{roleId}/clients/search
1038
+ */
1039
+ searchClientsForRole(roleId: string, body?: Types.RoleClientSearchQueryRequest): Promise<Types.RoleClientSearchResult>;
1040
+ /**
1041
+ * Assign a role to a client
1042
+ *
1043
+ * Assigns the specified role to the client. The client will inherit the authorizations associated with this role.
1044
+ * @see PUT /roles/{roleId}/clients/{clientId}
1045
+ */
1046
+ assignRoleToClient(roleId: string, clientId: string): Promise<void>;
1047
+ /**
1048
+ * Unassign a role from a client
1049
+ *
1050
+ * Unassigns the specified role from the client. The client will no longer inherit the authorizations associated with this role.
1051
+ * @see DELETE /roles/{roleId}/clients/{clientId}
1052
+ */
1053
+ unassignRoleFromClient(roleId: string, clientId: string): Promise<void>;
1054
+ /**
1055
+ * Search role groups
1056
+ *
1057
+ * Search groups with assigned role.
1058
+ * @see POST /roles/{roleId}/groups/search
1059
+ */
1060
+ searchGroupsForRole(roleId: string, body?: Types.RoleGroupSearchQueryRequest): Promise<Types.RoleGroupSearchResult>;
1061
+ /**
1062
+ * Assign a role to a group
1063
+ *
1064
+ * Assigns the specified role to the group. Every member of the group (user or client) will inherit the authorizations associated with this role.
1065
+ * @see PUT /roles/{roleId}/groups/{groupId}
1066
+ */
1067
+ assignRoleToGroup(roleId: string, groupId: string): Promise<void>;
1068
+ /**
1069
+ * Unassign a role from a group
1070
+ *
1071
+ * Unassigns the specified role from the group. All group members (user or client) no longer inherit the authorizations associated with this role.
1072
+ * @see DELETE /roles/{roleId}/groups/{groupId}
1073
+ */
1074
+ unassignRoleFromGroup(roleId: string, groupId: string): Promise<void>;
1075
+ /**
1076
+ * Search role mapping rules
1077
+ *
1078
+ * Search mapping rules with assigned role.
1079
+ * @see POST /roles/{roleId}/mapping-rules/search
1080
+ */
1081
+ searchMappingRulesForRole(roleId: string, body?: Types.MappingRuleSearchQueryRequest): Promise<Types.RoleMappingRuleSearchResult>;
1082
+ /**
1083
+ * Assign a role to a mapping rule
1084
+ *
1085
+ * Assigns a role to a mapping rule.
1086
+ * @see PUT /roles/{roleId}/mapping-rules/{mappingRuleId}
1087
+ */
1088
+ assignRoleToMappingRule(roleId: string, mappingRuleId: string): Promise<void>;
1089
+ /**
1090
+ * Unassign a role from a mapping rule
1091
+ *
1092
+ * Unassigns a role from a mapping rule.
1093
+ * @see DELETE /roles/{roleId}/mapping-rules/{mappingRuleId}
1094
+ */
1095
+ unassignRoleFromMappingRule(roleId: string, mappingRuleId: string): Promise<void>;
1096
+ /**
1097
+ * Search role users
1098
+ *
1099
+ * Search users with assigned role.
1100
+ * @see POST /roles/{roleId}/users/search
1101
+ */
1102
+ searchUsersForRole(roleId: string, body?: Types.RoleUserSearchQueryRequest): Promise<Types.RoleUserSearchResult>;
1103
+ /**
1104
+ * Assign a role to a user
1105
+ *
1106
+ * Assigns the specified role to the user. The user will inherit the authorizations associated with this role.
1107
+ * @see PUT /roles/{roleId}/users/{username}
1108
+ */
1109
+ assignRoleToUser(roleId: string, username: string): Promise<void>;
1110
+ /**
1111
+ * Unassign a role from a user
1112
+ *
1113
+ * Unassigns a role from a user. The user will no longer inherit the authorizations associated with this role.
1114
+ * @see DELETE /roles/{roleId}/users/{username}
1115
+ */
1116
+ unassignRoleFromUser(roleId: string, username: string): Promise<void>;
1117
+ }
1118
+ export declare class SetupResource extends ResourceBase {
1119
+ /**
1120
+ * Create admin user
1121
+ *
1122
+ * Creates a new user and assigns the admin role to it. This endpoint is only usable when users are managed in the Orchestration Cluster and while no user is assigned to the admin role.
1123
+ * @see POST /setup/user
1124
+ */
1125
+ createAdminUser(body: Types.UserRequest): Promise<Types.UserCreateResult>;
1126
+ }
1127
+ export declare class SignalResource extends ResourceBase {
1128
+ /**
1129
+ * Broadcast signal
1130
+ *
1131
+ * Broadcasts a signal.
1132
+ * @see POST /signals/broadcast
1133
+ */
1134
+ broadcastSignal(body: Types.SignalBroadcastRequest): Promise<Types.SignalBroadcastResult>;
1135
+ }
1136
+ export declare class ClusterResource extends ResourceBase {
1137
+ /**
1138
+ * Get cluster status
1139
+ *
1140
+ * Checks the health status of the cluster by verifying if there's at least one partition with a healthy leader.
1141
+ * @see GET /status
1142
+ */
1143
+ getStatus(): Promise<void>;
1144
+ /**
1145
+ * Get cluster topology
1146
+ *
1147
+ * Obtains the current topology of the cluster the gateway is part of.
1148
+ * @see GET /topology
1149
+ */
1150
+ getTopology(): Promise<Types.TopologyResponse>;
1151
+ }
1152
+ export declare class SystemResource extends ResourceBase {
1153
+ /**
1154
+ * Get usage metrics
1155
+ *
1156
+ * Retrieve the usage metrics based on given criteria.
1157
+ * @see GET /system/usage-metrics
1158
+ */
1159
+ getUsageMetrics(query?: {
1160
+ startTime: string;
1161
+ endTime: string;
1162
+ tenantId?: Types.TenantId;
1163
+ withTenants?: boolean;
1164
+ }): Promise<Types.UsageMetricsResponse>;
1165
+ }
1166
+ export declare class TenantResource extends ResourceBase {
1167
+ /**
1168
+ * Create tenant
1169
+ *
1170
+ * Creates a new tenant.
1171
+ * @see POST /tenants
1172
+ */
1173
+ createTenant(body: Types.TenantCreateRequest): Promise<Types.TenantCreateResult>;
1174
+ /**
1175
+ * Search tenants
1176
+ *
1177
+ * Retrieves a filtered and sorted list of tenants.
1178
+ * @see POST /tenants/search
1179
+ */
1180
+ searchTenants(body?: Types.TenantSearchQueryRequest): Promise<Types.TenantSearchQueryResult>;
1181
+ /**
1182
+ * Get tenant
1183
+ *
1184
+ * Retrieves a single tenant by tenant ID.
1185
+ * @see GET /tenants/{tenantId}
1186
+ */
1187
+ getTenant(tenantId: string): Promise<Types.TenantResult>;
1188
+ /**
1189
+ * Update tenant
1190
+ *
1191
+ * Updates an existing tenant.
1192
+ * @see PUT /tenants/{tenantId}
1193
+ */
1194
+ updateTenant(tenantId: string, body: Types.TenantUpdateRequest): Promise<Types.TenantUpdateResult>;
1195
+ /**
1196
+ * Delete tenant
1197
+ *
1198
+ * Deletes an existing tenant.
1199
+ * @see DELETE /tenants/{tenantId}
1200
+ */
1201
+ deleteTenant(tenantId: string): Promise<void>;
1202
+ /**
1203
+ * Search clients for tenant
1204
+ *
1205
+ * Retrieves a filtered and sorted list of clients for a specified tenant.
1206
+ * @see POST /tenants/{tenantId}/clients/search
1207
+ */
1208
+ searchClientsForTenant(tenantId: string, body?: Types.TenantClientSearchQueryRequest): Promise<Types.TenantClientSearchResult>;
1209
+ /**
1210
+ * Assign a client to a tenant
1211
+ *
1212
+ * Assign the client to the specified tenant.
1213
+ * The client can then access tenant data and perform authorized actions.
1214
+ * @see PUT /tenants/{tenantId}/clients/{clientId}
1215
+ */
1216
+ assignClientToTenant(tenantId: string, clientId: string): Promise<void>;
1217
+ /**
1218
+ * Unassign a client from a tenant
1219
+ *
1220
+ * Unassigns the client from the specified tenant.
1221
+ * The client can no longer access tenant data.
1222
+ * @see DELETE /tenants/{tenantId}/clients/{clientId}
1223
+ */
1224
+ unassignClientFromTenant(tenantId: string, clientId: string): Promise<void>;
1225
+ /**
1226
+ * Search groups for tenant
1227
+ *
1228
+ * Retrieves a filtered and sorted list of groups for a specified tenant.
1229
+ * @see POST /tenants/{tenantId}/groups/search
1230
+ */
1231
+ searchGroupIdsForTenant(tenantId: string, body?: Types.TenantGroupSearchQueryRequest): Promise<Types.TenantGroupSearchResult>;
1232
+ /**
1233
+ * Assign a group to a tenant
1234
+ *
1235
+ * Assigns a group to a specified tenant.
1236
+ * Group members (users, clients) can then access tenant data and perform authorized actions.
1237
+ * @see PUT /tenants/{tenantId}/groups/{groupId}
1238
+ */
1239
+ assignGroupToTenant(tenantId: string, groupId: string): Promise<void>;
1240
+ /**
1241
+ * Unassign a group from a tenant
1242
+ *
1243
+ * Unassigns a group from a specified tenant.
1244
+ * Members of the group (users, clients) will no longer have access to the tenant's data - except they are assigned directly to the tenant.
1245
+ * @see DELETE /tenants/{tenantId}/groups/{groupId}
1246
+ */
1247
+ unassignGroupFromTenant(tenantId: string, groupId: string): Promise<void>;
1248
+ /**
1249
+ * Search mapping rules for tenant
1250
+ *
1251
+ * Retrieves a filtered and sorted list of MappingRules for a specified tenant.
1252
+ * @see POST /tenants/{tenantId}/mapping-rules/search
1253
+ */
1254
+ searchMappingRulesForTenant(tenantId: string, body?: Types.MappingRuleSearchQueryRequest): Promise<Types.TenantMappingRuleSearchResult>;
1255
+ /**
1256
+ * Assign a mapping rule to a tenant
1257
+ *
1258
+ * Assign a single mapping rule to a specified tenant.
1259
+ * @see PUT /tenants/{tenantId}/mapping-rules/{mappingRuleId}
1260
+ */
1261
+ assignMappingRuleToTenant(tenantId: string, mappingRuleId: string): Promise<void>;
1262
+ /**
1263
+ * Unassign a mapping rule from a tenant
1264
+ *
1265
+ * Unassigns a single mapping rule from a specified tenant without deleting the rule.
1266
+ * @see DELETE /tenants/{tenantId}/mapping-rules/{mappingRuleId}
1267
+ */
1268
+ unassignMappingRuleFromTenant(tenantId: string, mappingRuleId: string): Promise<void>;
1269
+ /**
1270
+ * Search roles for tenant
1271
+ *
1272
+ * Retrieves a filtered and sorted list of roles for a specified tenant.
1273
+ * @see POST /tenants/{tenantId}/roles/search
1274
+ */
1275
+ searchRolesForTenant(tenantId: string, body?: Types.RoleSearchQueryRequest): Promise<Types.TenantRoleSearchResult>;
1276
+ /**
1277
+ * Assign a role to a tenant
1278
+ *
1279
+ * Assigns a role to a specified tenant.
1280
+ * Users, Clients or Groups, that have the role assigned, will get access to the tenant's data and can perform actions according to their authorizations.
1281
+ * @see PUT /tenants/{tenantId}/roles/{roleId}
1282
+ */
1283
+ assignRoleToTenant(tenantId: string, roleId: string): Promise<void>;
1284
+ /**
1285
+ * Unassign a role from a tenant
1286
+ *
1287
+ * Unassigns a role from a specified tenant.
1288
+ * Users, Clients or Groups, that have the role assigned, will no longer have access to the
1289
+ * tenant's data - unless they are assigned directly to the tenant.
1290
+ * @see DELETE /tenants/{tenantId}/roles/{roleId}
1291
+ */
1292
+ unassignRoleFromTenant(tenantId: string, roleId: string): Promise<void>;
1293
+ /**
1294
+ * Search users for tenant
1295
+ *
1296
+ * Retrieves a filtered and sorted list of users for a specified tenant.
1297
+ * @see POST /tenants/{tenantId}/users/search
1298
+ */
1299
+ searchUsersForTenant(tenantId: string, body?: Types.TenantUserSearchQueryRequest): Promise<Types.TenantUserSearchResult>;
1300
+ /**
1301
+ * Assign a user to a tenant
1302
+ *
1303
+ * Assign a single user to a specified tenant. The user can then access tenant data and perform authorized actions.
1304
+ * @see PUT /tenants/{tenantId}/users/{username}
1305
+ */
1306
+ assignUserToTenant(tenantId: string, username: string): Promise<void>;
1307
+ /**
1308
+ * Unassign a user from a tenant
1309
+ *
1310
+ * Unassigns the user from the specified tenant.
1311
+ * The user can no longer access tenant data.
1312
+ * @see DELETE /tenants/{tenantId}/users/{username}
1313
+ */
1314
+ unassignUserFromTenant(tenantId: string, username: string): Promise<void>;
1315
+ }
1316
+ export declare class UserResource extends ResourceBase {
1317
+ /**
1318
+ * Create user
1319
+ *
1320
+ * Create a new user.
1321
+ * @see POST /users
1322
+ */
1323
+ createUser(body: Types.UserRequest): Promise<Types.UserCreateResult>;
1324
+ /**
1325
+ * Search users
1326
+ *
1327
+ * Search for users based on given criteria.
1328
+ * @see POST /users/search
1329
+ */
1330
+ searchUsers(body?: Types.UserSearchQueryRequest): Promise<Types.UserSearchResult>;
1331
+ /**
1332
+ * Get user
1333
+ *
1334
+ * Get a user by its username.
1335
+ * @see GET /users/{username}
1336
+ */
1337
+ getUser(username: string): Promise<Types.UserResult>;
1338
+ /**
1339
+ * Update user
1340
+ *
1341
+ * Updates a user.
1342
+ * @see PUT /users/{username}
1343
+ */
1344
+ updateUser(username: string, body: Types.UserUpdateRequest): Promise<Types.UserUpdateResult>;
1345
+ /**
1346
+ * Delete user
1347
+ *
1348
+ * Deletes a user.
1349
+ * @see DELETE /users/{username}
1350
+ */
1351
+ deleteUser(username: string): Promise<void>;
1352
+ }
1353
+ export declare class UserTaskResource extends ResourceBase {
1354
+ /**
1355
+ * Search user tasks
1356
+ *
1357
+ * Search for user tasks based on given criteria.
1358
+ * @see POST /user-tasks/search
1359
+ */
1360
+ searchUserTasks(body?: Types.UserTaskSearchQuery): Promise<Types.UserTaskSearchQueryResult>;
1361
+ /**
1362
+ * Get user task
1363
+ *
1364
+ * Get the user task by the user task key.
1365
+ * @see GET /user-tasks/{userTaskKey}
1366
+ */
1367
+ getUserTask(userTaskKey: string): Promise<Types.UserTaskResult>;
1368
+ /**
1369
+ * Update user task
1370
+ *
1371
+ * Update a user task with the given key.
1372
+ * @see PATCH /user-tasks/{userTaskKey}
1373
+ */
1374
+ updateUserTask(userTaskKey: string, body?: Types.UserTaskUpdateRequest): Promise<void>;
1375
+ /**
1376
+ * Unassign user task
1377
+ *
1378
+ * Removes the assignee of a task with the given key.
1379
+ * @see DELETE /user-tasks/{userTaskKey}/assignee
1380
+ */
1381
+ unassignUserTask(userTaskKey: string): Promise<void>;
1382
+ /**
1383
+ * Assign user task
1384
+ *
1385
+ * Assigns a user task with the given key to the given assignee.
1386
+ * @see POST /user-tasks/{userTaskKey}/assignment
1387
+ */
1388
+ assignUserTask(userTaskKey: string, body: Types.UserTaskAssignmentRequest): Promise<void>;
1389
+ /**
1390
+ * Search user task audit logs
1391
+ *
1392
+ * Search for user task audit logs based on given criteria.
1393
+ * @see POST /user-tasks/{userTaskKey}/audit-logs/search
1394
+ */
1395
+ searchUserTaskAuditLogs(userTaskKey: string, body?: Types.UserTaskAuditLogSearchQueryRequest): Promise<Types.AuditLogSearchQueryResult>;
1396
+ /**
1397
+ * Complete user task
1398
+ *
1399
+ * Completes a user task with the given key.
1400
+ * @see POST /user-tasks/{userTaskKey}/completion
1401
+ */
1402
+ completeUserTask(userTaskKey: string, body?: Types.UserTaskCompletionRequest): Promise<void>;
1403
+ /**
1404
+ * Get user task form
1405
+ *
1406
+ * Get the form of a user task.
1407
+ * Note that this endpoint will only return linked forms. This endpoint does not support embedded forms.
1408
+ * @see GET /user-tasks/{userTaskKey}/form
1409
+ */
1410
+ getUserTaskForm(userTaskKey: string): Promise<Types.FormResult>;
1411
+ /**
1412
+ * Search user task variables
1413
+ *
1414
+ * Search for user task variables based on given criteria. This endpoint returns all variables
1415
+ * visible from the user task's scope, including variables from parent scopes in the scope
1416
+ * hierarchy. By default, long variable values in the response are truncated.
1417
+ * @see POST /user-tasks/{userTaskKey}/variables/search
1418
+ */
1419
+ searchUserTaskVariables(userTaskKey: string, body?: Types.UserTaskVariableSearchQueryRequest, query?: {
1420
+ truncateValues?: boolean;
1421
+ }): Promise<Types.VariableSearchQueryResult>;
1422
+ }
1423
+ export declare class VariableResource extends ResourceBase {
1424
+ /**
1425
+ * Search variables
1426
+ *
1427
+ * Search for variables based on given criteria.
1428
+ *
1429
+ * This endpoint returns variables that exist directly at the specified scopes - it does not
1430
+ * @see POST /variables/search
1431
+ */
1432
+ searchVariables(body?: Types.VariableSearchQuery, query?: {
1433
+ truncateValues?: boolean;
1434
+ }): Promise<Types.VariableSearchQueryResult>;
1435
+ /**
1436
+ * Get variable
1437
+ *
1438
+ * Get a variable by its key.
1439
+ *
1440
+ * This endpoint returns both process-level and local (element-scoped) variables.
1441
+ * @see GET /variables/{variableKey}
1442
+ */
1443
+ getVariable(variableKey: string): Promise<Types.VariableResult>;
1444
+ }
1445
+ /**
1446
+ * Camunda Orchestration Cluster API client.
1447
+ */
1448
+ export declare class CamundaClient extends CamundaBaseClient {
1449
+ /** Audit Log operations */
1450
+ readonly auditLog: AuditLogResource;
1451
+ /** Authentication operations */
1452
+ readonly authentication: AuthenticationResource;
1453
+ /** Authorization operations */
1454
+ readonly authorization: AuthorizationResource;
1455
+ /** Batch operation operations */
1456
+ readonly batchOperation: BatchOperationResource;
1457
+ /** Clock operations */
1458
+ readonly clock: ClockResource;
1459
+ /** Cluster Variable operations */
1460
+ readonly clusterVariable: ClusterVariableResource;
1461
+ /** Conditional operations */
1462
+ readonly conditional: ConditionalResource;
1463
+ /** Message subscription operations */
1464
+ readonly messageSubscription: MessageSubscriptionResource;
1465
+ /** Decision definition operations */
1466
+ readonly decisionDefinition: DecisionDefinitionResource;
1467
+ /** Decision instance operations */
1468
+ readonly decisionInstance: DecisionInstanceResource;
1469
+ /** Decision requirements operations */
1470
+ readonly decisionRequirements: DecisionRequirementsResource;
1471
+ /** Resource operations */
1472
+ readonly resource: ResourceResource;
1473
+ /** Document operations */
1474
+ readonly document: DocumentResource;
1475
+ /** Ad-hoc sub-process operations */
1476
+ readonly adHocSubProcess: AdHocSubProcessResource;
1477
+ /** Element instance operations */
1478
+ readonly elementInstance: ElementInstanceResource;
1479
+ /** Expression operations */
1480
+ readonly expression: ExpressionResource;
1481
+ /** Global listener operations */
1482
+ readonly globalListener: GlobalListenerResource;
1483
+ /** Group operations */
1484
+ readonly group: GroupResource;
1485
+ /** Incident operations */
1486
+ readonly incident: IncidentResource;
1487
+ /** Job operations */
1488
+ readonly job: JobResource;
1489
+ /** License operations */
1490
+ readonly license: LicenseResource;
1491
+ /** Mapping rule operations */
1492
+ readonly mappingRule: MappingRuleResource;
1493
+ /** Message operations */
1494
+ readonly message: MessageResource;
1495
+ /** Process definition operations */
1496
+ readonly processDefinition: ProcessDefinitionResource;
1497
+ /** Process instance operations */
1498
+ readonly processInstance: ProcessInstanceResource;
1499
+ /** Role operations */
1500
+ readonly role: RoleResource;
1501
+ /** Setup operations */
1502
+ readonly setup: SetupResource;
1503
+ /** Signal operations */
1504
+ readonly signal: SignalResource;
1505
+ /** Cluster operations */
1506
+ readonly cluster: ClusterResource;
1507
+ /** System operations */
1508
+ readonly system: SystemResource;
1509
+ /** Tenant operations */
1510
+ readonly tenant: TenantResource;
1511
+ /** User operations */
1512
+ readonly user: UserResource;
1513
+ /** User task operations */
1514
+ readonly userTask: UserTaskResource;
1515
+ /** Variable operations */
1516
+ readonly variable: VariableResource;
1517
+ constructor(config?: CamundaClientInput);
1518
+ }
1519
+ //# sourceMappingURL=resources.d.ts.map