import * as zod from 'zod'; import { z } from 'zod'; import { L as LogLevel, a as LogTransport, b as Logger } from './logger-D-p21VHo.cjs'; import * as node_worker_threads from 'node:worker_threads'; type BackpressureSeverity = 'healthy' | 'soft' | 'severe'; declare const SCHEMA: { readonly CAMUNDA_REST_ADDRESS: { readonly type: "string"; readonly default: "http://localhost:8080/v2"; readonly doc: "Base REST endpoint address."; }; readonly CAMUNDA_SDK_HTTP_RETRY_MAX_ATTEMPTS: { readonly desc: "Maximum total HTTP attempts (including the initial attempt) for transient failures (429,503, network)."; readonly type: "int"; readonly default: 3; }; readonly CAMUNDA_SDK_HTTP_RETRY_BASE_DELAY_MS: { readonly desc: "Base delay in milliseconds for exponential backoff (full jitter) for HTTP retries."; readonly type: "int"; readonly default: 100; }; readonly CAMUNDA_SDK_HTTP_RETRY_MAX_DELAY_MS: { readonly desc: "Maximum delay cap in milliseconds for HTTP retry backoff."; readonly type: "int"; readonly default: 2000; }; readonly CAMUNDA_TOKEN_AUDIENCE: { readonly type: "string"; readonly default: "zeebe.camunda.io"; readonly doc: "Token audience for OAuth flows."; }; readonly CAMUNDA_CLIENT_ID: { readonly type: "string"; readonly doc: "OAuth client id (required when CAMUNDA_AUTH_STRATEGY=OAUTH)."; readonly requiredWhen: { readonly key: "CAMUNDA_AUTH_STRATEGY"; readonly equals: "OAUTH"; }; }; readonly CAMUNDA_CLIENT_SECRET: { readonly type: "string"; readonly secret: true; readonly doc: "OAuth client secret (required when CAMUNDA_AUTH_STRATEGY=OAUTH)."; readonly requiredWhen: { readonly key: "CAMUNDA_AUTH_STRATEGY"; readonly equals: "OAUTH"; }; }; readonly CAMUNDA_OAUTH_URL: { readonly type: "string"; readonly default: "https://login.cloud.camunda.io/oauth/token"; readonly doc: "OAuth token URL."; }; readonly CAMUNDA_OAUTH_GRANT_TYPE: { readonly type: "string"; readonly default: "client_credentials"; readonly doc: "OAuth grant type."; }; readonly CAMUNDA_OAUTH_SCOPE: { readonly type: "string"; readonly doc: "Optional OAuth scope (space-separated)."; }; readonly CAMUNDA_OAUTH_TIMEOUT_MS: { readonly type: "int"; readonly default: 5000; readonly doc: "Timeout in ms for OAuth token fetch."; }; readonly CAMUNDA_OAUTH_RETRY_MAX: { readonly type: "int"; readonly default: 5; readonly doc: "Maximum OAuth token fetch attempts (including initial)."; }; readonly CAMUNDA_OAUTH_RETRY_BASE_DELAY_MS: { readonly type: "int"; readonly default: 1000; readonly doc: "Base delay (ms) for first retry (exponential backoff)."; }; readonly CAMUNDA_OAUTH_CACHE_DIR: { readonly type: "string"; readonly doc: "Directory for disk caching OAuth tokens (Node only)."; }; readonly CAMUNDA_AUTH_STRATEGY: { readonly type: "enum"; readonly choices: readonly ["NONE", "OAUTH", "BASIC"]; readonly default: "NONE"; readonly doc: "Authentication strategy."; }; readonly CAMUNDA_BASIC_AUTH_USERNAME: { readonly type: "string"; readonly doc: "Basic auth username (required when CAMUNDA_AUTH_STRATEGY=BASIC)."; readonly requiredWhen: { readonly key: "CAMUNDA_AUTH_STRATEGY"; readonly equals: "BASIC"; }; }; readonly CAMUNDA_BASIC_AUTH_PASSWORD: { readonly type: "string"; readonly secret: true; readonly doc: "Basic auth password (required when CAMUNDA_AUTH_STRATEGY=BASIC)."; readonly requiredWhen: { readonly key: "CAMUNDA_AUTH_STRATEGY"; readonly equals: "BASIC"; }; }; readonly CAMUNDA_SDK_VALIDATION: { readonly type: "string"; readonly default: "req:none,res:none"; readonly doc: "Validation mini-language controlling req/res modes."; }; readonly CAMUNDA_SDK_LOG_LEVEL: { readonly type: "enum"; readonly choices: readonly ["silent", "error", "warn", "info", "debug", "trace", "silly"]; readonly default: "error"; readonly doc: "SDK log level. \"silly\" adds unsafe deep diagnostics including HTTP request and response bodies."; }; readonly CAMUNDA_SDK_TELEMETRY_LOG: { readonly type: "boolean"; readonly default: false; readonly doc: "Emit telemetry (auth/http/retry) events to the SDK logger automatically (no code)."; }; readonly CAMUNDA_SDK_TELEMETRY_CORRELATION: { readonly type: "boolean"; readonly default: false; readonly doc: "Enable correlation context (withCorrelation helper) when auto telemetry logging is on."; }; readonly CAMUNDA_MTLS_CERT_PATH: { readonly type: "string"; readonly doc: "Path to client certificate (PEM) for mTLS."; }; readonly CAMUNDA_MTLS_KEY_PATH: { readonly type: "string"; readonly doc: "Path to client private key (PEM) for mTLS."; }; readonly CAMUNDA_MTLS_CA_PATH: { readonly type: "string"; readonly doc: "Path to CA certificate bundle (PEM) for mTLS."; }; readonly CAMUNDA_MTLS_KEY_PASSPHRASE: { readonly type: "string"; readonly secret: true; readonly doc: "Optional passphrase for encrypted private key."; }; readonly CAMUNDA_MTLS_CERT: { readonly type: "string"; readonly doc: "Inline PEM client certificate."; }; readonly CAMUNDA_MTLS_KEY: { readonly type: "string"; readonly secret: true; readonly doc: "Inline PEM client private key."; }; readonly CAMUNDA_MTLS_CA: { readonly type: "string"; readonly doc: "Inline PEM CA bundle."; }; readonly CAMUNDA_SDK_EVENTUAL_POLL_DEFAULT_MS: { readonly type: "int"; readonly default: 500; readonly doc: "Default poll interval (ms) for eventually consistent endpoint polling."; }; readonly CAMUNDA_DEFAULT_TENANT_ID: { readonly type: "string"; readonly default: ""; readonly doc: "Default tenant id applied to operations when an explicit tenantId is not provided (branded TenantId)."; }; readonly CAMUNDA_SDK_BACKPRESSURE_INITIAL_MAX: { readonly type: "int"; readonly default: 16; readonly doc: "Initial bootstrap concurrency cap once first backpressure signal occurs."; }; readonly CAMUNDA_SDK_BACKPRESSURE_SOFT_FACTOR: { readonly type: "int"; readonly default: 70; readonly doc: "Percentage (integer) multiplier applied to permits on soft backpressure event (e.g. 70 => 0.7x)."; }; readonly CAMUNDA_SDK_BACKPRESSURE_SEVERE_FACTOR: { readonly type: "int"; readonly default: 50; readonly doc: "Percentage multiplier applied when escalating to severe (e.g. 50 => 0.5x)."; }; readonly CAMUNDA_SDK_BACKPRESSURE_RECOVERY_INTERVAL_MS: { readonly type: "int"; readonly default: 1000; readonly doc: "Interval in ms between passive recovery checks while healthy hints observed."; }; readonly CAMUNDA_SDK_BACKPRESSURE_RECOVERY_STEP: { readonly type: "int"; readonly default: 1; readonly doc: "Permits regained per recovery interval until reaching bootstrap cap."; }; readonly CAMUNDA_SDK_BACKPRESSURE_DECAY_QUIET_MS: { readonly type: "int"; readonly default: 2000; readonly doc: "Quiet period (ms) without backpressure signals required to downgrade severity."; }; readonly CAMUNDA_SDK_BACKPRESSURE_FLOOR: { readonly type: "int"; readonly default: 1; readonly doc: "Minimum floor concurrency when degraded."; }; readonly CAMUNDA_SDK_BACKPRESSURE_SEVERE_THRESHOLD: { readonly type: "int"; readonly default: 3; readonly doc: "Consecutive backpressure events required to enter severe state."; }; readonly CAMUNDA_SDK_BACKPRESSURE_MAX_WAITERS: { readonly type: "int"; readonly default: 1000; readonly doc: "Maximum number of queued waiters before fail-fast rejection to prevent unbounded memory growth."; }; readonly CAMUNDA_SDK_BACKPRESSURE_HEALTHY_RECOVERY_MULTIPLIER: { readonly type: "int"; readonly default: 150; readonly doc: "Percentage (integer) multiplicative growth factor for permits during healthy recovery (e.g. 150 => 1.5x). Applied each recovery interval once severity is healthy."; }; readonly CAMUNDA_SDK_BACKPRESSURE_UNLIMITED_AFTER_HEALTHY_MS: { readonly type: "int"; readonly default: 30000; readonly doc: "Sustained healthy period (ms) after which permits return to unlimited (no cap)."; }; readonly CAMUNDA_SDK_BACKPRESSURE_PROFILE: { readonly type: "enum"; readonly choices: readonly ["BALANCED", "CONSERVATIVE", "AGGRESSIVE", "LEGACY"]; readonly default: "BALANCED"; readonly doc: "Preset profile for backpressure tuning (LEGACY = observe-only, no gating; other profiles enable adaptive global concurrency control)."; }; readonly CAMUNDA_SUPPORT_LOG_ENABLED: { readonly type: "boolean"; readonly default: false; readonly doc: "Enable creation of a support log file with environment & configuration diagnostics (Node-only)."; }; readonly CAMUNDA_SUPPORT_LOG_FILE_PATH: { readonly type: "string"; readonly doc: "Override support log output file path (default: ./camunda-support.log in current working directory)."; }; readonly CAMUNDA_SUPPORT_LOGGER: { readonly type: "boolean"; readonly default: false; readonly doc: "Alias for CAMUNDA_SUPPORT_LOG_ENABLED (deprecated)."; }; readonly CAMUNDA_WORKER_TIMEOUT: { readonly type: "int"; readonly doc: "Default job timeout in ms for all workers. Individual JobWorkerConfig.jobTimeoutMs overrides this."; }; readonly CAMUNDA_WORKER_MAX_CONCURRENT_JOBS: { readonly type: "int"; readonly doc: "Default max parallel jobs for all workers. Individual JobWorkerConfig.maxParallelJobs overrides this."; }; readonly CAMUNDA_WORKER_REQUEST_TIMEOUT: { readonly type: "signedInt"; readonly doc: "Default long-poll timeout in ms for all workers. Negative values cause activation to complete immediately when no jobs are available. Individual JobWorkerConfig.pollTimeoutMs overrides this."; }; readonly CAMUNDA_WORKER_NAME: { readonly type: "string"; readonly doc: "Default worker name for all workers. Individual JobWorkerConfig.workerName overrides this."; }; readonly CAMUNDA_WORKER_STARTUP_JITTER_MAX_SECONDS: { readonly type: "int"; readonly doc: "Default startup jitter in seconds for all workers. Individual JobWorkerConfig.startupJitterMaxSeconds overrides this."; }; }; type EnvVarKey = keyof typeof SCHEMA; type PrimitiveType = T extends { type: 'string'; } ? string : T extends { type: 'boolean'; } ? boolean : T extends { type: 'int' | 'signedInt'; } ? number : T extends { type: 'enum'; choices: readonly (infer C)[]; } ? C : never; type EnvVarValue = PrimitiveType<(typeof SCHEMA)[K]>; type EnvOverrides = Partial<{ [K in EnvVarKey]: EnvVarValue; }>; type AuthStrategy = 'NONE' | 'OAUTH' | 'BASIC'; type ValidationMode = 'none' | 'warn' | 'strict' | 'fanatical'; interface CamundaConfig { restAddress: string; tokenAudience: string; defaultTenantId: string; httpRetry: { maxAttempts: number; baseDelayMs: number; maxDelayMs: number; }; backpressure: { enabled: boolean; profile: string; observeOnly: boolean; initialMax: number; softFactor: number; severeFactor: number; recoveryIntervalMs: number; recoveryStep: number; decayQuietMs: number; floor: number; severeThreshold: number; maxWaiters: number; healthyRecoveryMultiplier: number; unlimitedAfterHealthyMs: number; }; oauth: { clientId?: string; clientSecret?: string; oauthUrl: string; grantType: string; scope?: string; timeoutMs: number; retry: { max: number; baseDelayMs: number; }; cacheDir?: string; }; auth: { strategy: AuthStrategy; basic?: { username?: string; password?: string; }; }; validation: { req: ValidationMode; res: ValidationMode; raw: string; }; logLevel: 'silent' | 'error' | 'warn' | 'info' | 'debug' | 'trace'; eventual?: { pollDefaultMs: number; }; mtls?: { cert?: string; key?: string; ca?: string; keyPassphrase?: string; certPath?: string; keyPath?: string; caPath?: string; }; telemetry?: { log: boolean; correlation: boolean; }; supportLog?: { enabled: boolean; filePath: string; }; workerDefaults?: { jobTimeoutMs?: number; maxParallelJobs?: number; pollTimeoutMs?: number; workerName?: string; startupJitterMaxSeconds?: number; }; __raw: Record; } interface SupportLogger { log(message: string | number | boolean | object, addTimestamp?: boolean): void; } interface TelemetryHooks { beforeRequest?(e: TelemetryHttpStartEvent): void; afterResponse?(e: TelemetryHttpEndEvent): void; requestError?(e: TelemetryHttpErrorEvent): void; authStart?(e: TelemetryAuthStartEvent): void; authSuccess?(e: TelemetryAuthSuccessEvent): void; authError?(e: TelemetryAuthErrorEvent): void; retry?(e: TelemetryRetryEvent): void; } interface BaseEvt { ts: number; correlationId?: string; requestId: string; } interface TelemetryHttpStartEvent extends BaseEvt { type: 'http.start'; method: string; url: string; attempt: number; } interface TelemetryHttpEndEvent extends BaseEvt { type: 'http.end'; method: string; url: string; attempt: number; status: number; durationMs: number; } interface TelemetryHttpErrorEvent extends BaseEvt { type: 'http.error'; method: string; url: string; attempt: number; errorKind: 'network' | 'abort'; message: string; durationMs: number; } interface TelemetryAuthStartEvent { type: 'auth.start'; ts: number; correlationId?: string; audience: string; endpoint: string; cache: boolean; } interface TelemetryAuthSuccessEvent { type: 'auth.success'; ts: number; correlationId?: string; audience: string; endpoint: string; cached: boolean; durationMs: number; expiresInSec: number; scopes?: string[]; } interface TelemetryAuthErrorEvent { type: 'auth.error'; ts: number; correlationId?: string; audience: string; endpoint: string; durationMs: number; status?: number; message: string; } interface TelemetryRetryEvent { type: 'retry'; ts: number; correlationId?: string; attempt: number; nextDelayMs: number; reason: string; domain: 'auth'; } type AuthToken = string | undefined; interface Auth { /** * Which part of the request do we use to send the auth? * * @default 'header' */ in?: 'header' | 'query' | 'cookie'; /** * Header or query parameter name. * * @default 'Authorization' */ name?: string; scheme?: 'basic' | 'bearer'; type: 'apiKey' | 'http'; } interface SerializerOptions { /** * @default true */ explode: boolean; style: T; } type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited'; type ObjectStyle = 'form' | 'deepObject'; type QuerySerializer = (query: Record) => string; type BodySerializer = (body: any) => any; type QuerySerializerOptionsObject = { allowReserved?: boolean; array?: Partial>; object?: Partial>; }; type QuerySerializerOptions = QuerySerializerOptionsObject & { /** * Per-parameter serialization overrides. When provided, these settings * override the global array/object settings for specific parameter names. */ parameters?: Record; }; type HttpMethod = 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace'; type Client$1 = { /** * Returns the final request URL. */ buildUrl: BuildUrlFn; getConfig: () => Config; request: RequestFn; setConfig: (config: Config) => Config; } & { [K in HttpMethod]: MethodFn; } & ([SseFn] extends [never] ? { sse?: never; } : { sse: { [K in HttpMethod]: SseFn; }; }); interface Config$1 { /** * Auth token or a function returning auth token. The resolved value will be * added to the request payload as defined by its `security` array. */ auth?: ((auth: Auth) => Promise | AuthToken) | AuthToken; /** * A function for serializing request body parameter. By default, * {@link JSON.stringify()} will be used. */ bodySerializer?: BodySerializer | null; /** * An object containing any HTTP headers that you want to pre-populate your * `Headers` object with. * * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more} */ headers?: RequestInit['headers'] | Record; /** * The request method. * * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more} */ method?: Uppercase; /** * A function for serializing request query parameters. By default, arrays * will be exploded in form style, objects will be exploded in deepObject * style, and reserved characters are percent-encoded. * * This method will have no effect if the native `paramsSerializer()` Axios * API function is used. * * {@link https://swagger.io/docs/specification/serialization/#query View examples} */ querySerializer?: QuerySerializer | QuerySerializerOptions; /** * A function validating request data. This is useful if you want to ensure * the request conforms to the desired shape, so it can be safely sent to * the server. */ requestValidator?: (data: unknown) => Promise; /** * A function transforming response data before it's returned. This is useful * for post-processing data, e.g. converting ISO strings into Date objects. */ responseTransformer?: (data: unknown) => Promise; /** * A function validating response data. This is useful if you want to ensure * the response conforms to the desired shape, so it can be safely passed to * the transformers and returned to the user. */ responseValidator?: (data: unknown) => Promise; } type ServerSentEventsOptions = Omit & Pick & { /** * Fetch API implementation. You can use this option to provide a custom * fetch instance. * * @default globalThis.fetch */ fetch?: typeof fetch; /** * Implementing clients can call request interceptors inside this hook. */ onRequest?: (url: string, init: RequestInit) => Promise; /** * Callback invoked when a network or parsing error occurs during streaming. * * This option applies only if the endpoint returns a stream of events. * * @param error The error that occurred. */ onSseError?: (error: unknown) => void; /** * Callback invoked when an event is streamed from the server. * * This option applies only if the endpoint returns a stream of events. * * @param event Event streamed from the server. * @returns Nothing (void). */ onSseEvent?: (event: StreamEvent) => void; serializedBody?: RequestInit['body']; /** * Default retry delay in milliseconds. * * This option applies only if the endpoint returns a stream of events. * * @default 3000 */ sseDefaultRetryDelay?: number; /** * Maximum number of retry attempts before giving up. */ sseMaxRetryAttempts?: number; /** * Maximum retry delay in milliseconds. * * Applies only when exponential backoff is used. * * This option applies only if the endpoint returns a stream of events. * * @default 30000 */ sseMaxRetryDelay?: number; /** * Optional sleep function for retry backoff. * * Defaults to using `setTimeout`. */ sseSleepFn?: (ms: number) => Promise; url: string; }; interface StreamEvent { data: TData; event?: string; id?: string; retry?: number; } type ServerSentEventsResult = { stream: AsyncGenerator ? TData[keyof TData] : TData, TReturn, TNext>; }; type ErrInterceptor = (error: Err, response: Res, request: Req, options: Options) => Err | Promise; type ReqInterceptor = (request: Req, options: Options) => Req | Promise; type ResInterceptor = (response: Res, request: Req, options: Options) => Res | Promise; declare class Interceptors { fns: Array; clear(): void; eject(id: number | Interceptor): void; exists(id: number | Interceptor): boolean; getInterceptorIndex(id: number | Interceptor): number; update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false; use(fn: Interceptor): number; } interface Middleware { error: Interceptors>; request: Interceptors>; response: Interceptors>; } type ResponseStyle = 'data' | 'fields'; interface Config extends Omit, Config$1 { /** * Base URL for all requests made by this client. */ baseUrl?: T['baseUrl']; /** * Fetch API implementation. You can use this option to provide a custom * fetch instance. * * @default globalThis.fetch */ fetch?: typeof fetch; /** * Please don't use the Fetch client for Next.js applications. The `next` * options won't have any effect. * * Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead. */ next?: never; /** * Return the response data parsed in a specified format. By default, `auto` * will infer the appropriate method from the `Content-Type` response header. * You can override this behavior with any of the {@link Body} methods. * Select `stream` if you don't want to parse response data at all. * * @default 'auto' */ parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text'; /** * Should we return only data or multiple fields (data, error, response, etc.)? * * @default 'fields' */ responseStyle?: ResponseStyle; /** * Throw an error instead of returning it in the response? * * @default false */ throwOnError?: T['throwOnError']; } interface RequestOptions extends Config<{ responseStyle: TResponseStyle; throwOnError: ThrowOnError; }>, Pick, 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> { /** * Any body that you want to add to your request. * * {@link https://developer.mozilla.org/docs/Web/API/fetch#body} */ body?: unknown; path?: Record; query?: Record; /** * Security mechanism(s) to use for the request. */ security?: ReadonlyArray; url: Url; } interface ResolvedRequestOptions extends RequestOptions { serializedBody?: string; } type RequestResult = ThrowOnError extends true ? Promise ? TData[keyof TData] : TData : { data: TData extends Record ? TData[keyof TData] : TData; request: Request; response: Response; }> : Promise ? TData[keyof TData] : TData) | undefined : ({ data: TData extends Record ? TData[keyof TData] : TData; error: undefined; } | { data: undefined; error: TError extends Record ? TError[keyof TError] : TError; }) & { request: Request; response: Response; }>; interface ClientOptions$1 { baseUrl?: string; responseStyle?: ResponseStyle; throwOnError?: boolean; } type MethodFn = (options: Omit, 'method'>) => RequestResult; type SseFn = (options: Omit, 'method'>) => Promise>; type RequestFn = (options: Omit, 'method'> & Pick>, 'method'>) => RequestResult; type BuildUrlFn = ; query?: Record; url: string; }>(options: TData & Options$1) => string; type Client = Client$1 & { interceptors: Middleware; }; interface TDataShape { body?: unknown; headers?: unknown; path?: unknown; query?: unknown; url: string; } type OmitKeys = Pick>; type Options$1 = OmitKeys, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit); type CamundaKey = string & { readonly __brand: T; }; type ClientOptions = { baseUrl: '{schema}://{host}:{port}/v2' | (string & {}); }; /** * Audit log item. */ type AuditLogResult = { /** * The unique key of the audit log entry. */ auditLogKey: AuditLogKey; entityKey: AuditLogEntityKey; entityType: AuditLogEntityTypeEnum; operationType: AuditLogOperationTypeEnum; /** * Key of the batch operation. */ batchOperationKey: BatchOperationKey | null; /** * The type of batch operation performed, if this is part of a batch. */ batchOperationType: BatchOperationTypeEnum | null; /** * The timestamp when the operation occurred. */ timestamp: string; /** * The ID of the actor who performed the operation. */ actorId: string | null; /** * The type of the actor who performed the operation. */ actorType: AuditLogActorTypeEnum | null; /** * The element ID of the agent that performed the operation (e.g. ad-hoc subprocess element ID). */ agentElementId: string | null; /** * The tenant ID of the audit log. */ tenantId: TenantId | null; result: AuditLogResultEnum; category: AuditLogCategoryEnum; /** * The process definition ID. */ processDefinitionId: ProcessDefinitionId | null; /** * The key of the process definition. */ processDefinitionKey: ProcessDefinitionKey | null; /** * The key of the process instance. */ processInstanceKey: ProcessInstanceKey | null; /** * The key of the root process instance. The root process instance is the top-level * ancestor in the process instance hierarchy. This field is only present for data * belonging to process instance hierarchies created in version 8.9 or later. * */ rootProcessInstanceKey: ProcessInstanceKey | null; /** * The key of the element instance. */ elementInstanceKey: ElementInstanceKey | null; /** * The key of the job. */ jobKey: JobKey | null; /** * The key of the user task. */ userTaskKey: UserTaskKey | null; /** * The decision requirements ID. */ decisionRequirementsId: string | null; /** * The assigned key of the decision requirements. */ decisionRequirementsKey: DecisionRequirementsKey | null; /** * The decision definition ID. */ decisionDefinitionId: DecisionDefinitionId | null; /** * The key of the decision definition. */ decisionDefinitionKey: DecisionDefinitionKey | null; /** * The key of the decision evaluation. */ decisionEvaluationKey: DecisionEvaluationKey | null; /** * The key of the deployment. */ deploymentKey: DeploymentKey | null; /** * The key of the form. */ formKey: FormKey | null; /** * The system-assigned key for this resource. */ resourceKey: ResourceKey | null; /** * The key of the related entity. The content depends on the operation type and entity type. * For example, for authorization operations, this will contain the ID of the owner (e.g., user or group) the authorization belongs to. * */ relatedEntityKey: AuditLogEntityKey | null; /** * The type of the related entity. The content depends on the operation type and entity type. * For example, for authorization operations, this will contain the type of the owner (e.g., USER or GROUP) the authorization belongs to. * */ relatedEntityType: AuditLogEntityTypeEnum | null; /** * Additional description of the entity affected by the operation. * For example, for variable operations, this will contain the variable name. * */ entityDescription: string | null; }; type AuditLogSearchQuerySortRequest = { /** * The field to sort by. */ field: 'actorId' | 'actorType' | 'auditLogKey' | 'batchOperationKey' | 'batchOperationType' | 'category' | 'decisionDefinitionId' | 'decisionDefinitionKey' | 'decisionEvaluationKey' | 'decisionRequirementsId' | 'decisionRequirementsKey' | 'elementInstanceKey' | 'entityKey' | 'entityType' | 'jobKey' | 'operationType' | 'processDefinitionId' | 'processDefinitionKey' | 'processInstanceKey' | 'result' | 'tenantId' | 'timestamp' | 'userTaskKey'; order?: SortOrderEnum; }; /** * Audit log search request. */ type AuditLogSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The audit log search filters. */ filter?: AuditLogFilter; }; /** * Audit log filter request */ type AuditLogFilter = { /** * The audit log key search filter. */ auditLogKey?: AuditLogKeyFilterProperty; /** * The process definition key search filter. */ processDefinitionKey?: ProcessDefinitionKeyFilterProperty; /** * The process instance key search filter. */ processInstanceKey?: ProcessInstanceKeyFilterProperty; /** * The element instance key search filter. */ elementInstanceKey?: ElementInstanceKeyFilterProperty; /** * The operation type search filter. */ operationType?: OperationTypeFilterProperty; /** * The result search filter. */ result?: AuditLogResultFilterProperty; /** * The timestamp search filter. */ timestamp?: DateTimeFilterProperty; /** * The actor ID search filter. */ actorId?: StringFilterProperty; /** * The actor type search filter. */ actorType?: AuditLogActorTypeFilterProperty; /** * The agent element ID search filter. */ agentElementId?: StringFilterProperty; /** * The entity key search filter. */ entityKey?: AuditLogEntityKeyFilterProperty; /** * The entity type search filter. */ entityType?: EntityTypeFilterProperty; /** * The tenant ID search filter. */ tenantId?: StringFilterProperty; /** * The category search filter. */ category?: CategoryFilterProperty; /** * The deployment key search filter. */ deploymentKey?: DeploymentKeyFilterProperty; /** * The form key search filter. */ formKey?: FormKeyFilterProperty; /** * The resource key search filter. */ resourceKey?: ResourceKeyFilterProperty; /** * The batch operation type search filter. */ batchOperationType?: BatchOperationTypeFilterProperty; /** * The process definition ID search filter. */ processDefinitionId?: StringFilterProperty; /** * The job key search filter. */ jobKey?: JobKeyFilterProperty; /** * The user task key search filter. */ userTaskKey?: BasicStringFilterProperty; /** * The decision requirements ID search filter. */ decisionRequirementsId?: StringFilterProperty; /** * The decision requirements key search filter. */ decisionRequirementsKey?: DecisionRequirementsKeyFilterProperty; /** * The decision definition ID search filter. */ decisionDefinitionId?: StringFilterProperty; /** * The decision definition key search filter. */ decisionDefinitionKey?: DecisionDefinitionKeyFilterProperty; /** * The decision evaluation key search filter. */ decisionEvaluationKey?: DecisionEvaluationKeyFilterProperty; /** * The related entity key search filter. */ relatedEntityKey?: AuditLogEntityKeyFilterProperty; /** * The related entity type search filter. */ relatedEntityType?: EntityTypeFilterProperty; /** * The entity description filter. */ entityDescription?: StringFilterProperty; }; /** * Audit log search response. */ type AuditLogSearchQueryResult = SearchQueryResponse & { /** * The matching audit logs. */ items: Array; }; /** * The type of entity affected by the operation. */ declare const AuditLogEntityTypeEnum: { readonly AUTHORIZATION: "AUTHORIZATION"; readonly BATCH: "BATCH"; readonly DECISION: "DECISION"; readonly GROUP: "GROUP"; readonly INCIDENT: "INCIDENT"; readonly JOB: "JOB"; readonly MAPPING_RULE: "MAPPING_RULE"; readonly PROCESS_INSTANCE: "PROCESS_INSTANCE"; readonly RESOURCE: "RESOURCE"; readonly ROLE: "ROLE"; readonly TENANT: "TENANT"; readonly USER: "USER"; readonly USER_TASK: "USER_TASK"; readonly VARIABLE: "VARIABLE"; readonly CLIENT: "CLIENT"; }; type AuditLogEntityTypeEnum = (typeof AuditLogEntityTypeEnum)[keyof typeof AuditLogEntityTypeEnum]; /** * The type of operation performed. */ declare const AuditLogOperationTypeEnum: { readonly ASSIGN: "ASSIGN"; readonly CANCEL: "CANCEL"; readonly COMPLETE: "COMPLETE"; readonly CREATE: "CREATE"; readonly DELETE: "DELETE"; readonly EVALUATE: "EVALUATE"; readonly MIGRATE: "MIGRATE"; readonly MODIFY: "MODIFY"; readonly RESOLVE: "RESOLVE"; readonly RESUME: "RESUME"; readonly SUSPEND: "SUSPEND"; readonly UNASSIGN: "UNASSIGN"; readonly UNKNOWN: "UNKNOWN"; readonly UPDATE: "UPDATE"; }; type AuditLogOperationTypeEnum = (typeof AuditLogOperationTypeEnum)[keyof typeof AuditLogOperationTypeEnum]; /** * The type of actor who performed the operation. */ declare const AuditLogActorTypeEnum: { readonly ANONYMOUS: "ANONYMOUS"; readonly CLIENT: "CLIENT"; readonly UNKNOWN: "UNKNOWN"; readonly USER: "USER"; }; type AuditLogActorTypeEnum = (typeof AuditLogActorTypeEnum)[keyof typeof AuditLogActorTypeEnum]; /** * The result status of the operation. */ declare const AuditLogResultEnum: { readonly FAIL: "FAIL"; readonly SUCCESS: "SUCCESS"; }; type AuditLogResultEnum = (typeof AuditLogResultEnum)[keyof typeof AuditLogResultEnum]; /** * The category of the audit log operation. */ declare const AuditLogCategoryEnum: { readonly ADMIN: "ADMIN"; readonly DEPLOYED_RESOURCES: "DEPLOYED_RESOURCES"; readonly USER_TASKS: "USER_TASKS"; }; type AuditLogCategoryEnum = (typeof AuditLogCategoryEnum)[keyof typeof AuditLogCategoryEnum]; /** * EntityKey property with full advanced search capabilities. */ type AuditLogEntityKeyFilterProperty = AuditLogEntityKeyExactMatch | AdvancedAuditLogEntityKeyFilter; /** * Advanced filter * * Advanced entityKey filter. */ type AdvancedAuditLogEntityKeyFilter = { /** * Checks for equality with the provided value. */ $eq?: AuditLogEntityKey; /** * Checks for inequality with the provided value. */ $neq?: AuditLogEntityKey; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; }; /** * AuditLogEntityTypeEnum property with full advanced search capabilities. */ type EntityTypeFilterProperty = EntityTypeExactMatch | AdvancedEntityTypeFilter; /** * Advanced filter * * Advanced AuditLogEntityTypeEnum filter. */ type AdvancedEntityTypeFilter = { /** * Checks for equality with the provided value. */ $eq?: AuditLogEntityTypeEnum; /** * Checks for inequality with the provided value. */ $neq?: AuditLogEntityTypeEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; /** * AuditLogOperationTypeEnum property with full advanced search capabilities. */ type OperationTypeFilterProperty = OperationTypeExactMatch | AdvancedOperationTypeFilter; /** * Advanced filter * * Advanced AuditLogOperationTypeEnum filter. */ type AdvancedOperationTypeFilter = { /** * Checks for equality with the provided value. */ $eq?: AuditLogOperationTypeEnum; /** * Checks for inequality with the provided value. */ $neq?: AuditLogOperationTypeEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; /** * AuditLogCategoryEnum property with full advanced search capabilities. */ type CategoryFilterProperty = CategoryExactMatch | AdvancedCategoryFilter; /** * Advanced filter * * Advanced AuditLogCategoryEnum filter. */ type AdvancedCategoryFilter = { /** * Checks for equality with the provided value. */ $eq?: AuditLogCategoryEnum; /** * Checks for inequality with the provided value. */ $neq?: AuditLogCategoryEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; /** * AuditLogResultEnum property with full advanced search capabilities. */ type AuditLogResultFilterProperty = AuditLogResultExactMatch | AdvancedResultFilter; /** * Advanced filter * * Advanced AuditLogResultEnum filter. */ type AdvancedResultFilter = { /** * Checks for equality with the provided value. */ $eq?: AuditLogResultEnum; /** * Checks for inequality with the provided value. */ $neq?: AuditLogResultEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; /** * AuditLogActorTypeEnum property with full advanced search capabilities. */ type AuditLogActorTypeFilterProperty = AuditLogActorTypeExactMatch | AdvancedActorTypeFilter; /** * Advanced filter * * Advanced AuditLogActorTypeEnum filter. */ type AdvancedActorTypeFilter = { /** * Checks for equality with the provided value. */ $eq?: AuditLogActorTypeEnum; /** * Checks for inequality with the provided value. */ $neq?: AuditLogActorTypeEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; type CamundaUserResult = { /** * The username of the user. */ username: Username; /** * The display name of the user. */ displayName: string | null; /** * The email of the user. */ email: string | null; /** * The web components the user is authorized to use. */ authorizedComponents: Array; /** * The tenants the user is a member of. */ tenants: Array; /** * The groups assigned to the user. */ groups: Array; /** * The roles assigned to the user. */ roles: Array; /** * The plan of the user. */ salesPlanType: string | null; /** * The links to the components in the C8 stack. */ c8Links: { [key: string]: string; }; /** * Flag for understanding if the user is able to perform logout. */ canLogout: boolean; }; type AuthorizationIdBasedRequest = { /** * The ID of the owner of the permissions. */ ownerId: string; ownerType: OwnerTypeEnum; /** * The ID of the resource to add permissions to. */ resourceId: string; /** * The type of resource to add permissions to. */ resourceType: ResourceTypeEnum; /** * The permission types to add. */ permissionTypes: Array; }; type AuthorizationPropertyBasedRequest = { /** * The ID of the owner of the permissions. */ ownerId: string; ownerType: OwnerTypeEnum; /** * The name of the resource property on which this authorization is based. */ resourcePropertyName: string; /** * The type of resource to add permissions to. */ resourceType: ResourceTypeEnum; /** * The permission types to add. */ permissionTypes: Array; }; /** * Defines an authorization request. * Either an id-based or a property-based authorization can be provided. * */ type AuthorizationRequest = AuthorizationIdBasedRequest | AuthorizationPropertyBasedRequest; type AuthorizationSearchQuerySortRequest = { /** * The field to sort by. */ field: 'ownerId' | 'ownerType' | 'resourceId' | 'resourcePropertyName' | 'resourceType'; order?: SortOrderEnum; }; type AuthorizationSearchQuery = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The authorization search filters. */ filter?: AuthorizationFilter; }; /** * Authorization search filter. */ type AuthorizationFilter = { /** * The ID of the owner of permissions. */ ownerId?: string; ownerType?: OwnerTypeEnum; /** * The IDs of the resource to search permissions for. */ resourceIds?: Array; /** * The names of the resource properties to search permissions for. */ resourcePropertyNames?: Array; /** * The type of resource to search permissions for. */ resourceType?: ResourceTypeEnum; }; type AuthorizationResult = { /** * The ID of the owner of permissions. */ ownerId: string; ownerType: OwnerTypeEnum; /** * The type of resource that the permissions relate to. */ resourceType: ResourceTypeEnum; /** * ID of the resource the permission relates to (mutually exclusive with `resourcePropertyName`). */ resourceId: string | null; /** * The name of the resource property the permission relates to (mutually exclusive with `resourceId`). */ resourcePropertyName: string | null; /** * Specifies the types of the permissions. */ permissionTypes: Array; /** * The key of the authorization. */ authorizationKey: AuthorizationKey; }; type AuthorizationSearchResult = SearchQueryResponse & { /** * The matching authorizations. */ items: Array; }; type AuthorizationCreateResult = { /** * The key of the created authorization. */ authorizationKey: AuthorizationKey; }; /** * Specifies the type of permissions. */ declare const PermissionTypeEnum: { readonly ACCESS: "ACCESS"; readonly CANCEL_PROCESS_INSTANCE: "CANCEL_PROCESS_INSTANCE"; readonly CLAIM: "CLAIM"; readonly CLAIM_USER_TASK: "CLAIM_USER_TASK"; readonly COMPLETE: "COMPLETE"; readonly COMPLETE_USER_TASK: "COMPLETE_USER_TASK"; readonly CREATE: "CREATE"; readonly CREATE_BATCH_OPERATION_CANCEL_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_CANCEL_PROCESS_INSTANCE"; readonly CREATE_BATCH_OPERATION_DELETE_DECISION_DEFINITION: "CREATE_BATCH_OPERATION_DELETE_DECISION_DEFINITION"; readonly CREATE_BATCH_OPERATION_DELETE_DECISION_INSTANCE: "CREATE_BATCH_OPERATION_DELETE_DECISION_INSTANCE"; readonly CREATE_BATCH_OPERATION_DELETE_PROCESS_DEFINITION: "CREATE_BATCH_OPERATION_DELETE_PROCESS_DEFINITION"; readonly CREATE_BATCH_OPERATION_DELETE_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_DELETE_PROCESS_INSTANCE"; readonly CREATE_BATCH_OPERATION_MIGRATE_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_MIGRATE_PROCESS_INSTANCE"; readonly CREATE_BATCH_OPERATION_MODIFY_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_MODIFY_PROCESS_INSTANCE"; readonly CREATE_BATCH_OPERATION_RESOLVE_INCIDENT: "CREATE_BATCH_OPERATION_RESOLVE_INCIDENT"; readonly CREATE_DECISION_INSTANCE: "CREATE_DECISION_INSTANCE"; readonly CREATE_PROCESS_INSTANCE: "CREATE_PROCESS_INSTANCE"; readonly CREATE_TASK_LISTENER: "CREATE_TASK_LISTENER"; readonly DELETE: "DELETE"; readonly DELETE_DECISION_INSTANCE: "DELETE_DECISION_INSTANCE"; readonly DELETE_DRD: "DELETE_DRD"; readonly DELETE_FORM: "DELETE_FORM"; readonly DELETE_PROCESS: "DELETE_PROCESS"; readonly DELETE_PROCESS_INSTANCE: "DELETE_PROCESS_INSTANCE"; readonly DELETE_RESOURCE: "DELETE_RESOURCE"; readonly DELETE_TASK_LISTENER: "DELETE_TASK_LISTENER"; readonly EVALUATE: "EVALUATE"; readonly MODIFY_PROCESS_INSTANCE: "MODIFY_PROCESS_INSTANCE"; readonly READ: "READ"; readonly READ_DECISION_DEFINITION: "READ_DECISION_DEFINITION"; readonly READ_DECISION_INSTANCE: "READ_DECISION_INSTANCE"; readonly READ_JOB_METRIC: "READ_JOB_METRIC"; readonly READ_PROCESS_DEFINITION: "READ_PROCESS_DEFINITION"; readonly READ_PROCESS_INSTANCE: "READ_PROCESS_INSTANCE"; readonly READ_USAGE_METRIC: "READ_USAGE_METRIC"; readonly READ_USER_TASK: "READ_USER_TASK"; readonly READ_TASK_LISTENER: "READ_TASK_LISTENER"; readonly UPDATE: "UPDATE"; readonly UPDATE_PROCESS_INSTANCE: "UPDATE_PROCESS_INSTANCE"; readonly UPDATE_USER_TASK: "UPDATE_USER_TASK"; readonly UPDATE_TASK_LISTENER: "UPDATE_TASK_LISTENER"; }; type PermissionTypeEnum = (typeof PermissionTypeEnum)[keyof typeof PermissionTypeEnum]; /** * The type of resource to add/remove permissions to/from. */ declare const ResourceTypeEnum: { readonly AUDIT_LOG: "AUDIT_LOG"; readonly AUTHORIZATION: "AUTHORIZATION"; readonly BATCH: "BATCH"; readonly CLUSTER_VARIABLE: "CLUSTER_VARIABLE"; readonly COMPONENT: "COMPONENT"; readonly DECISION_DEFINITION: "DECISION_DEFINITION"; readonly DECISION_REQUIREMENTS_DEFINITION: "DECISION_REQUIREMENTS_DEFINITION"; readonly DOCUMENT: "DOCUMENT"; readonly EXPRESSION: "EXPRESSION"; readonly GLOBAL_LISTENER: "GLOBAL_LISTENER"; readonly GROUP: "GROUP"; readonly MAPPING_RULE: "MAPPING_RULE"; readonly MESSAGE: "MESSAGE"; readonly PROCESS_DEFINITION: "PROCESS_DEFINITION"; readonly RESOURCE: "RESOURCE"; readonly ROLE: "ROLE"; readonly SYSTEM: "SYSTEM"; readonly TENANT: "TENANT"; readonly USER: "USER"; readonly USER_TASK: "USER_TASK"; }; type ResourceTypeEnum = (typeof ResourceTypeEnum)[keyof typeof ResourceTypeEnum]; /** * The type of the owner of permissions. */ declare const OwnerTypeEnum: { readonly USER: "USER"; readonly CLIENT: "CLIENT"; readonly ROLE: "ROLE"; readonly GROUP: "GROUP"; readonly MAPPING_RULE: "MAPPING_RULE"; readonly UNSPECIFIED: "UNSPECIFIED"; }; type OwnerTypeEnum = (typeof OwnerTypeEnum)[keyof typeof OwnerTypeEnum]; /** * The created batch operation. */ type BatchOperationCreatedResult = { /** * Key of the batch operation. */ batchOperationKey: BatchOperationKey; batchOperationType: BatchOperationTypeEnum; }; type BatchOperationSearchQuerySortRequest = { /** * The field to sort by. */ field: 'batchOperationKey' | 'operationType' | 'state' | 'startDate' | 'endDate' | 'actorType' | 'actorId'; order?: SortOrderEnum; }; /** * Batch operation search request. */ type BatchOperationSearchQuery = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The batch operation search filters. */ filter?: BatchOperationFilter; }; /** * Batch operation filter request. */ type BatchOperationFilter = { /** * The key (or operate legacy ID) of the batch operation. */ batchOperationKey?: BasicStringFilterProperty; /** * The type of the batch operation. */ operationType?: BatchOperationTypeFilterProperty; /** * The state of the batch operation. */ state?: BatchOperationStateFilterProperty; /** * The type of the actor who performed the operation. */ actorType?: AuditLogActorTypeEnum; /** * The ID of the actor who performed the operation. */ actorId?: StringFilterProperty; }; /** * The batch operation search query result. */ type BatchOperationSearchQueryResult = SearchQueryResponse & { /** * The matching batch operations. */ items: Array; }; type BatchOperationResponse = { /** * Key or (Operate Legacy ID = UUID) of the batch operation. */ batchOperationKey: BatchOperationKey; state: BatchOperationStateEnum; batchOperationType: BatchOperationTypeEnum; /** * The start date of the batch operation. * This is `null` if the batch operation has not yet started. * */ startDate: string | null; /** * The end date of the batch operation. * This is `null` if the batch operation is still running. * */ endDate: string | null; /** * The type of the actor who performed the operation. * This is `null` if the batch operation was created before 8.9, * or if the actor information is not available. * */ actorType: AuditLogActorTypeEnum | null; /** * The ID of the actor who performed the operation. Available for batch operations created since 8.9. */ actorId: string | null; /** * The total number of items contained in this batch operation. */ operationsTotalCount: number; /** * The number of items which failed during execution of the batch operation. (e.g. because they are rejected by the Zeebe engine). */ operationsFailedCount: number; /** * The number of successfully completed tasks. */ operationsCompletedCount: number; /** * The errors that occurred per partition during the batch operation. */ errors: Array; }; type BatchOperationError = { /** * The partition ID where the error occurred. */ partitionId: number; /** * The type of the error that occurred during the batch operation. */ type: 'QUERY_FAILED' | 'RESULT_BUFFER_SIZE_EXCEEDED'; /** * The error message that occurred during the batch operation. */ message: string; }; type BatchOperationItemSearchQuerySortRequest = { /** * The field to sort by. */ field: 'batchOperationKey' | 'itemKey' | 'processInstanceKey' | 'processedDate' | 'state'; order?: SortOrderEnum; }; /** * Batch operation item search request. */ type BatchOperationItemSearchQuery = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The batch operation item search filters. */ filter?: BatchOperationItemFilter; }; /** * Batch operation item filter request. */ type BatchOperationItemFilter = { /** * The key (or operate legacy ID) of the batch operation. */ batchOperationKey?: BasicStringFilterProperty; /** * The key of the item, e.g. a process instance key. */ itemKey?: BasicStringFilterProperty; /** * The process instance key of the processed item. */ processInstanceKey?: ProcessInstanceKeyFilterProperty; /** * The state of the batch operation. */ state?: BatchOperationItemStateFilterProperty; /** * The type of the batch operation. */ operationType?: BatchOperationTypeFilterProperty; }; type BatchOperationItemSearchQueryResult = SearchQueryResponse & { /** * The matching batch operation items. */ items: Array; }; type BatchOperationItemResponse = { operationType: BatchOperationTypeEnum; /** * The key (or operate legacy ID) of the batch operation. */ batchOperationKey: BatchOperationKey; /** * Key of the item, e.g. a process instance key. */ itemKey: string; /** * the process instance key of the processed item. */ processInstanceKey: ProcessInstanceKey; /** * The key of the root process instance. The root process instance is the top-level * ancestor in the process instance hierarchy. This field is only present for data * belonging to process instance hierarchies created in version 8.9 or later. * */ rootProcessInstanceKey: ProcessInstanceKey | null; /** * State of the item. */ state: 'ACTIVE' | 'COMPLETED' | 'SKIPPED' | 'CANCELED' | 'FAILED'; /** * The date this item was processed. * This is `null` if the item has not yet been processed. * */ processedDate: string | null; /** * The error message from the engine in case of a failed operation. */ errorMessage: string | null; }; /** * The decision instance filter that defines which decision instances should be deleted. */ type DecisionInstanceDeletionBatchOperationRequest = { /** * The decision instance filter. */ filter: DecisionInstanceFilter; operationReference?: OperationReference; }; /** * The process instance filter that defines which process instances should be canceled. */ type ProcessInstanceCancellationBatchOperationRequest = { /** * The process instance filter. */ filter: ProcessInstanceFilter; operationReference?: OperationReference; }; /** * The process instance filter that defines which process instances should have their incidents resolved. */ type ProcessInstanceIncidentResolutionBatchOperationRequest = { /** * The process instance filter. */ filter: ProcessInstanceFilter; operationReference?: OperationReference; }; /** * The process instance filter that defines which process instances should be deleted. */ type ProcessInstanceDeletionBatchOperationRequest = { /** * The process instance filter. */ filter: ProcessInstanceFilter; operationReference?: OperationReference; }; type ProcessInstanceMigrationBatchOperationRequest = { /** * The process instance filter. */ filter: ProcessInstanceFilter; /** * The migration plan. */ migrationPlan: ProcessInstanceMigrationBatchOperationPlan; operationReference?: OperationReference; }; /** * The migration instructions describe how to migrate a process instance from one process definition to another. * */ type ProcessInstanceMigrationBatchOperationPlan = { /** * The target process definition key. */ targetProcessDefinitionKey: ProcessDefinitionKey; /** * The mapping instructions. */ mappingInstructions: Array; }; /** * The process instance filter to define on which process instances tokens should be moved, * and new element instances should be activated or terminated. * */ type ProcessInstanceModificationBatchOperationRequest = { /** * The process instance filter. */ filter: ProcessInstanceFilter; /** * Instructions for moving tokens between elements. */ moveInstructions: Array; operationReference?: OperationReference; }; /** * Instructions describing a move operation. This instruction will terminate all active * element instances at `sourceElementId` and activate a new element instance for each * terminated one at `targetElementId`. The new element instances are created in the parent * scope of the source element instances. * */ type ProcessInstanceModificationMoveBatchOperationInstruction = { /** * The source element ID. */ sourceElementId: ElementId; /** * The target element ID. */ targetElementId: ElementId; }; /** * The batch operation item state. */ declare const BatchOperationItemStateEnum: { readonly ACTIVE: "ACTIVE"; readonly COMPLETED: "COMPLETED"; readonly CANCELED: "CANCELED"; readonly FAILED: "FAILED"; }; type BatchOperationItemStateEnum = (typeof BatchOperationItemStateEnum)[keyof typeof BatchOperationItemStateEnum]; /** * The batch operation state. */ declare const BatchOperationStateEnum: { readonly ACTIVE: "ACTIVE"; readonly CANCELED: "CANCELED"; readonly COMPLETED: "COMPLETED"; readonly CREATED: "CREATED"; readonly FAILED: "FAILED"; readonly PARTIALLY_COMPLETED: "PARTIALLY_COMPLETED"; readonly SUSPENDED: "SUSPENDED"; }; type BatchOperationStateEnum = (typeof BatchOperationStateEnum)[keyof typeof BatchOperationStateEnum]; /** * The type of the batch operation. */ declare const BatchOperationTypeEnum: { readonly ADD_VARIABLE: "ADD_VARIABLE"; readonly CANCEL_PROCESS_INSTANCE: "CANCEL_PROCESS_INSTANCE"; readonly DELETE_DECISION_DEFINITION: "DELETE_DECISION_DEFINITION"; readonly DELETE_DECISION_INSTANCE: "DELETE_DECISION_INSTANCE"; readonly DELETE_PROCESS_DEFINITION: "DELETE_PROCESS_DEFINITION"; readonly DELETE_PROCESS_INSTANCE: "DELETE_PROCESS_INSTANCE"; readonly MIGRATE_PROCESS_INSTANCE: "MIGRATE_PROCESS_INSTANCE"; readonly MODIFY_PROCESS_INSTANCE: "MODIFY_PROCESS_INSTANCE"; readonly RESOLVE_INCIDENT: "RESOLVE_INCIDENT"; readonly UPDATE_VARIABLE: "UPDATE_VARIABLE"; }; type BatchOperationTypeEnum = (typeof BatchOperationTypeEnum)[keyof typeof BatchOperationTypeEnum]; /** * BatchOperationTypeEnum property with full advanced search capabilities. */ type BatchOperationTypeFilterProperty = BatchOperationTypeExactMatch | AdvancedBatchOperationTypeFilter; /** * Advanced filter * * Advanced BatchOperationTypeEnum filter. */ type AdvancedBatchOperationTypeFilter = { /** * Checks for equality with the provided value. */ $eq?: BatchOperationTypeEnum; /** * Checks for inequality with the provided value. */ $neq?: BatchOperationTypeEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; /** * BatchOperationStateEnum property with full advanced search capabilities. */ type BatchOperationStateFilterProperty = BatchOperationStateExactMatch | AdvancedBatchOperationStateFilter; /** * Advanced filter * * Advanced BatchOperationStateEnum filter. */ type AdvancedBatchOperationStateFilter = { /** * Checks for equality with the provided value. */ $eq?: BatchOperationStateEnum; /** * Checks for inequality with the provided value. */ $neq?: BatchOperationStateEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; /** * BatchOperationItemStateEnum property with full advanced search capabilities. */ type BatchOperationItemStateFilterProperty = BatchOperationItemStateExactMatch | AdvancedBatchOperationItemStateFilter; /** * Advanced filter * * Advanced BatchOperationItemStateEnum filter. */ type AdvancedBatchOperationItemStateFilter = { /** * Checks for equality with the provided value. */ $eq?: BatchOperationItemStateEnum; /** * Checks for inequality with the provided value. */ $neq?: BatchOperationItemStateEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; type ClockPinRequest = { /** * The exact time in epoch milliseconds to which the clock should be pinned. */ timestamp: number; }; /** * The scope of a cluster variable. */ declare const ClusterVariableScopeEnum: { readonly GLOBAL: "GLOBAL"; readonly TENANT: "TENANT"; }; type ClusterVariableScopeEnum = (typeof ClusterVariableScopeEnum)[keyof typeof ClusterVariableScopeEnum]; type CreateClusterVariableRequest = { /** * The name of the cluster variable. Must be unique within its scope (global or tenant-specific). */ name: string; /** * The value of the cluster variable. Can be any JSON object or primitive value. Will be serialized as a JSON string in responses. */ value: { [key: string]: unknown; }; }; type UpdateClusterVariableRequest = { /** * The new value of the cluster variable. Can be any JSON object or primitive value. Will be serialized as a JSON string in responses. */ value: { [key: string]: unknown; }; }; type ClusterVariableResult = ClusterVariableResultBase & { /** * Full value of this cluster variable. */ value: string; }; /** * Cluster variable search response item. */ type ClusterVariableSearchResult = ClusterVariableResultBase & { /** * Value of this cluster variable. Can be truncated. */ value: string; /** * Whether the value is truncated or not. */ isTruncated: boolean; }; /** * Cluster variable response item. */ type ClusterVariableResultBase = { /** * The name of the cluster variable. Unique within its scope (global or tenant-specific). */ name: string; scope: ClusterVariableScopeEnum; /** * Only provided if the cluster variable scope is TENANT. Null for global scope variables. */ tenantId: string | null; }; /** * Cluster variable search query request. */ type ClusterVariableSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The cluster variable search filters. */ filter?: ClusterVariableSearchQueryFilterRequest; }; type ClusterVariableSearchQuerySortRequest = { /** * The field to sort by. */ field: 'name' | 'value' | 'tenantId' | 'scope'; order?: SortOrderEnum; }; /** * Cluster variable filter request. */ type ClusterVariableSearchQueryFilterRequest = { /** * Name of the cluster variable. */ name?: StringFilterProperty; /** * The value of the cluster variable. */ value?: StringFilterProperty; /** * The scope filter for cluster variables. */ scope?: ClusterVariableScopeFilterProperty; /** * Tenant ID of this variable. */ tenantId?: StringFilterProperty; /** * Filter cluster variables by truncation status of their stored values. When true, returns only variables whose stored values are truncated (i.e., the value exceeds the storage size limit and is truncated in storage). When false, returns only variables with non-truncated stored values. This filter is based on the underlying storage characteristic, not the response format. * */ isTruncated?: boolean; }; /** * ClusterVariableScopeEnum property with full advanced search capabilities. */ type ClusterVariableScopeFilterProperty = ClusterVariableScopeExactMatch | AdvancedClusterVariableScopeFilter; /** * Advanced filter * * Advanced ClusterVariableScopeEnum filter. */ type AdvancedClusterVariableScopeFilter = { /** * Checks for equality with the provided value. */ $eq?: ClusterVariableScopeEnum; /** * Checks for inequality with the provided value. */ $neq?: ClusterVariableScopeEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; /** * Cluster variable search query response. */ type ClusterVariableSearchQueryResult = SearchQueryResponse & { /** * The matching cluster variables. */ items: Array; }; /** * The response of a topology request. */ type TopologyResponse = { /** * A list of brokers that are part of this cluster. */ brokers: Array; /** * The cluster Id. */ clusterId: string | null; /** * The number of brokers in the cluster. */ clusterSize: number; /** * The number of partitions are spread across the cluster. */ partitionsCount: number; /** * The configured replication factor for this cluster. */ replicationFactor: number; /** * The version of the Zeebe Gateway. */ gatewayVersion: string; /** * ID of the last completed change */ lastCompletedChangeId: string; }; /** * Provides information on a broker node. */ type BrokerInfo = { /** * The unique (within a cluster) node ID for the broker. */ nodeId: number; /** * The hostname for reaching the broker. */ host: string; /** * The port for reaching the broker. */ port: number; /** * A list of partitions managed or replicated on this broker. */ partitions: Array; /** * The broker version. */ version: string; }; /** * Provides information on a partition within a broker node. */ type Partition = { /** * The unique ID of this partition. */ partitionId: number; /** * Describes the Raft role of the broker for a given partition. */ role: 'leader' | 'follower' | 'inactive'; /** * Describes the current health of the partition. */ health: 'healthy' | 'unhealthy' | 'dead'; }; type ConditionalEvaluationInstruction = { /** * Used to evaluate root-level conditional start events for a tenant with the given ID. * This will only evaluate root-level conditional start events of process definitions which belong to the tenant. * */ tenantId?: TenantId; /** * Used to evaluate root-level conditional start events of the process definition with the given key. * */ processDefinitionKey?: ProcessDefinitionKey; /** * JSON object representing the variables to use for evaluation of the conditions and to pass to the process instances that have been triggered. * */ variables: { [key: string]: unknown; }; }; type EvaluateConditionalResult = { /** * The unique key of the conditional evaluation operation. */ conditionalEvaluationKey: ConditionalEvaluationKey; /** * The tenant ID of the conditional evaluation operation. */ tenantId: TenantId; /** * List of process instances created. If no root-level conditional start events evaluated to true, the list will be empty. */ processInstances: Array; }; type ProcessInstanceReference = { /** * The key of the process definition. */ processDefinitionKey: ProcessDefinitionKey; /** * The key of the created process instance. */ processInstanceKey: ProcessInstanceKey; }; type DecisionDefinitionSearchQuerySortRequest = { /** * The field to sort by. */ field: 'decisionDefinitionKey' | 'decisionDefinitionId' | 'name' | 'version' | 'decisionRequirementsId' | 'decisionRequirementsKey' | 'decisionRequirementsName' | 'decisionRequirementsVersion' | 'tenantId'; order?: SortOrderEnum; }; type DecisionDefinitionSearchQuery = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The decision definition search filters. */ filter?: DecisionDefinitionFilter; }; /** * Decision definition search filter. */ type DecisionDefinitionFilter = { /** * The DMN ID of the decision definition. */ decisionDefinitionId?: DecisionDefinitionId; /** * The DMN name of the decision definition. */ name?: string; /** * Whether to only return the latest version of each decision definition. * When using this filter, pagination functionality is limited, you can only paginate forward using `after` and `limit`. * The response contains no `startCursor` in the `page`, and requests ignore the `from` and `before` in the `page`. * */ isLatestVersion?: boolean; /** * The assigned version of the decision definition. */ version?: number; /** * the DMN ID of the decision requirements graph that the decision definition is part of. */ decisionRequirementsId?: string; /** * The tenant ID of the decision definition. */ tenantId?: TenantId; /** * The assigned key, which acts as a unique identifier for this decision definition. */ decisionDefinitionKey?: DecisionDefinitionKey; /** * The assigned key of the decision requirements graph that the decision definition is part of. */ decisionRequirementsKey?: DecisionRequirementsKey; /** * The DMN name of the decision requirements that the decision definition is part of. */ decisionRequirementsName?: string; /** * The assigned version of the decision requirements that the decision definition is part of. */ decisionRequirementsVersion?: number; }; type DecisionDefinitionSearchQueryResult = SearchQueryResponse & { /** * The matching decision definitions. */ items: Array; }; type DecisionDefinitionResult = { /** * The DMN ID of the decision definition. */ decisionDefinitionId: DecisionDefinitionId; /** * The assigned key, which acts as a unique identifier for this decision definition. */ decisionDefinitionKey: DecisionDefinitionKey; /** * the DMN ID of the decision requirements graph that the decision definition is part of. */ decisionRequirementsId: string; /** * The assigned key of the decision requirements graph that the decision definition is part of. */ decisionRequirementsKey: DecisionRequirementsKey; /** * The DMN name of the decision requirements that the decision definition is part of. */ decisionRequirementsName: string; /** * The assigned version of the decision requirements that the decision definition is part of. */ decisionRequirementsVersion: number; /** * The DMN name of the decision definition. */ name: string; /** * The tenant ID of the decision definition. */ tenantId: TenantId; /** * The assigned version of the decision definition. */ version: number; }; type DecisionEvaluationInstruction = DecisionEvaluationById | DecisionEvaluationByKey; /** * Decision evaluation by ID */ type DecisionEvaluationById = { /** * The ID of the decision to be evaluated. * When using the decision ID, the latest * deployed version of the decision is used. * */ decisionDefinitionId: DecisionDefinitionId; /** * The decision evaluation variables as JSON document. */ variables?: { [key: string]: unknown; }; /** * The tenant ID of the decision. */ tenantId?: TenantId; }; /** * Decision evaluation by key */ type DecisionEvaluationByKey = { decisionDefinitionKey: DecisionDefinitionKey; /** * The decision evaluation variables as JSON document. */ variables?: { [key: string]: unknown; }; /** * The tenant ID of the decision. */ tenantId?: TenantId; }; type EvaluateDecisionResult = { /** * The ID of the decision which was evaluated. */ decisionDefinitionId: DecisionDefinitionId; /** * The unique key identifying the decision which was evaluated. */ decisionDefinitionKey: DecisionDefinitionKey; /** * The name of the decision which was evaluated. */ decisionDefinitionName: string; /** * The version of the decision which was evaluated. */ decisionDefinitionVersion: number; /** * The unique key identifying this decision evaluation. */ decisionEvaluationKey: DecisionEvaluationKey; /** * Deprecated, please refer to `decisionEvaluationKey`. * * @deprecated */ decisionInstanceKey: DecisionInstanceKey; /** * The ID of the decision requirements graph that the decision which was evaluated is part of. */ decisionRequirementsId: string; /** * The unique key identifying the decision requirements graph that the decision which was evaluated is part of. */ decisionRequirementsKey: DecisionRequirementsKey; /** * Decisions that were evaluated within the requested decision evaluation. */ evaluatedDecisions: Array; /** * The ID of the decision which failed during evaluation. */ failedDecisionDefinitionId: DecisionDefinitionId | null; /** * Message describing why the decision which was evaluated failed. */ failureMessage: string | null; /** * JSON document that will instantiate the result of the decision which was evaluated. * */ output: string; /** * The tenant ID of the evaluated decision. */ tenantId: TenantId; }; /** * A decision that was evaluated. */ type EvaluatedDecisionResult = { /** * The ID of the decision which was evaluated. */ decisionDefinitionId: DecisionDefinitionId; /** * The name of the decision which was evaluated. */ decisionDefinitionName: string; /** * The version of the decision which was evaluated. */ decisionDefinitionVersion: number; /** * The type of the decision which was evaluated. */ decisionDefinitionType: string; /** * JSON document that will instantiate the result of the decision which was evaluated. * */ output: string; /** * The tenant ID of the evaluated decision. */ tenantId: TenantId; /** * The decision rules that matched within this decision evaluation. */ matchedRules: Array; /** * The decision inputs that were evaluated within this decision evaluation. */ evaluatedInputs: Array; /** * The unique key identifying the decision which was evaluate. */ decisionDefinitionKey: DecisionDefinitionKey; /** * The unique key identifying this decision evaluation instance. */ decisionEvaluationInstanceKey: DecisionEvaluationInstanceKey; }; type DecisionInstanceSearchQuerySortRequest = { /** * The field to sort by. */ field: 'decisionDefinitionId' | 'decisionDefinitionKey' | 'decisionDefinitionName' | 'decisionDefinitionType' | 'decisionDefinitionVersion' | 'decisionEvaluationInstanceKey' | 'decisionEvaluationKey' | 'elementInstanceKey' | 'evaluationDate' | 'evaluationFailure' | 'processDefinitionKey' | 'processInstanceKey' | 'rootDecisionDefinitionKey' | 'state' | 'tenantId'; order?: SortOrderEnum; }; type DecisionInstanceSearchQuery = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The decision instance search filters. */ filter?: DecisionInstanceFilter; }; /** * Decision instance search filter. */ type DecisionInstanceFilter = { /** * The key of the decision evaluation instance. */ decisionEvaluationInstanceKey?: DecisionEvaluationInstanceKeyFilterProperty; /** * The state of the decision instance. */ state?: DecisionInstanceStateFilterProperty; /** * The evaluation failure of the decision instance. */ evaluationFailure?: string; /** * The evaluation date of the decision instance. */ evaluationDate?: DateTimeFilterProperty; /** * The ID of the DMN decision. */ decisionDefinitionId?: DecisionDefinitionId; /** * The name of the DMN decision. */ decisionDefinitionName?: string; /** * The version of the decision. */ decisionDefinitionVersion?: number; decisionDefinitionType?: DecisionDefinitionTypeEnum; /** * The tenant ID of the decision instance. */ tenantId?: TenantId; /** * The key of the parent decision evaluation. Note that this is not the identifier of an individual decision instance; the `decisionEvaluationInstanceKey` is the identifier for a decision instance. * */ decisionEvaluationKey?: DecisionEvaluationKey; /** * The key of the process definition. */ processDefinitionKey?: ProcessDefinitionKey; /** * The key of the process instance. */ processInstanceKey?: ProcessInstanceKey; /** * The key of the decision. */ decisionDefinitionKey?: DecisionDefinitionKeyFilterProperty; /** * The key of the element instance this decision instance is linked to. */ elementInstanceKey?: ElementInstanceKeyFilterProperty; /** * The key of the root decision definition. */ rootDecisionDefinitionKey?: DecisionDefinitionKeyFilterProperty; /** * The key of the decision requirements definition. */ decisionRequirementsKey?: DecisionRequirementsKeyFilterProperty; }; type DeleteDecisionInstanceRequest = { operationReference?: OperationReference; } | null; type DecisionInstanceSearchQueryResult = SearchQueryResponse & { /** * The matching decision instances. */ items: Array; }; type DecisionInstanceResult = { /** * The ID of the DMN decision. */ decisionDefinitionId: DecisionDefinitionId; /** * The key of the decision. */ decisionDefinitionKey: DecisionDefinitionKey; /** * The name of the DMN decision. */ decisionDefinitionName: string; decisionDefinitionType: DecisionDefinitionTypeEnum; /** * The version of the decision. */ decisionDefinitionVersion: number; decisionEvaluationInstanceKey: DecisionEvaluationInstanceKey; /** * The key of the decision evaluation where this instance was created. */ decisionEvaluationKey: DecisionEvaluationKey; /** * The key of the element instance this decision instance is linked to. */ elementInstanceKey: ElementInstanceKey | null; /** * The evaluation date of the decision instance. */ evaluationDate: string; /** * The evaluation failure of the decision instance. */ evaluationFailure: string | null; /** * The key of the process definition. */ processDefinitionKey: ProcessDefinitionKey | null; /** * The key of the process instance. */ processInstanceKey: ProcessInstanceKey | null; /** * The result of the decision instance. */ result: string; /** * The key of the root decision definition. */ rootDecisionDefinitionKey: DecisionDefinitionKey; /** * The key of the root process instance. The root process instance is the top-level * ancestor in the process instance hierarchy. This field is only present for data * belonging to process instance hierarchies created in version 8.9 or later. * */ rootProcessInstanceKey: ProcessInstanceKey | null; state: DecisionInstanceStateEnum; /** * The tenant ID of the decision instance. */ tenantId: TenantId; }; type DecisionInstanceGetQueryResult = DecisionInstanceResult & { /** * The evaluated inputs of the decision instance. * */ evaluatedInputs: Array; /** * The matched rules of the decision instance. * */ matchedRules: Array; }; /** * A decision input that was evaluated within this decision evaluation. */ type EvaluatedDecisionInputItem = { /** * The identifier of the decision input. */ inputId: string; /** * The name of the decision input. */ inputName: string; /** * The value of the decision input. */ inputValue: string; }; /** * The evaluated decision outputs. */ type EvaluatedDecisionOutputItem = { /** * The ID of the evaluated decison output item. */ outputId: string; /** * The name of the of the evaluated decison output item. */ outputName: string; /** * The value of the evaluated decison output item. */ outputValue: string; /** * The ID of the matched rule. */ ruleId: string | null; /** * The index of the matched rule. */ ruleIndex: number | null; }; /** * A decision rule that matched within this decision evaluation. */ type MatchedDecisionRuleItem = { /** * The ID of the matched rule. */ ruleId: string; /** * The index of the matched rule. */ ruleIndex: number; /** * The evaluated decision outputs. */ evaluatedOutputs: Array; }; /** * The type of the decision. UNSPECIFIED is deprecated and should not be used anymore, for removal in 8.10 */ declare const DecisionDefinitionTypeEnum: { readonly DECISION_TABLE: "DECISION_TABLE"; readonly LITERAL_EXPRESSION: "LITERAL_EXPRESSION"; /** @deprecated since 8.9.0 */ readonly UNSPECIFIED: "UNSPECIFIED"; readonly UNKNOWN: "UNKNOWN"; }; type DecisionDefinitionTypeEnum = (typeof DecisionDefinitionTypeEnum)[keyof typeof DecisionDefinitionTypeEnum]; /** * The state of the decision instance. UNSPECIFIED and UNKNOWN are deprecated and should not be used anymore, for removal in 8.10 */ declare const DecisionInstanceStateEnum: { readonly EVALUATED: "EVALUATED"; readonly FAILED: "FAILED"; /** @deprecated since 8.9.0 */ readonly UNSPECIFIED: "UNSPECIFIED"; /** @deprecated since 8.9.0 */ readonly UNKNOWN: "UNKNOWN"; }; type DecisionInstanceStateEnum = (typeof DecisionInstanceStateEnum)[keyof typeof DecisionInstanceStateEnum]; /** * Advanced filter * * Advanced DecisionInstanceStateEnum filter. */ type AdvancedDecisionInstanceStateFilter = { /** * Checks for equality with the provided value. */ $eq?: DecisionInstanceStateEnum; /** * Checks for inequality with the provided value. */ $neq?: DecisionInstanceStateEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; $like?: LikeFilter; }; /** * DecisionInstanceStateEnum property with full advanced search capabilities. */ type DecisionInstanceStateFilterProperty = DecisionInstanceStateExactMatch | AdvancedDecisionInstanceStateFilter; type DecisionRequirementsSearchQuerySortRequest = { /** * The field to sort by. */ field: 'decisionRequirementsKey' | 'decisionRequirementsName' | 'version' | 'decisionRequirementsId' | 'tenantId'; order?: SortOrderEnum; }; type DecisionRequirementsSearchQuery = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The decision definition search filters. */ filter?: DecisionRequirementsFilter; }; /** * Decision requirements search filter. */ type DecisionRequirementsFilter = { /** * The DMN name of the decision requirements. */ decisionRequirementsName?: string; /** * the DMN ID of the decision requirements. */ decisionRequirementsId?: string; decisionRequirementsKey?: DecisionRequirementsKey; /** * The assigned version of the decision requirements. */ version?: number; /** * The tenant ID of the decision requirements. */ tenantId?: TenantId; /** * The name of the resource from which the decision requirements were parsed */ resourceName?: string; }; type DecisionRequirementsSearchQueryResult = SearchQueryResponse & { /** * The matching decision requirements. */ items: Array; }; type DecisionRequirementsResult = { /** * The DMN ID of the decision requirements. */ decisionRequirementsId: string; /** * The assigned key, which acts as a unique identifier for this decision requirements. */ decisionRequirementsKey: DecisionRequirementsKey; /** * The DMN name of the decision requirements. */ decisionRequirementsName: string; /** * The name of the resource from which this decision requirements was parsed. */ resourceName: string; /** * The tenant ID of the decision requirements. */ tenantId: TenantId; /** * The assigned version of the decision requirements. */ version: number; }; type DeploymentResult = { /** * The unique key identifying the deployment. */ deploymentKey: DeploymentKey; /** * The tenant ID associated with the deployment. */ tenantId: TenantId; /** * Items deployed by the request. */ deployments: Array; }; type DeploymentMetadataResult = { /** * Deployed process. */ processDefinition: DeploymentProcessResult | null; /** * Deployed decision. */ decisionDefinition: DeploymentDecisionResult | null; /** * Deployed decision requirement definition. */ decisionRequirements: DeploymentDecisionRequirementsResult | null; /** * Deployed form. */ form: DeploymentFormResult | null; /** * Deployed resource. */ resource: DeploymentResourceResult | null; }; /** * A deployed process. */ type DeploymentProcessResult = { /** * The bpmn process ID, as parsed during deployment, together with the version forms a * unique identifier for a specific process definition. * */ processDefinitionId: ProcessDefinitionId; /** * The assigned process version. */ processDefinitionVersion: number; /** * The resource name from which this process was parsed. */ resourceName: string; /** * The tenant ID of the deployed process. */ tenantId: TenantId; /** * The assigned key, which acts as a unique identifier for this process. */ processDefinitionKey: ProcessDefinitionKey; }; /** * A deployed decision. */ type DeploymentDecisionResult = { /** * The dmn decision ID, as parsed during deployment, together with the version forms a * unique identifier for a specific decision. * */ decisionDefinitionId: DecisionDefinitionId; /** * The assigned decision version. */ version: number; /** * The DMN name of the decision, as parsed during deployment. */ name: string; /** * The tenant ID of the deployed decision. */ tenantId: TenantId; /** * The dmn ID of the decision requirements graph that this decision is part of, as parsed during deployment. * */ decisionRequirementsId: string; /** * The assigned decision key, which acts as a unique identifier for this decision. * */ decisionDefinitionKey: DecisionDefinitionKey; /** * The assigned key of the decision requirements graph that this decision is part of. * */ decisionRequirementsKey: DecisionRequirementsKey; }; /** * Deployed decision requirements. */ type DeploymentDecisionRequirementsResult = { /** * The id of the deployed decision requirements. */ decisionRequirementsId: string; /** * The name of the deployed decision requirements. */ decisionRequirementsName: string; /** * The version of the deployed decision requirements. */ version: number; /** * The name of the resource. */ resourceName: string; /** * The tenant ID of the deployed decision requirements. */ tenantId: TenantId; /** * The assigned decision requirements key, which acts as a unique identifier for this decision requirements. * */ decisionRequirementsKey: DecisionRequirementsKey; }; /** * A deployed form. */ type DeploymentFormResult = { /** * The form ID, as parsed during deployment, together with the version forms a * unique identifier for a specific form. * */ formId: FormId; /** * The version of the deployed form. */ version: number; /** * The name of the resource. */ resourceName: string; tenantId: TenantId; /** * The assigned key, which acts as a unique identifier for this form. */ formKey: FormKey; }; /** * A deployed Resource. */ type DeploymentResourceResult = { /** * The resource id of the deployed resource. */ resourceId: string; /** * The name of the deployed resource. */ resourceName: string; /** * The description of the deployed resource. */ version: number; tenantId: TenantId; /** * The assigned key, which acts as a unique identifier for this Resource. */ resourceKey: ResourceKey; }; type DeleteResourceRequest = { operationReference?: OperationReference; /** * Indicates if the historic data of a process resource should be deleted via a * batch operation asynchronously. * * This flag is only effective for process resources. For other resource types * (decisions, forms, generic resources), this flag is ignored and no history * will be deleted. In those cases, the `batchOperation` field in the response * will not be populated. * */ deleteHistory?: boolean; } | null; type DeleteResourceResponse = { /** * The system-assigned key for this resource, requested to be deleted. */ resourceKey: ResourceKey; /** * The batch operation created for asynchronously deleting the historic data. * * This field is only populated when the request `deleteHistory` is set to `true` and the resource * is a process definition. For other resource types (decisions, forms, generic resources), * this field will be `null`. * */ batchOperation: BatchOperationCreatedResult | null; }; type ResourceResult = { /** * The resource name from which this resource was parsed. */ resourceName: string; /** * The assigned resource version. */ version: number; /** * The version tag of this resource. */ versionTag: string | null; /** * The resource ID of this resource. */ resourceId: string; /** * The tenant ID of this resource. */ tenantId: TenantId; /** * The unique key of this resource. */ resourceKey: ResourceKey; }; /** * The system-assigned key for this resource. */ type ResourceKey = ProcessDefinitionKey | DecisionRequirementsKey | FormKey | DecisionDefinitionKey; /** * DeploymentKey property with full advanced search capabilities. */ type DeploymentKeyFilterProperty = DeploymentKeyExactMatch | AdvancedDeploymentKeyFilter; /** * Advanced filter * * Advanced DeploymentKey filter. */ type AdvancedDeploymentKeyFilter = { /** * Checks for equality with the provided value. */ $eq?: DeploymentKey; /** * Checks for inequality with the provided value. */ $neq?: DeploymentKey; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; }; /** * ResourceKey property with full advanced search capabilities. */ type ResourceKeyFilterProperty = ResourceKeyExactMatch | AdvancedResourceKeyFilter; /** * Advanced filter * * Advanced ResourceKey filter. */ type AdvancedResourceKeyFilter = { /** * Checks for equality with the provided value. */ $eq?: ResourceKey; /** * Checks for inequality with the provided value. */ $neq?: ResourceKey; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; }; type DocumentReference = { /** * Document discriminator. Always set to "camunda". */ 'camunda.document.type': 'camunda'; /** * The ID of the document store. */ storeId: string; /** * The ID of the document. */ documentId: DocumentId; /** * The hash of the document. */ contentHash: string | null; metadata: DocumentMetadataResponse; }; type DocumentCreationFailureDetail = { /** * The name of the file that failed to upload. */ fileName: string; /** * The HTTP status code of the failure. */ status: number; /** * A short, human-readable summary of the problem type. */ title: string; /** * A human-readable explanation specific to this occurrence of the problem. */ detail: string; }; type DocumentCreationBatchResponse = { /** * Documents that were successfully created. */ failedDocuments: Array; /** * Documents that failed creation. */ createdDocuments: Array; }; /** * Information about the document. */ type DocumentMetadata = { /** * The content type of the document. */ contentType?: string; /** * The name of the file. */ fileName?: string; /** * The date and time when the document expires. */ expiresAt?: string; /** * The size of the document in bytes. */ size?: number; /** * The ID of the process definition that created the document. */ processDefinitionId?: ProcessDefinitionId; /** * The key of the process instance that created the document. */ processInstanceKey?: ProcessInstanceKey; /** * Custom properties of the document. */ customProperties?: { [key: string]: unknown; }; }; /** * Information about the document that is returned in responses. */ type DocumentMetadataResponse = { /** * The content type of the document. */ contentType: string; /** * The name of the file. */ fileName: string; /** * The date and time when the document expires. */ expiresAt: string | null; /** * The size of the document in bytes. */ size: number; /** * The ID of the process definition that created the document. */ processDefinitionId: ProcessDefinitionId | null; /** * The key of the process instance that created the document. */ processInstanceKey: ProcessInstanceKey | null; /** * Custom properties of the document. */ customProperties: { [key: string]: unknown; }; }; type DocumentLinkRequest = { /** * The time-to-live of the document link in ms. */ timeToLive?: number; }; type DocumentLink = { /** * The link to the document. */ url: string; /** * The date and time when the link expires. */ expiresAt: string; }; type ElementInstanceSearchQuerySortRequest = { /** * The field to sort by. */ field: 'elementInstanceKey' | 'processInstanceKey' | 'processDefinitionKey' | 'processDefinitionId' | 'startDate' | 'endDate' | 'elementId' | 'elementName' | 'type' | 'state' | 'incidentKey' | 'tenantId'; order?: SortOrderEnum; }; /** * Element instance search request. */ type ElementInstanceSearchQuery = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The element instance search filters. */ filter?: ElementInstanceFilter; }; /** * Element instance filter. */ type ElementInstanceFilter = { /** * The process definition ID associated to this element instance. */ processDefinitionId?: ProcessDefinitionId; /** * State of element instance as defined set of values. */ state?: ElementInstanceStateFilterProperty; /** * Type of element as defined set of values. */ type?: 'UNSPECIFIED' | 'PROCESS' | 'SUB_PROCESS' | 'EVENT_SUB_PROCESS' | 'AD_HOC_SUB_PROCESS' | 'AD_HOC_SUB_PROCESS_INNER_INSTANCE' | 'START_EVENT' | 'INTERMEDIATE_CATCH_EVENT' | 'INTERMEDIATE_THROW_EVENT' | 'BOUNDARY_EVENT' | 'END_EVENT' | 'SERVICE_TASK' | 'RECEIVE_TASK' | 'USER_TASK' | 'MANUAL_TASK' | 'TASK' | 'EXCLUSIVE_GATEWAY' | 'INCLUSIVE_GATEWAY' | 'PARALLEL_GATEWAY' | 'EVENT_BASED_GATEWAY' | 'SEQUENCE_FLOW' | 'MULTI_INSTANCE_BODY' | 'CALL_ACTIVITY' | 'BUSINESS_RULE_TASK' | 'SCRIPT_TASK' | 'SEND_TASK' | 'UNKNOWN'; /** * The element ID for this element instance. */ elementId?: ElementId; /** * The element name. This only works for data created with 8.8 and onwards. Instances from prior versions don't contain this data and cannot be found. * */ elementName?: string; /** * Shows whether this element instance has an incident related to. */ hasIncident?: boolean; tenantId?: TenantId; /** * The assigned key, which acts as a unique identifier for this element instance. */ elementInstanceKey?: ElementInstanceKey; /** * The process instance key associated to this element instance. */ processInstanceKey?: ProcessInstanceKey; /** * The process definition key associated to this element instance. */ processDefinitionKey?: ProcessDefinitionKey; /** * The key of incident if field incident is true. */ incidentKey?: IncidentKey; /** * The start date of this element instance. */ startDate?: DateTimeFilterProperty; /** * The end date of this element instance. */ endDate?: DateTimeFilterProperty; /** * The scope key of this element instance. If provided with a process instance key it will return element instances that are immediate children of the process instance. If provided with an element instance key it will return element instances that are immediate children of the element instance. * */ elementInstanceScopeKey?: ElementInstanceKey | ProcessInstanceKey; }; /** * ElementInstanceStateEnum property with full advanced search capabilities. */ type ElementInstanceStateFilterProperty = ElementInstanceStateExactMatch | AdvancedElementInstanceStateFilter; /** * Advanced filter * * Advanced ElementInstanceStateEnum filter. */ type AdvancedElementInstanceStateFilter = { /** * Checks for equality with the provided value. */ $eq?: ElementInstanceStateEnum; /** * Checks for inequality with the provided value. */ $neq?: ElementInstanceStateEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; type ElementInstanceSearchQueryResult = SearchQueryResponse & { /** * The matching element instances. */ items: Array; }; type ElementInstanceResult = { /** * The process definition ID associated to this element instance. */ processDefinitionId: ProcessDefinitionId; /** * Date when element instance started. */ startDate: string; /** * Date when element instance finished. */ endDate: string | null; /** * The element ID for this element instance. */ elementId: ElementId; /** * The element name for this element instance. */ elementName: string; /** * Type of element as defined set of values. */ type: 'UNSPECIFIED' | 'PROCESS' | 'SUB_PROCESS' | 'EVENT_SUB_PROCESS' | 'AD_HOC_SUB_PROCESS' | 'AD_HOC_SUB_PROCESS_INNER_INSTANCE' | 'START_EVENT' | 'INTERMEDIATE_CATCH_EVENT' | 'INTERMEDIATE_THROW_EVENT' | 'BOUNDARY_EVENT' | 'END_EVENT' | 'SERVICE_TASK' | 'RECEIVE_TASK' | 'USER_TASK' | 'MANUAL_TASK' | 'TASK' | 'EXCLUSIVE_GATEWAY' | 'INCLUSIVE_GATEWAY' | 'PARALLEL_GATEWAY' | 'EVENT_BASED_GATEWAY' | 'SEQUENCE_FLOW' | 'MULTI_INSTANCE_BODY' | 'CALL_ACTIVITY' | 'BUSINESS_RULE_TASK' | 'SCRIPT_TASK' | 'SEND_TASK' | 'UNKNOWN'; /** * State of element instance as defined set of values. */ state: ElementInstanceStateEnum; /** * Shows whether this element instance has an incident. If true also an incidentKey is provided. */ hasIncident: boolean; /** * The tenant ID of the incident. */ tenantId: TenantId; /** * The assigned key, which acts as a unique identifier for this element instance. */ elementInstanceKey: ElementInstanceKey; /** * The process instance key associated to this element instance. */ processInstanceKey: ProcessInstanceKey; /** * The key of the root process instance. The root process instance is the top-level * ancestor in the process instance hierarchy. This field is only present for data * belonging to process instance hierarchies created in version 8.9 or later. * */ rootProcessInstanceKey: ProcessInstanceKey | null; /** * The process definition key associated to this element instance. */ processDefinitionKey: ProcessDefinitionKey; /** * Incident key associated with this element instance. */ incidentKey: IncidentKey | null; }; /** * Element states */ declare const ElementInstanceStateEnum: { readonly ACTIVE: "ACTIVE"; readonly COMPLETED: "COMPLETED"; readonly TERMINATED: "TERMINATED"; }; type ElementInstanceStateEnum = (typeof ElementInstanceStateEnum)[keyof typeof ElementInstanceStateEnum]; type AdHocSubProcessActivateActivitiesInstruction = { /** * Activities to activate. */ elements: Array; /** * Whether to cancel remaining instances of the ad-hoc sub-process. */ cancelRemainingInstances?: boolean; }; type AdHocSubProcessActivateActivityReference = { /** * The ID of the element that should be activated. */ elementId: ElementId; /** * Variables to be set when activating the element. */ variables?: { [key: string]: unknown; }; }; type ExpressionEvaluationRequest = { /** * The expression to evaluate (e.g., "=x + y") */ expression: string; /** * Required when the expression references tenant-scoped cluster variables */ tenantId?: string; /** * Optional variables for expression evaluation. These variables are only used for the current evaluation and do not persist beyond it. */ variables?: { [key: string]: unknown; } | null; }; type ExpressionEvaluationResult = { /** * The evaluated expression */ expression: string; /** * The result value. Its type can vary. */ result: unknown; /** * List of warnings generated during expression evaluation */ warnings: Array; }; type ExpressionEvaluationWarningItem = { /** * The warning message */ message: string; }; /** * Checks if the property matches the provided like value. * * Supported wildcard characters are: * * * `*`: matches zero, one, or multiple characters. * * `?`: matches one, single character. * * Wildcard characters can be escaped with backslash, for instance: `\*`. * */ type LikeFilter = string; /** * Advanced filter * * Basic advanced string filter. */ type BasicStringFilter = { /** * Checks for equality with the provided value. */ $eq?: string; /** * Checks for inequality with the provided value. */ $neq?: string; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; }; /** * Advanced filter * * Advanced string filter. */ type AdvancedStringFilter = BasicStringFilter & { $like?: LikeFilter; }; /** * String property with basic advanced search capabilities. */ type BasicStringFilterProperty = string | BasicStringFilter; /** * String property with full advanced search capabilities. */ type StringFilterProperty = string | AdvancedStringFilter; /** * Advanced filter * * Advanced integer (int32) filter. */ type AdvancedIntegerFilter = { /** * Checks for equality with the provided value. */ $eq?: number; /** * Checks for inequality with the provided value. */ $neq?: number; /** * Checks if the current property exists. */ $exists?: boolean; /** * Greater than comparison with the provided value. */ $gt?: number; /** * Greater than or equal comparison with the provided value. */ $gte?: number; /** * Lower than comparison with the provided value. */ $lt?: number; /** * Lower than or equal comparison with the provided value. */ $lte?: number; /** * Checks if the property matches any of the provided values. */ $in?: Array; }; /** * Integer property with advanced search capabilities. */ type IntegerFilterProperty = number | AdvancedIntegerFilter; /** * Advanced filter * * Advanced date-time filter. */ type AdvancedDateTimeFilter = { /** * Checks for equality with the provided value. */ $eq?: string; /** * Checks for inequality with the provided value. */ $neq?: string; /** * Checks if the current property exists. */ $exists?: boolean; /** * Greater than comparison with the provided value. */ $gt?: string; /** * Greater than or equal comparison with the provided value. */ $gte?: string; /** * Lower than comparison with the provided value. */ $lt?: string; /** * Lower than or equal comparison with the provided value. */ $lte?: string; /** * Checks if the property matches any of the provided values. */ $in?: Array; }; /** * Date-time property with full advanced search capabilities. */ type DateTimeFilterProperty = string | AdvancedDateTimeFilter; type FormResult = { /** * The tenant ID of the form. */ tenantId: TenantId; /** * The user-provided identifier of the form. */ formId: FormId; /** * The form schema as a JSON document serialized as a string. */ schema: string; /** * The version of the the deployed form. */ version: number; /** * The assigned key, which acts as a unique identifier for this form. */ formKey: FormKey; }; /** * How the global listener was defined. */ declare const GlobalListenerSourceEnum: { readonly CONFIGURATION: "CONFIGURATION"; readonly API: "API"; }; type GlobalListenerSourceEnum = (typeof GlobalListenerSourceEnum)[keyof typeof GlobalListenerSourceEnum]; /** * The event type that triggers the user task listener. */ declare const GlobalTaskListenerEventTypeEnum: { readonly all: "all"; readonly creating: "creating"; readonly assigning: "assigning"; readonly updating: "updating"; readonly completing: "completing"; readonly canceling: "canceling"; }; type GlobalTaskListenerEventTypeEnum = (typeof GlobalTaskListenerEventTypeEnum)[keyof typeof GlobalTaskListenerEventTypeEnum]; type GlobalListenerBase = { /** * The name of the job type, used as a reference to specify which job workers request the respective listener job. */ type?: string; /** * Number of retries for the listener job. */ retries?: number; /** * Whether the listener should run after model-level listeners. */ afterNonGlobal?: boolean; /** * The priority of the listener. Higher priority listeners are executed before lower priority ones. */ priority?: number; }; type GlobalTaskListenerBase = GlobalListenerBase & { eventTypes?: GlobalTaskListenerEventTypes; }; /** * List of user task event types that trigger the listener. */ type GlobalTaskListenerEventTypes = Array; type CreateGlobalTaskListenerRequest = GlobalTaskListenerBase & { id: GlobalListenerId; eventTypes: GlobalTaskListenerEventTypes; }; type UpdateGlobalTaskListenerRequest = GlobalTaskListenerBase; type GlobalTaskListenerResult = GlobalTaskListenerBase & { id: GlobalListenerId; source: GlobalListenerSourceEnum; eventTypes: GlobalTaskListenerEventTypes; }; /** * Global listener search query request. */ type GlobalTaskListenerSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The global listener search filters. */ filter?: GlobalTaskListenerSearchQueryFilterRequest; }; type GlobalTaskListenerSearchQuerySortRequest = { /** * The field to sort by. */ field: 'id' | 'type' | 'afterNonGlobal' | 'priority' | 'source'; order?: SortOrderEnum; }; /** * Global listener filter request. */ type GlobalTaskListenerSearchQueryFilterRequest = { /** * Id of the global listener. */ id?: StringFilterProperty; /** * Job type of the global listener. */ type?: StringFilterProperty; /** * Number of retries of the global listener. */ retries?: IntegerFilterProperty; /** * Event types of the global listener. */ eventTypes?: Array; /** * Whether the listener runs after model-level listeners. */ afterNonGlobal?: boolean; /** * Priority of the global listener. */ priority?: IntegerFilterProperty; /** * How the global listener was defined. */ source?: GlobalListenerSourceFilterProperty; }; /** * Global listener source property with full advanced search capabilities. */ type GlobalListenerSourceFilterProperty = GlobalListenerSourceExactMatch | AdvancedGlobalListenerSourceFilter; /** * Advanced filter * * Advanced global listener source filter. */ type AdvancedGlobalListenerSourceFilter = { /** * Checks for equality with the provided value. */ $eq?: GlobalListenerSourceEnum; /** * Checks for inequality with the provided value. */ $neq?: GlobalListenerSourceEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; /** * Global listener event type property with full advanced search capabilities. */ type GlobalTaskListenerEventTypeFilterProperty = GlobalTaskListenerEventTypeExactMatch | AdvancedGlobalTaskListenerEventTypeFilter; /** * Advanced filter * * Advanced global listener event type filter. */ type AdvancedGlobalTaskListenerEventTypeFilter = { /** * Checks for equality with the provided value. */ $eq?: GlobalTaskListenerEventTypeEnum; /** * Checks for inequality with the provided value. */ $neq?: GlobalTaskListenerEventTypeEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; /** * Global listener search query response. */ type GlobalTaskListenerSearchQueryResult = SearchQueryResponse & { /** * The matching global listeners. */ items: Array; }; type GroupCreateRequest = { /** * The ID of the new group. */ groupId: string; /** * The display name of the new group. */ name: string; /** * The description of the new group. */ description?: string; }; type GroupCreateResult = { /** * The ID of the created group. */ groupId: string; /** * The display name of the created group. */ name: string; /** * The description of the created group. */ description: string | null; }; type GroupUpdateRequest = { /** * The new name of the group. */ name: string; /** * The new description of the group. */ description?: string; }; type GroupUpdateResult = { /** * The unique external group ID. */ groupId: string; /** * The name of the group. */ name: string; /** * The description of the group. */ description: string | null; }; /** * Group search response item. */ type GroupResult = { /** * The group name. */ name: string; /** * The group ID. */ groupId: string; /** * The group description. */ description: string | null; }; type GroupSearchQuerySortRequest = { /** * The field to sort by. */ field: 'name' | 'groupId'; order?: SortOrderEnum; }; /** * Group search request. */ type GroupSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The group search filters. */ filter?: GroupFilter; }; /** * Group filter request */ type GroupFilter = { /** * The group ID search filters. */ groupId?: StringFilterProperty; /** * The group name search filters. */ name?: string; }; /** * Group search response. */ type GroupSearchQueryResult = SearchQueryResponse & { /** * The matching groups. */ items: Array; }; type GroupUserResult = { username: Username; }; type GroupUserSearchResult = SearchQueryResponse & { /** * The matching members. */ items: Array; }; type GroupUserSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; }; type GroupUserSearchQuerySortRequest = { /** * The field to sort by. */ field: 'username'; order?: SortOrderEnum; }; type GroupClientResult = { /** * The ID of the client. */ clientId: string; }; type GroupClientSearchResult = SearchQueryResponse & { /** * The matching client IDs. */ items: Array; }; type GroupClientSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; }; type GroupMappingRuleSearchResult = SearchQueryResponse & { /** * The matching mapping rules. */ items: Array; }; type GroupRoleSearchResult = SearchQueryResponse & { /** * The matching roles. */ items: Array; }; type GroupClientSearchQuerySortRequest = { /** * The field to sort by. */ field: 'clientId'; order?: SortOrderEnum; }; /** * List of tags. Tags need to start with a letter; then alphanumerics, `_`, `-`, `:`, or `.`; length ≤ 100. */ type TagSet = Array & { readonly length: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10; }; type IncidentSearchQuery = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The incident search filters. */ filter?: IncidentFilter; }; /** * Incident search filter. */ type IncidentFilter = { /** * The process definition ID associated to this incident. */ processDefinitionId?: StringFilterProperty; /** * Incident error type with a defined set of values. */ errorType?: IncidentErrorTypeFilterProperty; /** * The error message of this incident. */ errorMessage?: StringFilterProperty; /** * The element ID associated to this incident. */ elementId?: StringFilterProperty; /** * Date of incident creation. */ creationTime?: DateTimeFilterProperty; /** * State of this incident with a defined set of values. */ state?: IncidentStateFilterProperty; /** * The tenant ID of the incident. */ tenantId?: StringFilterProperty; /** * The assigned key, which acts as a unique identifier for this incident. */ incidentKey?: BasicStringFilterProperty; /** * The process definition key associated to this incident. */ processDefinitionKey?: ProcessDefinitionKeyFilterProperty; /** * The process instance key associated to this incident. */ processInstanceKey?: ProcessInstanceKeyFilterProperty; /** * The element instance key associated to this incident. */ elementInstanceKey?: ElementInstanceKeyFilterProperty; /** * The job key, if exists, associated with this incident. */ jobKey?: JobKeyFilterProperty; }; /** * IncidentErrorTypeEnum with full advanced search capabilities. */ type IncidentErrorTypeFilterProperty = IncidentErrorTypeExactMatch | AdvancedIncidentErrorTypeFilter; /** * Advanced filter * * Advanced IncidentErrorTypeEnum filter */ type AdvancedIncidentErrorTypeFilter = { /** * Checks for equality with the provided value. */ $eq?: IncidentErrorTypeEnum; /** * Checks for inequality with the provided value. */ $neq?: IncidentErrorTypeEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property does not match any of the provided values. */ $notIn?: Array; $like?: LikeFilter; }; /** * Incident error type with a defined set of values. */ declare const IncidentErrorTypeEnum: { readonly AD_HOC_SUB_PROCESS_NO_RETRIES: "AD_HOC_SUB_PROCESS_NO_RETRIES"; readonly CALLED_DECISION_ERROR: "CALLED_DECISION_ERROR"; readonly CALLED_ELEMENT_ERROR: "CALLED_ELEMENT_ERROR"; readonly CONDITION_ERROR: "CONDITION_ERROR"; readonly DECISION_EVALUATION_ERROR: "DECISION_EVALUATION_ERROR"; readonly EXECUTION_LISTENER_NO_RETRIES: "EXECUTION_LISTENER_NO_RETRIES"; readonly EXTRACT_VALUE_ERROR: "EXTRACT_VALUE_ERROR"; readonly FORM_NOT_FOUND: "FORM_NOT_FOUND"; readonly IO_MAPPING_ERROR: "IO_MAPPING_ERROR"; readonly JOB_NO_RETRIES: "JOB_NO_RETRIES"; readonly MESSAGE_SIZE_EXCEEDED: "MESSAGE_SIZE_EXCEEDED"; readonly RESOURCE_NOT_FOUND: "RESOURCE_NOT_FOUND"; readonly TASK_LISTENER_NO_RETRIES: "TASK_LISTENER_NO_RETRIES"; readonly UNHANDLED_ERROR_EVENT: "UNHANDLED_ERROR_EVENT"; readonly UNKNOWN: "UNKNOWN"; readonly UNSPECIFIED: "UNSPECIFIED"; }; type IncidentErrorTypeEnum = (typeof IncidentErrorTypeEnum)[keyof typeof IncidentErrorTypeEnum]; /** * IncidentStateEnum with full advanced search capabilities. */ type IncidentStateFilterProperty = IncidentStateExactMatch | AdvancedIncidentStateFilter; /** * Advanced filter * * Advanced IncidentStateEnum filter */ type AdvancedIncidentStateFilter = { /** * Checks for equality with the provided value. */ $eq?: IncidentStateEnum; /** * Checks for inequality with the provided value. */ $neq?: IncidentStateEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property does not match any of the provided values. */ $notIn?: Array; $like?: LikeFilter; }; /** * Incident states with a defined set of values. */ declare const IncidentStateEnum: { readonly ACTIVE: "ACTIVE"; readonly MIGRATED: "MIGRATED"; readonly PENDING: "PENDING"; readonly RESOLVED: "RESOLVED"; readonly UNKNOWN: "UNKNOWN"; }; type IncidentStateEnum = (typeof IncidentStateEnum)[keyof typeof IncidentStateEnum]; type IncidentSearchQuerySortRequest = { /** * The field to sort by. */ field: 'incidentKey' | 'processDefinitionKey' | 'processDefinitionId' | 'processInstanceKey' | 'errorType' | 'elementId' | 'elementInstanceKey' | 'creationTime' | 'state' | 'jobKey' | 'tenantId'; order?: SortOrderEnum; }; type IncidentSearchQueryResult = SearchQueryResponse & { /** * The matching incidents. */ items: Array; }; type IncidentResult = { /** * The process definition ID associated to this incident. */ processDefinitionId: ProcessDefinitionId; /** * The type of the incident error. */ errorType: IncidentErrorTypeEnum; /** * Error message which describes the error in more detail. */ errorMessage: string; /** * The element ID associated to this incident. */ elementId: ElementId; /** * The creation time of the incident. */ creationTime: string; /** * The incident state. */ state: IncidentStateEnum; /** * The tenant ID of the incident. */ tenantId: TenantId; /** * The assigned key, which acts as a unique identifier for this incident. */ incidentKey: IncidentKey; /** * The process definition key associated to this incident. */ processDefinitionKey: ProcessDefinitionKey; /** * The process instance key associated to this incident. */ processInstanceKey: ProcessInstanceKey; /** * The key of the root process instance. The root process instance is the top-level * ancestor in the process instance hierarchy. This field is only present for data * belonging to process instance hierarchies created in version 8.9 or later. * */ rootProcessInstanceKey: ProcessInstanceKey | null; /** * The element instance key associated to this incident. */ elementInstanceKey: ElementInstanceKey; /** * The job key, if exists, associated with this incident. */ jobKey: JobKey | null; }; type IncidentResolutionRequest = { operationReference?: OperationReference; }; type IncidentProcessInstanceStatisticsByErrorQuery = { /** * Pagination parameters for process instance statistics grouped by incident error. * */ page?: OffsetPagination; /** * Sorting criteria for process instance statistics grouped by incident error. */ sort?: Array; }; type IncidentProcessInstanceStatisticsByErrorQueryResult = SearchQueryResponse & { /** * Statistics of active process instances grouped by incident error. * */ items: Array; }; type IncidentProcessInstanceStatisticsByErrorResult = { /** * The hash code identifying a specific incident error.. */ errorHashCode: number; /** * The error message associated with the incident error hash code. */ errorMessage: string; /** * The number of active process instances that currently have an active incident with this error. * */ activeInstancesWithErrorCount: number; }; type IncidentProcessInstanceStatisticsByErrorQuerySortRequest = { /** * The field to sort the incident error statistics by. */ field: 'errorMessage' | 'activeInstancesWithErrorCount'; order?: SortOrderEnum; }; type IncidentProcessInstanceStatisticsByDefinitionQuery = { /** * Filter criteria for the aggregated process instance statistics. */ filter: IncidentProcessInstanceStatisticsByDefinitionFilter; /** * Pagination parameters for the aggregated process instance statistics. */ page?: OffsetPagination; /** * Sorting criteria for process instance statistics grouped by process definition. */ sort?: Array; }; type IncidentProcessInstanceStatisticsByDefinitionQueryResult = SearchQueryResponse & { /** * Statistics of active process instances with incidents, grouped by process * definition for the specified error hash code. * */ items: Array; }; type IncidentProcessInstanceStatisticsByDefinitionResult = { processDefinitionId: ProcessDefinitionId; processDefinitionKey: ProcessDefinitionKey; /** * The name of the process definition. */ processDefinitionName: string; /** * The version of the process definition. */ processDefinitionVersion: number; tenantId: TenantId; /** * The number of active process instances that currently have an incident * with the specified error hash code. * */ activeInstancesWithErrorCount: number; }; /** * Filter for the incident process instance statistics by definition query. */ type IncidentProcessInstanceStatisticsByDefinitionFilter = { /** * The error hash code of the incidents to filter the process instance statistics by. * */ errorHashCode: number; }; type IncidentProcessInstanceStatisticsByDefinitionQuerySortRequest = { /** * The aggregated field by which the process instance statistics are sorted. */ field: 'activeInstancesWithErrorCount' | 'processDefinitionKey' | 'tenantId'; order?: SortOrderEnum; }; /** * Global job statistics query result. */ type GlobalJobStatisticsQueryResult = { created: StatusMetric; completed: StatusMetric; failed: StatusMetric; /** * True if some data is missing because internal limits were reached and some metrics were not recorded. */ isIncomplete: boolean; }; /** * Metric for a single job status. */ type StatusMetric = { /** * Number of jobs in this status. */ count: number; /** * ISO 8601 timestamp of the last update for this status. */ lastUpdatedAt: string | null; }; /** * Job type statistics query. */ type JobTypeStatisticsQuery = { filter?: JobTypeStatisticsFilter; /** * Search cursor pagination. */ page?: CursorForwardPagination; }; /** * Job type statistics search filter. */ type JobTypeStatisticsFilter = { /** * Start of the time window to filter metrics. ISO 8601 date-time format. * */ from: string; /** * End of the time window to filter metrics. ISO 8601 date-time format. * */ to: string; /** * Optional job type filter with advanced search capabilities. * Supports exact match, pattern matching, and other operators. * */ jobType?: StringFilterProperty; }; /** * Job type statistics query result. */ type JobTypeStatisticsQueryResult = SearchQueryResponse & { /** * The list of job type statistics items. */ items: Array; page: SearchQueryPageResponse; }; /** * Statistics for a single job type. */ type JobTypeStatisticsItem = { /** * The job type identifier. */ jobType: string; created: StatusMetric; completed: StatusMetric; failed: StatusMetric; /** * Number of distinct workers observed for this job type. */ workers: number; }; /** * Job worker statistics query. */ type JobWorkerStatisticsQuery = { filter: JobWorkerStatisticsFilter; /** * Search cursor pagination. */ page?: CursorForwardPagination; }; /** * Job worker statistics search filter. */ type JobWorkerStatisticsFilter = { /** * Start of the time window to filter metrics. ISO 8601 date-time format. * */ from: string; /** * End of the time window to filter metrics. ISO 8601 date-time format. * */ to: string; /** * Job type to return worker metrics for. */ jobType: string; }; /** * Job worker statistics query result. */ type JobWorkerStatisticsQueryResult = SearchQueryResponse & { /** * The list of per-worker statistics items. */ items: Array; page: SearchQueryPageResponse; }; /** * Statistics for a single worker within a job type. */ type JobWorkerStatisticsItem = { /** * The name of the worker activating the jobs, mostly used for logging purposes. */ worker: string; created: StatusMetric; completed: StatusMetric; failed: StatusMetric; }; /** * Job time-series statistics query. */ type JobTimeSeriesStatisticsQuery = { filter: JobTimeSeriesStatisticsFilter; /** * Search cursor pagination. */ page?: CursorForwardPagination; }; /** * Job time-series statistics search filter. */ type JobTimeSeriesStatisticsFilter = { /** * Start of the time window to filter metrics. ISO 8601 date-time format. * */ from: string; /** * End of the time window to filter metrics. ISO 8601 date-time format. * */ to: string; /** * Job type to return time-series metrics for. */ jobType: string; /** * Time bucket resolution as an ISO 8601 duration (for example `PT1M` for 1 minute, * `PT1H` for 1 hour). If omitted, the server chooses a sensible default. * */ resolution?: string; }; /** * Job time-series statistics query result. */ type JobTimeSeriesStatisticsQueryResult = SearchQueryResponse & { /** * The list of time-bucketed statistics items, ordered ascending by time. */ items: Array; page: SearchQueryPageResponse; }; /** * Aggregated job metrics for a single time bucket. */ type JobTimeSeriesStatisticsItem = { /** * ISO 8601 timestamp representing the start of this time bucket. */ time: string; created: StatusMetric; completed: StatusMetric; failed: StatusMetric; }; /** * Job error statistics query. */ type JobErrorStatisticsQuery = { filter: JobErrorStatisticsFilter; /** * Search cursor pagination. */ page?: CursorForwardPagination; }; /** * Job error statistics search filter. */ type JobErrorStatisticsFilter = { /** * Start of the time window to filter metrics. ISO 8601 date-time format. * */ from: string; /** * End of the time window to filter metrics. ISO 8601 date-time format. * */ to: string; /** * Job type to return error metrics for. */ jobType: string; /** * Optional error code filter with advanced search capabilities. */ errorCode?: StringFilterProperty; /** * Optional error message filter with advanced search capabilities. */ errorMessage?: StringFilterProperty; }; /** * Job error statistics query result. */ type JobErrorStatisticsQueryResult = SearchQueryResponse & { /** * The list of per-error statistics items. */ items: Array; page: SearchQueryPageResponse; }; /** * Aggregated error metrics for a single error type and message combination. */ type JobErrorStatisticsItem = { /** * The error code identifier. */ errorCode: string; /** * The error message. */ errorMessage: string; /** * Number of distinct workers that encountered this error. */ workers: number; }; type JobActivationRequest = { /** * The job type, as defined in the BPMN process (e.g. ) */ type: string; /** * The name of the worker activating the jobs, mostly used for logging purposes. */ worker?: string; /** * A job returned after this call will not be activated by another call until the timeout (in ms) has been reached. * */ timeout: number; /** * The maximum jobs to activate by this request. */ maxJobsToActivate: number; /** * A list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned. */ fetchVariable?: Array; /** * The request will be completed when at least one job is activated or after the requestTimeout (in ms). If the requestTimeout = 0, a default timeout is used. If the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated. * */ requestTimeout?: number; /** * A list of IDs of tenants for which to activate jobs. */ tenantIds?: Array; /** * The tenant filtering strategy - determines whether to use provided tenant IDs or assigned tenant IDs from the authenticated principal's authorized tenants. * */ tenantFilter?: TenantFilterEnum; }; /** * The list of activated jobs */ type JobActivationResult = { /** * The activated jobs. */ jobs: Array; }; type ActivatedJobResult$1 = { /** * The type of the job (should match what was requested). */ type: string; /** * The bpmn process ID of the job's process definition. */ processDefinitionId: ProcessDefinitionId; /** * The version of the job's process definition. */ processDefinitionVersion: number; /** * The associated task element ID. */ elementId: ElementId; /** * A set of custom headers defined during modelling; returned as a serialized JSON document. */ customHeaders: { [key: string]: unknown; }; /** * The name of the worker which activated this job. */ worker: string; /** * The amount of retries left to this job (should always be positive). */ retries: number; /** * When the job can be activated again, sent as a UNIX epoch timestamp. */ deadline: number; /** * All variables visible to the task scope, computed at activation time. */ variables: { [key: string]: unknown; }; /** * The ID of the tenant that owns the job. */ tenantId: TenantId; /** * The key, a unique identifier for the job. */ jobKey: JobKey; /** * The job's process instance key. */ processInstanceKey: ProcessInstanceKey; /** * The key of the job's process definition. */ processDefinitionKey: ProcessDefinitionKey; /** * The element instance key of the task. */ elementInstanceKey: ElementInstanceKey; kind: JobKindEnum; listenerEventType: JobListenerEventTypeEnum; /** * User task properties, if the job is a user task. * This is `null` if the job is not a user task. * */ userTask: UserTaskProperties | null; tags: TagSet; /** * The key of the root process instance. The root process instance is the top-level * ancestor in the process instance hierarchy. This field is only present for data * belonging to process instance hierarchies created in version 8.9 or later. * */ rootProcessInstanceKey: ProcessInstanceKey | null; }; /** * Contains properties of a user task. */ type UserTaskProperties = { /** * The action performed on the user task. */ action: string; /** * The user assigned to the task. */ assignee: string | null; /** * The groups eligible to claim the task. */ candidateGroups: Array; /** * The users eligible to claim the task. */ candidateUsers: Array; /** * The attributes that were changed in the task. */ changedAttributes: Array; /** * The due date of the user task in ISO 8601 format. */ dueDate: string | null; /** * The follow-up date of the user task in ISO 8601 format. */ followUpDate: string | null; /** * The key of the form associated with the user task. */ formKey: FormKey | null; /** * The priority of the user task. */ priority: number | null; /** * The unique key identifying the user task. */ userTaskKey: UserTaskKey | null; }; /** * Job search request. */ type JobSearchQuery = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The job search filters. */ filter?: JobFilter; }; type JobSearchQuerySortRequest = { /** * The field to sort by. */ field: 'deadline' | 'deniedReason' | 'elementId' | 'elementInstanceKey' | 'endTime' | 'errorCode' | 'errorMessage' | 'hasFailedWithRetriesLeft' | 'isDenied' | 'jobKey' | 'kind' | 'listenerEventType' | 'processDefinitionId' | 'processDefinitionKey' | 'processInstanceKey' | 'retries' | 'state' | 'tenantId' | 'type' | 'worker'; order?: SortOrderEnum; }; /** * Job search filter. */ type JobFilter = { /** * When the job can next be activated. */ deadline?: DateTimeFilterProperty | null; /** * The reason provided by the user task listener for denying the work. */ deniedReason?: StringFilterProperty; /** * The element ID associated with the job. */ elementId?: StringFilterProperty; /** * The element instance key associated with the job. */ elementInstanceKey?: ElementInstanceKeyFilterProperty; /** * When the job ended. */ endTime?: DateTimeFilterProperty; /** * The error code provided for the failed job. */ errorCode?: StringFilterProperty; /** * The error message that provides additional context for a failed job. */ errorMessage?: StringFilterProperty; /** * Indicates whether the job has failed with retries left. */ hasFailedWithRetriesLeft?: boolean; /** * Indicates whether the user task listener denies the work. */ isDenied?: boolean | null; /** * The key, a unique identifier for the job. */ jobKey?: JobKeyFilterProperty; /** * The kind of the job. */ kind?: JobKindFilterProperty; /** * The listener event type of the job. */ listenerEventType?: JobListenerEventTypeFilterProperty; /** * The process definition ID associated with the job. */ processDefinitionId?: StringFilterProperty; /** * The process definition key associated with the job. */ processDefinitionKey?: ProcessDefinitionKeyFilterProperty; /** * The process instance key associated with the job. */ processInstanceKey?: ProcessInstanceKeyFilterProperty; /** * The number of retries left. */ retries?: IntegerFilterProperty; /** * The state of the job. */ state?: JobStateFilterProperty; /** * The tenant ID. */ tenantId?: StringFilterProperty; /** * The type of the job. */ type?: StringFilterProperty; /** * The name of the worker for this job. */ worker?: StringFilterProperty; /** * When the job was created. Field is present for jobs created after 8.9. */ creationTime?: DateTimeFilterProperty; /** * When the job was last updated. Field is present for jobs created after 8.9. */ lastUpdateTime?: DateTimeFilterProperty; }; /** * Job search response. */ type JobSearchQueryResult = SearchQueryResponse & { /** * The matching jobs. */ items: Array; }; type JobSearchResult = { /** * A set of custom headers defined during modelling. */ customHeaders: { [key: string]: string; }; /** * If the job has been activated, when it will next be available to be activated. */ deadline: string | null; /** * The reason provided by the user task listener for denying the work. */ deniedReason: string | null; /** * The element ID associated with the job. May be missing on job failure. */ elementId: ElementId | null; /** * The element instance key associated with the job. */ elementInstanceKey: ElementInstanceKey; /** * End date of the job. * This is `null` if the job is not in an end state yet. * */ endTime: string | null; /** * The error code provided for a failed job. */ errorCode: string | null; /** * The error message that provides additional context for a failed job. */ errorMessage: string | null; /** * Indicates whether the job has failed with retries left. */ hasFailedWithRetriesLeft: boolean; /** * Indicates whether the user task listener denies the work. */ isDenied: boolean | null; /** * The key, a unique identifier for the job. */ jobKey: JobKey; kind: JobKindEnum; listenerEventType: JobListenerEventTypeEnum; /** * The process definition ID associated with the job. */ processDefinitionId: ProcessDefinitionId; /** * The process definition key associated with the job. */ processDefinitionKey: ProcessDefinitionKey; /** * The process instance key associated with the job. */ processInstanceKey: ProcessInstanceKey; /** * The key of the root process instance. The root process instance is the top-level * ancestor in the process instance hierarchy. This field is only present for data * belonging to process instance hierarchies created in version 8.9 or later. * */ rootProcessInstanceKey: ProcessInstanceKey | null; /** * The amount of retries left to this job. */ retries: number; state: JobStateEnum; tenantId: TenantId; /** * The type of the job. */ type: string; /** * The name of the worker of this job. */ worker: string; /** * When the job was created. Field is present for jobs created after 8.9. */ creationTime: string | null; /** * When the job was last updated. Field is present for jobs created after 8.9. */ lastUpdateTime: string | null; }; type JobFailRequest = { /** * The amount of retries the job should have left */ retries?: number; /** * An optional error message describing why the job failed; if not provided, an empty string is used. */ errorMessage?: string; /** * An optional retry back off for the failed job. The job will not be retryable before the current time plus the back off time. The default is 0 which means the job is retryable immediately. */ retryBackOff?: number; /** * JSON object that will instantiate the variables at the local scope of the job's associated task. * */ variables?: { [key: string]: unknown; }; }; type JobErrorRequest$1 = { /** * The error code that will be matched with an error catch event. * */ errorCode: string; /** * An error message that provides additional context. * */ errorMessage?: string | null; /** * JSON object that will instantiate the variables at the local scope of the error catch event that catches the thrown error. * */ variables?: { [key: string]: unknown; } | null; }; type JobCompletionRequest = { /** * The variables to complete the job with. */ variables?: { [key: string]: unknown; } | null; result?: JobResult; }; /** * The result of the completed job as determined by the worker. * */ type JobResult = ({ type: 'userTask'; } & JobResultUserTask) | ({ type: 'adHocSubProcess'; } & JobResultAdHocSubProcess); /** * Job result details for a user task completion, optionally including a denial reason and corrected task properties. * */ type JobResultUserTask = { /** * Indicates whether the worker denies the work, i.e. explicitly doesn't approve it. For example, a user task listener can deny the completion of a task by setting this flag to true. In this example, the completion of a task is represented by a job that the worker can complete as denied. As a result, the completion request is rejected and the task remains active. Defaults to false. * */ denied?: boolean | null; /** * The reason provided by the user task listener for denying the work. */ deniedReason?: string | null; corrections?: JobResultCorrections; /** * Used to distinguish between different types of job results. */ type?: string; } | null; /** * JSON object with attributes that were corrected by the worker. * * The following attributes can be corrected, additional attributes will be ignored: * * * `assignee` - clear by providing an empty String * * `dueDate` - clear by providing an empty String * * `followUpDate` - clear by providing an empty String * * `candidateGroups` - clear by providing an empty list * * `candidateUsers` - clear by providing an empty list * * `priority` - minimum 0, maximum 100, default 50 * * Providing any of those attributes with a `null` value or omitting it preserves * the persisted attribute's value. * */ type JobResultCorrections = { /** * Assignee of the task. */ assignee?: string | null; /** * The due date of the task. */ dueDate?: string | null; /** * The follow-up date of the task. */ followUpDate?: string | null; /** * The list of candidate users of the task. */ candidateUsers?: Array | null; /** * The list of candidate groups of the task. */ candidateGroups?: Array | null; /** * The priority of the task. */ priority?: number | null; } | null; /** * Job result details for an ad‑hoc sub‑process, including elements to activate and flags indicating completion or cancellation behavior. * */ type JobResultAdHocSubProcess = { /** * Indicates which elements need to be activated in the ad-hoc subprocess. */ activateElements?: Array; /** * Indicates whether the completion condition of the ad-hoc subprocess is fulfilled. */ isCompletionConditionFulfilled?: boolean; /** * Indicates whether the remaining instances of the ad-hoc subprocess should be canceled. */ isCancelRemainingInstances?: boolean; /** * Used to distinguish between different types of job results. */ type?: string; } | null; /** * Instruction to activate a single BPMN element within an ad‑hoc sub‑process, optionally providing variables scoped to that element. */ type JobResultActivateElement = { /** * The element ID to activate. */ elementId?: ElementId; /** * Variables for the element. */ variables?: { [key: string]: unknown; } | null; }; type JobUpdateRequest = { changeset: JobChangeset; operationReference?: OperationReference; }; /** * JSON object with changed job attribute values. The job cannot be completed or failed with this endpoint, use the complete job or fail job endpoints instead. */ type JobChangeset = { /** * The new number of retries for the job. */ retries?: number | null; /** * The new timeout for the job in milliseconds. */ timeout?: number | null; }; /** * The tenant filtering strategy for job activation. Determines whether to use tenant IDs provided in the request or tenant IDs assigned to the authenticated principal. * */ declare const TenantFilterEnum: { readonly PROVIDED: "PROVIDED"; readonly ASSIGNED: "ASSIGNED"; }; type TenantFilterEnum = (typeof TenantFilterEnum)[keyof typeof TenantFilterEnum]; /** * The state of the job. */ declare const JobStateEnum: { readonly CANCELED: "CANCELED"; readonly COMPLETED: "COMPLETED"; readonly CREATED: "CREATED"; readonly ERROR_THROWN: "ERROR_THROWN"; readonly FAILED: "FAILED"; readonly MIGRATED: "MIGRATED"; readonly RETRIES_UPDATED: "RETRIES_UPDATED"; readonly TIMED_OUT: "TIMED_OUT"; }; type JobStateEnum = (typeof JobStateEnum)[keyof typeof JobStateEnum]; /** * The job kind. */ declare const JobKindEnum: { readonly BPMN_ELEMENT: "BPMN_ELEMENT"; readonly EXECUTION_LISTENER: "EXECUTION_LISTENER"; readonly TASK_LISTENER: "TASK_LISTENER"; readonly AD_HOC_SUB_PROCESS: "AD_HOC_SUB_PROCESS"; }; type JobKindEnum = (typeof JobKindEnum)[keyof typeof JobKindEnum]; /** * The listener event type of the job. */ declare const JobListenerEventTypeEnum: { readonly ASSIGNING: "ASSIGNING"; readonly CANCELING: "CANCELING"; readonly COMPLETING: "COMPLETING"; readonly CREATING: "CREATING"; readonly END: "END"; readonly START: "START"; readonly UNSPECIFIED: "UNSPECIFIED"; readonly UPDATING: "UPDATING"; }; type JobListenerEventTypeEnum = (typeof JobListenerEventTypeEnum)[keyof typeof JobListenerEventTypeEnum]; /** * JobKindEnum property with full advanced search capabilities. */ type JobKindFilterProperty = JobKindExactMatch | AdvancedJobKindFilter; /** * Advanced filter * * Advanced JobKindEnum filter. */ type AdvancedJobKindFilter = { /** * Checks for equality with the provided value. */ $eq?: JobKindEnum; /** * Checks for inequality with the provided value. */ $neq?: JobKindEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; /** * JobListenerEventTypeEnum property with full advanced search capabilities. */ type JobListenerEventTypeFilterProperty = JobListenerEventTypeExactMatch | AdvancedJobListenerEventTypeFilter; /** * Advanced filter * * Advanced JobListenerEventTypeEnum filter. */ type AdvancedJobListenerEventTypeFilter = { /** * Checks for equality with the provided value. */ $eq?: JobListenerEventTypeEnum; /** * Checks for inequality with the provided value. */ $neq?: JobListenerEventTypeEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; /** * JobStateEnum property with full advanced search capabilities. */ type JobStateFilterProperty = JobStateExactMatch | AdvancedJobStateFilter; /** * Advanced filter * * Advanced JobStateEnum filter. */ type AdvancedJobStateFilter = { /** * Checks for equality with the provided value. */ $eq?: JobStateEnum; /** * Checks for inequality with the provided value. */ $neq?: JobStateEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; /** * Zeebe Engine resource key (Java long serialized as string) */ type LongKey = string; /** * System-generated key for a scope. A scope can hold variables and represents either an * element instance in a BPMN process or the process instance itself. * */ type ScopeKey = ProcessInstanceKey | ElementInstanceKey; /** * A reference key chosen by the user that will be part of all records resulting from this operation. * Must be > 0 if provided. * */ type OperationReference = number; /** * ProcessDefinitionKey property with full advanced search capabilities. */ type ProcessDefinitionKeyFilterProperty = ProcessDefinitionKeyExactMatch | AdvancedProcessDefinitionKeyFilter; /** * Advanced filter * * Advanced ProcessDefinitionKey filter. */ type AdvancedProcessDefinitionKeyFilter = { /** * Checks for equality with the provided value. */ $eq?: ProcessDefinitionKey; /** * Checks for inequality with the provided value. */ $neq?: ProcessDefinitionKey; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; }; /** * ProcessInstanceKey property with full advanced search capabilities. */ type ProcessInstanceKeyFilterProperty = ProcessInstanceKeyExactMatch | AdvancedProcessInstanceKeyFilter; /** * Advanced filter * * Advanced ProcessInstanceKey filter. */ type AdvancedProcessInstanceKeyFilter = { /** * Checks for equality with the provided value. */ $eq?: ProcessInstanceKey; /** * Checks for inequality with the provided value. */ $neq?: ProcessInstanceKey; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; }; /** * ElementInstanceKey property with full advanced search capabilities. */ type ElementInstanceKeyFilterProperty = ElementInstanceKeyExactMatch | AdvancedElementInstanceKeyFilter; /** * Advanced filter * * Advanced ElementInstanceKey filter. */ type AdvancedElementInstanceKeyFilter = { /** * Checks for equality with the provided value. */ $eq?: ElementInstanceKey; /** * Checks for inequality with the provided value. */ $neq?: ElementInstanceKey; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; }; /** * JobKey property with full advanced search capabilities. */ type JobKeyFilterProperty = JobKeyExactMatch | AdvancedJobKeyFilter; /** * Advanced filter * * Advanced JobKey filter. */ type AdvancedJobKeyFilter = { /** * Checks for equality with the provided value. */ $eq?: JobKey; /** * Checks for inequality with the provided value. */ $neq?: JobKey; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; }; /** * DecisionDefinitionKey property with full advanced search capabilities. */ type DecisionDefinitionKeyFilterProperty = DecisionDefinitionKeyExactMatch | AdvancedDecisionDefinitionKeyFilter; /** * Advanced filter * * Advanced DecisionDefinitionKey filter. */ type AdvancedDecisionDefinitionKeyFilter = { /** * Checks for equality with the provided value. */ $eq?: DecisionDefinitionKey; /** * Checks for inequality with the provided value. */ $neq?: DecisionDefinitionKey; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; }; /** * ScopeKey property with full advanced search capabilities. Filter by the key of the * element instance or process instance that defines the scope of a variable. * */ type ScopeKeyFilterProperty = ScopeKeyExactMatch | AdvancedScopeKeyFilter; /** * Advanced filter * * Advanced ScopeKey filter. */ type AdvancedScopeKeyFilter = { /** * Checks for equality with the provided value. */ $eq?: ScopeKey; /** * Checks for inequality with the provided value. */ $neq?: ScopeKey; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; }; /** * VariableKey property with full advanced search capabilities. */ type VariableKeyFilterProperty = VariableKeyExactMatch | AdvancedVariableKeyFilter; /** * Advanced filter * * Advanced VariableKey filter. */ type AdvancedVariableKeyFilter = { /** * Checks for equality with the provided value. */ $eq?: VariableKey; /** * Checks for inequality with the provided value. */ $neq?: VariableKey; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; }; /** * DecisionEvaluationInstanceKey property with full advanced search capabilities. */ type DecisionEvaluationInstanceKeyFilterProperty = DecisionEvaluationInstanceKeyExactMatch | AdvancedDecisionEvaluationInstanceKeyFilter; /** * Advanced filter * * Advanced DecisionEvaluationInstanceKey filter. */ type AdvancedDecisionEvaluationInstanceKeyFilter = { /** * Checks for equality with the provided value. */ $eq?: DecisionEvaluationInstanceKey; /** * Checks for inequality with the provided value. */ $neq?: DecisionEvaluationInstanceKey; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; }; /** * AuditLogKey property with full advanced search capabilities. */ type AuditLogKeyFilterProperty = AuditLogKeyExactMatch | AdvancedAuditLogKeyFilter; /** * Advanced filter * * Advanced AuditLogKey filter. */ type AdvancedAuditLogKeyFilter = { /** * Checks for equality with the provided value. */ $eq?: AuditLogKey; /** * Checks for inequality with the provided value. */ $neq?: AuditLogKey; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; }; /** * FormKey property with full advanced search capabilities. */ type FormKeyFilterProperty = FormKeyExactMatch | AdvancedFormKeyFilter; /** * Advanced filter * * Advanced FormKey filter. */ type AdvancedFormKeyFilter = { /** * Checks for equality with the provided value. */ $eq?: FormKey; /** * Checks for inequality with the provided value. */ $neq?: FormKey; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; }; /** * DecisionEvaluationKey property with full advanced search capabilities. */ type DecisionEvaluationKeyFilterProperty = DecisionEvaluationKeyExactMatch | AdvancedDecisionEvaluationKeyFilter; /** * Advanced filter * * Advanced DecisionEvaluationKey filter. */ type AdvancedDecisionEvaluationKeyFilter = { /** * Checks for equality with the provided value. */ $eq?: DecisionEvaluationKey; /** * Checks for inequality with the provided value. */ $neq?: DecisionEvaluationKey; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; }; /** * DecisionRequirementsKey property with full advanced search capabilities. */ type DecisionRequirementsKeyFilterProperty = DecisionRequirementsKeyExactMatch | AdvancedDecisionRequirementsKeyFilter; /** * Advanced filter * * Advanced DecisionRequirementsKey filter. */ type AdvancedDecisionRequirementsKeyFilter = { /** * Checks for equality with the provided value. */ $eq?: DecisionRequirementsKey; /** * Checks for inequality with the provided value. */ $neq?: DecisionRequirementsKey; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; }; /** * The response of a license request. */ type LicenseResponse = { /** * True if the Camunda license is valid, false if otherwise */ validLicense: boolean; /** * Will return the license type property of the Camunda license */ licenseType: string; /** * Will be false when a license contains a non-commerical=true property */ isCommercial: boolean; /** * The date when the Camunda license expires */ expiresAt: string | null; }; type MappingRuleCreateUpdateRequest = { /** * The name of the claim to map. */ claimName: string; /** * The value of the claim to map. */ claimValue: string; /** * The name of the mapping rule. */ name: string; }; type MappingRuleCreateRequest = MappingRuleCreateUpdateRequest & { /** * The unique ID of the mapping rule. */ mappingRuleId: string; }; type MappingRuleUpdateRequest = MappingRuleCreateUpdateRequest; type MappingRuleCreateUpdateResult = { /** * The name of the claim to map. */ claimName: string; /** * The value of the claim to map. */ claimValue: string; /** * The name of the mapping rule. */ name: string; /** * The unique ID of the mapping rule. */ mappingRuleId: string; }; type MappingRuleCreateResult = MappingRuleCreateUpdateResult; type MappingRuleUpdateResult = MappingRuleCreateUpdateResult; type MappingRuleSearchQueryResult = SearchQueryResponse & { /** * The matching mapping rules. */ items: Array; }; type MappingRuleResult = { /** * The name of the claim to map. */ claimName: string; /** * The value of the claim to map. */ claimValue: string; /** * The name of the mapping rule. */ name: string; /** * The ID of the mapping rule. */ mappingRuleId: string; }; type MappingRuleSearchQuerySortRequest = { /** * The field to sort by. */ field: 'mappingRuleId' | 'claimName' | 'claimValue' | 'name'; order?: SortOrderEnum; }; type MappingRuleSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The mapping rule search filters. */ filter?: MappingRuleFilter; }; /** * Mapping rule search filter. */ type MappingRuleFilter = { /** * The claim name to match against a token. */ claimName?: string; /** * The value of the claim to match. */ claimValue?: string; /** * The name of the mapping rule. */ name?: string; /** * The ID of the mapping rule. */ mappingRuleId?: string; }; type MessageCorrelationRequest = { /** * The message name as defined in the BPMN process * */ name: string; /** * The correlation key of the message. */ correlationKey?: string; /** * The message variables as JSON document */ variables?: { [key: string]: unknown; }; /** * the tenant for which the message is published */ tenantId?: TenantId; }; /** * The message key of the correlated message, as well as the first process instance key it * correlated with. * */ type MessageCorrelationResult = { /** * The tenant ID of the correlated message */ tenantId: TenantId; /** * The key of the correlated message. */ messageKey: MessageKey; /** * The key of the first process instance the message correlated with */ processInstanceKey: ProcessInstanceKey; }; type MessagePublicationRequest = { /** * The name of the message. */ name: string; /** * The correlation key of the message. */ correlationKey?: string; /** * Timespan (in ms) to buffer the message on the broker. */ timeToLive?: number; /** * The unique ID of the message. This is used to ensure only one message with the given ID * will be published during the lifetime of the message (if `timeToLive` is set). * */ messageId?: string; /** * The message variables as JSON document. */ variables?: { [key: string]: unknown; }; /** * The tenant of the message sender. */ tenantId?: TenantId; }; /** * The message key of the published message. */ type MessagePublicationResult = { /** * The tenant ID of the message. */ tenantId: TenantId; /** * The key of the published message. */ messageKey: MessageKey; }; type MessageSubscriptionSearchQueryResult = SearchQueryResponse & { /** * The matching message subscriptions. */ items: Array; }; type MessageSubscriptionResult = { /** * The message subscription key associated with this message subscription. */ messageSubscriptionKey: MessageSubscriptionKey; /** * The process definition ID associated with this message subscription. */ processDefinitionId: ProcessDefinitionId; /** * The process definition key associated with this message subscription. */ processDefinitionKey: ProcessDefinitionKey | null; /** * The process instance key associated with this message subscription. */ processInstanceKey: ProcessInstanceKey | null; /** * The key of the root process instance. The root process instance is the top-level * ancestor in the process instance hierarchy. This field is only present for data * belonging to process instance hierarchies created in version 8.9 or later. * */ rootProcessInstanceKey: ProcessInstanceKey | null; /** * The element ID associated with this message subscription. */ elementId: ElementId; /** * The element instance key associated with this message subscription. */ elementInstanceKey: ElementInstanceKey | null; messageSubscriptionState: MessageSubscriptionStateEnum; /** * The last updated date of the message subscription. */ lastUpdatedDate: string; /** * The name of the message associated with the message subscription. */ messageName: string; /** * The correlation key of the message subscription. */ correlationKey: string | null; tenantId: TenantId; }; type MessageSubscriptionSearchQuerySortRequest = { /** * The field to sort by. */ field: 'messageSubscriptionKey' | 'processDefinitionId' | 'processInstanceKey' | 'elementId' | 'elementInstanceKey' | 'messageSubscriptionState' | 'lastUpdatedDate' | 'messageName' | 'correlationKey' | 'tenantId'; order?: SortOrderEnum; }; type MessageSubscriptionSearchQuery = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The incident search filters. */ filter?: MessageSubscriptionFilter; }; /** * Message subscription search filter. */ type MessageSubscriptionFilter = { /** * The message subscription key associated with this message subscription. */ messageSubscriptionKey?: MessageSubscriptionKeyFilterProperty; /** * The process definition key associated with this correlated message subscription. This only works for data created with 8.9 and later. */ processDefinitionKey?: ProcessDefinitionKeyFilterProperty; /** * The process definition ID associated with this message subscription. */ processDefinitionId?: StringFilterProperty; /** * The process instance key associated with this message subscription. */ processInstanceKey?: ProcessInstanceKeyFilterProperty; /** * The element ID associated with this message subscription. */ elementId?: StringFilterProperty; /** * The element instance key associated with this message subscription. */ elementInstanceKey?: ElementInstanceKeyFilterProperty; /** * The message subscription state. */ messageSubscriptionState?: MessageSubscriptionStateFilterProperty; /** * The last updated date of the message subscription. */ lastUpdatedDate?: DateTimeFilterProperty; /** * The name of the message associated with the message subscription. */ messageName?: StringFilterProperty; /** * The correlation key of the message subscription. */ correlationKey?: StringFilterProperty; /** * The unique external tenant ID. */ tenantId?: StringFilterProperty; }; type CorrelatedMessageSubscriptionSearchQueryResult = SearchQueryResponse & { /** * The matching correlated message subscriptions. */ items: Array; }; type CorrelatedMessageSubscriptionResult = { /** * The correlation key of the message. */ correlationKey: string | null; /** * The time when the message was correlated. */ correlationTime: string; /** * The element ID that received the message. */ elementId: string; /** * The element instance key that received the message. * It is `null` for start event subscriptions. * */ elementInstanceKey: ElementInstanceKey | null; /** * The message key. */ messageKey: MessageKey; /** * The name of the message. */ messageName: string; /** * The partition ID that correlated the message. */ partitionId: number; /** * The process definition ID associated with this correlated message subscription. */ processDefinitionId: ProcessDefinitionId; /** * The process definition key associated with this correlated message subscription. */ processDefinitionKey: ProcessDefinitionKey; /** * The process instance key associated with this correlated message subscription. */ processInstanceKey: ProcessInstanceKey; /** * The key of the root process instance. The root process instance is the top-level * ancestor in the process instance hierarchy. This field is only present for data * belonging to process instance hierarchies created in version 8.9 or later. * */ rootProcessInstanceKey: ProcessInstanceKey | null; /** * The subscription key that received the message. */ subscriptionKey: MessageSubscriptionKey; /** * The tenant ID associated with this correlated message subscription. */ tenantId: TenantId; }; type CorrelatedMessageSubscriptionSearchQuery = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The correlated message subscriptions search filters. */ filter?: CorrelatedMessageSubscriptionFilter; }; type CorrelatedMessageSubscriptionSearchQuerySortRequest = { /** * The field to sort by. */ field: 'correlationKey' | 'correlationTime' | 'elementId' | 'elementInstanceKey' | 'messageKey' | 'messageName' | 'partitionId' | 'processDefinitionId' | 'processDefinitionKey' | 'processInstanceKey' | 'subscriptionKey' | 'tenantId'; order?: SortOrderEnum; }; /** * The state of message subscription. */ declare const MessageSubscriptionStateEnum: { readonly CORRELATED: "CORRELATED"; readonly CREATED: "CREATED"; readonly DELETED: "DELETED"; readonly MIGRATED: "MIGRATED"; }; type MessageSubscriptionStateEnum = (typeof MessageSubscriptionStateEnum)[keyof typeof MessageSubscriptionStateEnum]; /** * Correlated message subscriptions search filter. */ type CorrelatedMessageSubscriptionFilter = { /** * The correlation key of the message. */ correlationKey?: StringFilterProperty; /** * The time when the message was correlated. */ correlationTime?: DateTimeFilterProperty; /** * The element ID that received the message. */ elementId?: StringFilterProperty; /** * The element instance key that received the message. */ elementInstanceKey?: ElementInstanceKeyFilterProperty; /** * The message key. */ messageKey?: BasicStringFilterProperty; /** * The name of the message. */ messageName?: StringFilterProperty; /** * The partition ID that correlated the message. */ partitionId?: IntegerFilterProperty; /** * The process definition ID associated with this correlated message subscription. */ processDefinitionId?: StringFilterProperty; /** * The process definition key associated with this correlated message subscription. For intermediate message events, this only works for data created with 8.9 and later. */ processDefinitionKey?: ProcessDefinitionKeyFilterProperty; /** * The process instance key associated with this correlated message subscription. */ processInstanceKey?: ProcessInstanceKeyFilterProperty; /** * The subscription key that received the message. */ subscriptionKey?: MessageSubscriptionKeyFilterProperty; /** * The tenant ID associated with this correlated message subscription. */ tenantId?: StringFilterProperty; }; /** * MessageSubscriptionStateEnum with full advanced search capabilities. */ type MessageSubscriptionStateFilterProperty = MessageSubscriptionStateExactMatch | AdvancedMessageSubscriptionStateFilter; /** * Advanced filter * * Advanced MessageSubscriptionStateEnum filter */ type AdvancedMessageSubscriptionStateFilter = { /** * Checks for equality with the provided value. */ $eq?: MessageSubscriptionStateEnum; /** * Checks for inequality with the provided value. */ $neq?: MessageSubscriptionStateEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; /** * Advanced filter * * Advanced MessageSubscriptionKey filter. */ type AdvancedMessageSubscriptionKeyFilter = { /** * Checks for equality with the provided value. */ $eq?: MessageSubscriptionKey; /** * Checks for equality with the provided value. */ $neq?: MessageSubscriptionKey; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; /** * Checks if the property matches none of the provided values. */ $notIn?: Array; }; /** * MessageSubscriptionKey property with full advanced search capabilities. */ type MessageSubscriptionKeyFilterProperty = MessageSubscriptionKeyExactMatch | AdvancedMessageSubscriptionKeyFilter; /** * A Problem detail object as described in [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457). There may be additional properties specific to the problem type. * */ type ProblemDetail = { /** * A URI identifying the problem type. */ type: string; /** * A summary of the problem type. */ title: string; /** * The HTTP status code for this problem. */ status: number; /** * An explanation of the problem in more detail. */ detail: string; /** * A URI path identifying the origin of the problem. */ instance: string; }; type ProcessDefinitionSearchQuerySortRequest = { /** * The field to sort by. */ field: 'processDefinitionKey' | 'name' | 'resourceName' | 'version' | 'versionTag' | 'processDefinitionId' | 'tenantId'; order?: SortOrderEnum; }; type ProcessDefinitionSearchQuery = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The process definition search filters. */ filter?: ProcessDefinitionFilter; }; /** * Process definition search filter. */ type ProcessDefinitionFilter = { /** * Name of this process definition. */ name?: StringFilterProperty; /** * Whether to only return the latest version of each process definition. * When using this filter, pagination functionality is limited, you can only paginate forward using `after` and `limit`. * The response contains no `startCursor` in the `page`, and requests ignore the `from` and `before` in the `page`. * When using this filter, sorting is limited to `processDefinitionId` and `tenantId` fields only. * */ isLatestVersion?: boolean; /** * Resource name of this process definition. */ resourceName?: string; /** * Version of this process definition. */ version?: number; /** * Version tag of this process definition. */ versionTag?: string; /** * Process definition ID of this process definition. */ processDefinitionId?: StringFilterProperty; /** * Tenant ID of this process definition. */ tenantId?: TenantId; /** * The key for this process definition. */ processDefinitionKey?: ProcessDefinitionKey; /** * Indicates whether the start event of the process has an associated Form Key. */ hasStartForm?: boolean; }; type ProcessDefinitionSearchQueryResult = SearchQueryResponse & { /** * The matching process definitions. */ items: Array; }; type ProcessDefinitionResult = { /** * Name of this process definition. */ name: string | null; /** * Resource name for this process definition. */ resourceName: string; /** * Version of this process definition. */ version: number; /** * Version tag of this process definition. */ versionTag: string | null; /** * Process definition ID of this process definition. */ processDefinitionId: ProcessDefinitionId; /** * Tenant ID of this process definition. */ tenantId: TenantId; /** * The key for this process definition. */ processDefinitionKey: ProcessDefinitionKey; /** * Indicates whether the start event of the process has an associated Form Key. */ hasStartForm: boolean; }; /** * Process definition element statistics request. */ type ProcessDefinitionElementStatisticsQuery = { /** * The process definition statistics search filters. */ filter?: ProcessDefinitionStatisticsFilter; }; /** * Process definition element statistics query response. */ type ProcessDefinitionElementStatisticsQueryResult = { /** * The element statistics. */ items: Array; }; /** * Process element statistics response. */ type ProcessElementStatisticsResult = { /** * The element ID for which the results are aggregated. */ elementId: ElementId; /** * The total number of active instances of the element. */ active: number; /** * The total number of canceled instances of the element. */ canceled: number; /** * The total number of incidents for the element. */ incidents: number; /** * The total number of completed instances of the element. */ completed: number; }; type ProcessDefinitionMessageSubscriptionStatisticsQuery = { /** * Search cursor pagination. */ page?: CursorForwardPagination; /** * The message subscription filters. */ filter?: MessageSubscriptionFilter; }; type ProcessDefinitionMessageSubscriptionStatisticsQueryResult = SearchQueryResponse & { /** * The matching process definition message subscription statistics. */ items: Array; }; type ProcessDefinitionMessageSubscriptionStatisticsResult = { /** * The process definition ID associated with this message subscription. */ processDefinitionId: ProcessDefinitionId; /** * The tenant ID associated with this message subscription. */ tenantId: TenantId; /** * The process definition key associated with this message subscription. */ processDefinitionKey: ProcessDefinitionKey; /** * The number of process instances with active message subscriptions. */ processInstancesWithActiveSubscriptions: number; /** * The total number of active message subscriptions for this process definition key. */ activeSubscriptions: number; }; type ProcessDefinitionInstanceStatisticsQuery = { /** * Search cursor pagination. */ page?: OffsetPagination; /** * Sort field criteria. */ sort?: Array; }; type ProcessDefinitionInstanceStatisticsQueryResult = SearchQueryResponse & { /** * The process definition instance statistics result. */ items: Array; }; /** * Process definition instance statistics response. */ type ProcessDefinitionInstanceStatisticsResult = { processDefinitionId: ProcessDefinitionId; tenantId: TenantId; /** * Name of the latest deployed process definition instance version. */ latestProcessDefinitionName: string | null; /** * Indicates whether multiple versions of this process definition instance are deployed. */ hasMultipleVersions: boolean; /** * Total number of currently active process instances of this definition that do not have incidents. */ activeInstancesWithoutIncidentCount: number; /** * Total number of currently active process instances of this definition that have at least one incident. */ activeInstancesWithIncidentCount: number; }; type ProcessDefinitionInstanceStatisticsQuerySortRequest = { /** * The field to sort by. */ field: 'processDefinitionId' | 'activeInstancesWithIncidentCount' | 'activeInstancesWithoutIncidentCount'; order?: SortOrderEnum; }; type ProcessDefinitionInstanceVersionStatisticsQuery = { /** * Pagination criteria. */ page?: OffsetPagination; /** * Sort field criteria. */ sort?: Array; /** * The process definition instance version statistics search filters. */ filter: ProcessDefinitionInstanceVersionStatisticsFilter; }; /** * Process definition instance version statistics search filter. */ type ProcessDefinitionInstanceVersionStatisticsFilter = { /** * The ID of the process definition to retrieve version statistics for. */ processDefinitionId: ProcessDefinitionId; /** * Tenant ID of this process definition. */ tenantId?: TenantId; }; type ProcessDefinitionInstanceVersionStatisticsQueryResult = SearchQueryResponse & { /** * The process definition instance version statistics result. */ items: Array; }; /** * Process definition instance version statistics response. */ type ProcessDefinitionInstanceVersionStatisticsResult = { /** * The ID associated with the process definition. */ processDefinitionId: ProcessDefinitionId; /** * The unique key of the process definition. */ processDefinitionKey: ProcessDefinitionKey; /** * The name of the process definition. */ processDefinitionName: string | null; /** * The tenant ID associated with the process definition. */ tenantId: TenantId; /** * The version number of the process definition. */ processDefinitionVersion: number; /** * The number of active process instances for this version that currently have incidents. */ activeInstancesWithIncidentCount: number; /** * The number of active process instances for this version that do not have any incidents. */ activeInstancesWithoutIncidentCount: number; }; type ProcessDefinitionInstanceVersionStatisticsQuerySortRequest = { /** * The field to sort by. */ field: 'processDefinitionId' | 'processDefinitionKey' | 'processDefinitionName' | 'processDefinitionVersion' | 'activeInstancesWithIncidentCount' | 'activeInstancesWithoutIncidentCount'; order?: SortOrderEnum; }; /** * Instructions for creating a process instance. The process definition can be specified * either by id or by key. * */ type ProcessInstanceCreationInstruction = ProcessInstanceCreationInstructionByKey | ProcessInstanceCreationInstructionById; /** * Process creation by id */ type ProcessInstanceCreationInstructionById = { /** * The BPMN process id of the process definition to start an instance of. * */ processDefinitionId: ProcessDefinitionId; /** * The version of the process. By default, the latest version of the process is used. * */ processDefinitionVersion?: number; /** * JSON object that will instantiate the variables for the root variable scope * of the process instance. * */ variables?: { [key: string]: unknown; }; /** * The tenant id of the process definition. * If multi-tenancy is enabled, provide the tenant id of the process definition to start a * process instance of. If multi-tenancy is disabled, don't provide this parameter. * */ tenantId?: TenantId; operationReference?: OperationReference; /** * List of start instructions. By default, the process instance will start at * the start event. If provided, the process instance will apply start instructions * after it has been created. * */ startInstructions?: Array; /** * Runtime instructions (alpha). List of instructions that affect the runtime behavior of * the process instance. Refer to specific instruction types for more details. * * This parameter is an alpha feature and may be subject to change * in future releases. * */ runtimeInstructions?: Array; /** * Wait for the process instance to complete. If the process instance does not complete * within the request timeout limit, a 504 response status will be returned. The process * instance will continue to run in the background regardless of the timeout. Disabled by * default. * */ awaitCompletion?: boolean; /** * List of variables by name to be included in the response when awaitCompletion is set to true. * If empty, all visible variables in the root scope will be returned. * */ fetchVariables?: Array; /** * Timeout (in ms) the request waits for the process to complete. By default or * when set to 0, the generic request timeout configured in the cluster is applied. * */ requestTimeout?: number; tags?: TagSet; businessId?: BusinessId; }; /** * Process creation by key */ type ProcessInstanceCreationInstructionByKey = { /** * The unique key identifying the process definition, for example, returned for a process in the * deploy resources endpoint. * */ processDefinitionKey: ProcessDefinitionKey; /** * As the version is already identified by the `processDefinitionKey`, the value of this field is ignored. * It's here for backwards-compatibility only as previous releases accepted it in request bodies. * */ processDefinitionVersion?: number; /** * Set of variables as JSON object to instantiate in the root variable scope of the process * instance. Can include nested complex objects. * */ variables?: { [key: string]: unknown; }; /** * List of start instructions. By default, the process instance will start at * the start event. If provided, the process instance will apply start instructions * after it has been created. * */ startInstructions?: Array; /** * Runtime instructions (alpha). List of instructions that affect the runtime behavior of * the process instance. Refer to specific instruction types for more details. * * This parameter is an alpha feature and may be subject to change * in future releases. * */ runtimeInstructions?: Array; /** * The tenant id of the process definition. * If multi-tenancy is enabled, provide the tenant id of the process definition to start a * process instance of. If multi-tenancy is disabled, don't provide this parameter. * */ tenantId?: TenantId; operationReference?: OperationReference; /** * Wait for the process instance to complete. If the process instance does not complete * within the request timeout limit, a 504 response status will be returned. The process * instance will continue to run in the background regardless of the timeout. Disabled by * default. * */ awaitCompletion?: boolean; /** * Timeout (in ms) the request waits for the process to complete. By default or * when set to 0, the generic request timeout configured in the cluster is applied. * */ requestTimeout?: number; /** * List of variables by name to be included in the response when awaitCompletion is set to true. * If empty, all visible variables in the root scope will be returned. * */ fetchVariables?: Array; tags?: TagSet; businessId?: BusinessId; }; type ProcessInstanceCreationStartInstruction = { /** * Future extensions might include: * - different types of start instructions * - ability to set local variables for different flow scopes * * For now, however, the start instruction is implicitly a "startBeforeElement" instruction * */ elementId: ElementId; }; type ProcessInstanceCreationRuntimeInstruction = { type: 'TERMINATE_PROCESS_INSTANCE'; } & ProcessInstanceCreationTerminateInstruction; /** * Terminates the process instance after a specific BPMN element is completed or terminated. * */ type ProcessInstanceCreationTerminateInstruction = { /** * The type of the runtime instruction */ type?: string; /** * The id of the element that, once completed or terminated, will cause the process to be terminated. * */ afterElementId: ElementId; }; type CreateProcessInstanceResult = { /** * The BPMN process id of the process definition which was used to create the process. * instance * */ processDefinitionId: ProcessDefinitionId; /** * The version of the process definition which was used to create the process instance. * */ processDefinitionVersion: number; /** * The tenant id of the created process instance. */ tenantId: TenantId; /** * All the variables visible in the root scope. */ variables: { [key: string]: unknown; }; /** * The key of the process definition which was used to create the process instance. * */ processDefinitionKey: ProcessDefinitionKey; /** * The unique identifier of the created process instance; to be used wherever a request * needs a process instance key (e.g. CancelProcessInstanceRequest). * */ processInstanceKey: ProcessInstanceKey; tags: TagSet; /** * Business id as provided on creation. */ businessId: BusinessId | null; }; type ProcessInstanceSearchQuerySortRequest = { /** * The field to sort by. */ field: 'processInstanceKey' | 'processDefinitionId' | 'processDefinitionName' | 'processDefinitionVersion' | 'processDefinitionVersionTag' | 'processDefinitionKey' | 'parentProcessInstanceKey' | 'parentElementInstanceKey' | 'startDate' | 'endDate' | 'state' | 'hasIncident' | 'tenantId' | 'businessId'; order?: SortOrderEnum; }; /** * Process instance search request. */ type ProcessInstanceSearchQuery = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The process instance search filters. */ filter?: ProcessInstanceFilter; }; /** * Base process instance search filter. */ type BaseProcessInstanceFilterFields = { /** * The start date. */ startDate?: DateTimeFilterProperty; /** * The end date. */ endDate?: DateTimeFilterProperty; /** * The process instance state. */ state?: ProcessInstanceStateFilterProperty; /** * Whether this process instance has a related incident or not. */ hasIncident?: boolean; /** * The tenant id. */ tenantId?: StringFilterProperty; /** * The process instance variables. */ variables?: Array; /** * The key of this process instance. */ processInstanceKey?: ProcessInstanceKeyFilterProperty; /** * The parent process instance key. */ parentProcessInstanceKey?: ProcessInstanceKeyFilterProperty; /** * The parent element instance key. */ parentElementInstanceKey?: ElementInstanceKeyFilterProperty; /** * The batch operation id. * **Deprecated**: Use `batchOperationKey` instead. This field will be removed in a future release. If both `batchOperationId` and `batchOperationKey` are provided, the request will be rejected with a 400 error. * * * @deprecated */ batchOperationId?: StringFilterProperty; /** * The batch operation key. */ batchOperationKey?: StringFilterProperty; /** * The error message related to the process. */ errorMessage?: StringFilterProperty; /** * Whether the process has failed jobs with retries left. */ hasRetriesLeft?: boolean; /** * The state of the element instances associated with the process instance. */ elementInstanceState?: ElementInstanceStateFilterProperty; /** * The element id associated with the process instance. */ elementId?: StringFilterProperty; /** * Whether the element instance has an incident or not. */ hasElementInstanceIncident?: boolean; /** * The incident error hash code, associated with this process. */ incidentErrorHashCode?: IntegerFilterProperty; tags?: TagSet; /** * The business id associated with the process instance. */ businessId?: StringFilterProperty; }; /** * Process definition statistics search filter. */ type ProcessDefinitionStatisticsFilter = BaseProcessInstanceFilterFields & { /** * Defines a list of alternative filter groups combined using OR logic. Each object in the array is evaluated independently, and the filter matches if any one of them is satisfied. * * Top-level fields and the `$or` clause are combined using AND logic — meaning: (top-level filters) AND (any of the `$or` filters) must match. *
* Example: * * ```json * { * "state": "ACTIVE", * "tenantId": 123, * "$or": [ * { "processDefinitionId": "process_v1" }, * { "processDefinitionId": "process_v2", "hasIncident": true } * ] * } * ``` * This matches process instances that: * *
    *
  • are in ACTIVE state
    • *
  • have tenant id equal to 123
    • *
  • and match either: *
      *
    • processDefinitionId is process_v1, or
      • *
    • processDefinitionId is process_v2 and hasIncident is true
      • *
    *
    • *
*
*

Note: Using complex $or conditions may impact performance, use with caution in high-volume environments. * */ $or?: Array; }; /** * Process instance search filter. */ type ProcessInstanceFilterFields = BaseProcessInstanceFilterFields & { /** * The process definition id. */ processDefinitionId?: StringFilterProperty; /** * The process definition name. */ processDefinitionName?: StringFilterProperty; /** * The process definition version. */ processDefinitionVersion?: IntegerFilterProperty; /** * The process definition version tag. */ processDefinitionVersionTag?: StringFilterProperty; /** * The process definition key. */ processDefinitionKey?: ProcessDefinitionKeyFilterProperty; }; /** * Process instance search filter. */ type ProcessInstanceFilter = ProcessInstanceFilterFields & { /** * Defines a list of alternative filter groups combined using OR logic. Each object in the array is evaluated independently, and the filter matches if any one of them is satisfied. * * Top-level fields and the `$or` clause are combined using AND logic — meaning: (top-level filters) AND (any of the `$or` filters) must match. *
* Example: * * ```json * { * "state": "ACTIVE", * "tenantId": 123, * "$or": [ * { "processDefinitionId": "process_v1" }, * { "processDefinitionId": "process_v2", "hasIncident": true } * ] * } * ``` * This matches process instances that: * *

    *
  • are in ACTIVE state
    • *
  • have tenant id equal to 123
    • *
  • and match either: *
      *
    • processDefinitionId is process_v1, or
      • *
    • processDefinitionId is process_v2 and hasIncident is true
      • *
    *
    • *
*
*

Note: Using complex $or conditions may impact performance, use with caution in high-volume environments. * */ $or?: Array; }; /** * Process instance search response. */ type ProcessInstanceSearchQueryResult = SearchQueryResponse & { /** * The matching process instances. */ items: Array; }; /** * Process instance search response item. */ type ProcessInstanceResult = { processDefinitionId: ProcessDefinitionId; /** * The process definition name. */ processDefinitionName: string | null; /** * The process definition version. */ processDefinitionVersion: number; /** * The process definition version tag. */ processDefinitionVersionTag: string | null; /** * The start time of the process instance. */ startDate: string; /** * The completion or termination time of the process instance. */ endDate: string | null; state: ProcessInstanceStateEnum; /** * Whether this process instance has a related incident or not. */ hasIncident: boolean; tenantId: TenantId; /** * The key of this process instance. */ processInstanceKey: ProcessInstanceKey; /** * The process definition key. */ processDefinitionKey: ProcessDefinitionKey; /** * The parent process instance key. */ parentProcessInstanceKey: ProcessInstanceKey | null; /** * The parent element instance key. */ parentElementInstanceKey: ElementInstanceKey | null; /** * The key of the root process instance. The root process instance is the top-level * ancestor in the process instance hierarchy. This field is only present for data * belonging to process instance hierarchies created in version 8.9 or later. * */ rootProcessInstanceKey: ProcessInstanceKey | null; tags: TagSet; /** * The business id associated with this process instance. */ businessId: BusinessId | null; }; type CancelProcessInstanceRequest = { operationReference?: OperationReference; } | null; type DeleteProcessInstanceRequest = { operationReference?: OperationReference; } | null; type ProcessInstanceCallHierarchyEntry = { /** * The key of the process instance. */ processInstanceKey: ProcessInstanceKey; /** * The key of the process definition. */ processDefinitionKey: ProcessDefinitionKey; /** * The name of the process definition (fall backs to the process definition id if not available). */ processDefinitionName: string; }; /** * Process instance sequence flows query response. */ type ProcessInstanceSequenceFlowsQueryResult = { /** * The sequence flows. */ items: Array; }; /** * Process instance sequence flow result. */ type ProcessInstanceSequenceFlowResult = { /** * The sequence flow id. */ sequenceFlowId: string; /** * The key of this process instance. */ processInstanceKey: ProcessInstanceKey; /** * The key of the root process instance. The root process instance is the top-level * ancestor in the process instance hierarchy. This field is only present for data * belonging to process instance hierarchies created in version 8.9 or later. * */ rootProcessInstanceKey: ProcessInstanceKey | null; /** * The process definition key. */ processDefinitionKey: ProcessDefinitionKey; /** * The process definition id. */ processDefinitionId: ProcessDefinitionId; /** * The element id for this sequence flow, as provided in the BPMN process. */ elementId: ElementId; tenantId: TenantId; }; /** * Process instance element statistics query response. */ type ProcessInstanceElementStatisticsQueryResult = { /** * The element statistics. */ items: Array; }; /** * The migration instructions describe how to migrate a process instance from one process definition to another. * */ type ProcessInstanceMigrationInstruction = { /** * The key of process definition to migrate the process instance to. */ targetProcessDefinitionKey: ProcessDefinitionKey; /** * Element mappings from the source process instance to the target process instance. */ mappingInstructions: Array; operationReference?: OperationReference; }; /** * The mapping instructions describe how to map elements from the source process definition to the target process definition. * */ type MigrateProcessInstanceMappingInstruction = { /** * The element id to migrate from. */ sourceElementId: ElementId; /** * The element id to migrate into. */ targetElementId: ElementId; }; type ProcessInstanceModificationInstruction = { operationReference?: OperationReference; /** * Instructions describing which elements to activate in which scopes and which variables to create or update. */ activateInstructions?: Array; /** * Instructions describing which elements to move from one scope to another. */ moveInstructions?: Array; /** * Instructions describing which elements to terminate. */ terminateInstructions?: Array; }; /** * Instruction describing an element to activate. */ type ProcessInstanceModificationActivateInstruction = { /** * The id of the element to activate. */ elementId: ElementId; /** * Instructions describing which variables to create or update. */ variableInstructions?: Array; /** * The key of the ancestor scope the element instance should be created in. * Set to -1 to create the new element instance within an existing element instance of the * flow scope. If multiple instances of the target element's flow scope exist, choose one * specifically with this property by providing its key. * */ ancestorElementInstanceKey?: ElementInstanceKey; }; /** * Instruction describing which variables to create or update. */ type ModifyProcessInstanceVariableInstruction = { /** * JSON document that will instantiate the variables at the scope defined by the scopeId. * It must be a JSON object, as variables will be mapped in a key-value fashion. * */ variables: { [key: string]: unknown; }; /** * The id of the element in which scope the variables should be created. * Leave empty to create the variables in the global scope of the process instance. * */ scopeId?: string; }; /** * Instruction describing a move operation. This instruction will terminate active element * instances based on the sourceElementInstruction and activate a new element instance for each terminated * one at targetElementId. Note that, for multi-instance activities, only the multi-instance * body instances will activate new element instances at the target id. * */ type ProcessInstanceModificationMoveInstruction = { sourceElementInstruction: SourceElementInstruction; /** * The target element id. */ targetElementId: ElementId; ancestorScopeInstruction?: AncestorScopeInstruction; /** * Instructions describing which variables to create or update. */ variableInstructions?: Array; }; /** * Defines the source element identifier for the move instruction. It can either be a sourceElementId, or sourceElementInstanceKey. * */ type SourceElementInstruction = ({ sourceType: 'byId'; } & SourceElementIdInstruction) | ({ sourceType: 'byKey'; } & SourceElementInstanceKeyInstruction); /** * Defines an instruction with a sourceElementId. The move instruction with this sourceType will terminate all active element * instances with the sourceElementId and activate a new element instance for each terminated * one at targetElementId. * */ type SourceElementIdInstruction = { /** * The type of source element instruction. */ sourceType: string; /** * The id of the source element for the move instruction. * */ sourceElementId: ElementId; }; /** * Defines an instruction with a sourceElementInstanceKey. The move instruction with this sourceType will terminate one active element * instance with the sourceElementInstanceKey and activate a new element instance at targetElementId. * */ type SourceElementInstanceKeyInstruction = { /** * The type of source element instruction. */ sourceType: string; /** * The source element instance key for the move instruction. * */ sourceElementInstanceKey: ElementInstanceKey; }; /** * Defines the ancestor scope for the created element instances. The default behavior resembles * a "direct" scope instruction with an `ancestorElementInstanceKey` of `"-1"`. * */ type AncestorScopeInstruction = ({ ancestorScopeType: 'direct'; } & DirectAncestorKeyInstruction) | ({ ancestorScopeType: 'inferred'; } & InferredAncestorKeyInstruction) | ({ ancestorScopeType: 'sourceParent'; } & UseSourceParentKeyInstruction); /** * Provides a concrete key to use as ancestor scope for the created element instance. */ type DirectAncestorKeyInstruction = { /** * The type of ancestor scope instruction. */ ancestorScopeType: string; /** * The key of the ancestor scope the element instance should be created in. * Set to -1 to create the new element instance within an existing element instance of the * flow scope. If multiple instances of the target element's flow scope exist, choose one * specifically with this property by providing its key. * */ ancestorElementInstanceKey: ElementInstanceKey; }; /** * Instructs the engine to derive the ancestor scope key from the source element's hierarchy. The engine traverses the source element's ancestry to find an instance that matches one of the target element's flow scopes, ensuring the target is activated in the correct scope. * */ type InferredAncestorKeyInstruction = { /** * The type of ancestor scope instruction. */ ancestorScopeType: string; }; /** * Instructs the engine to use the source's direct parent key as the ancestor scope key for the target element. This is a simpler alternative to `inferred` that skips hierarchy traversal and directly uses the source's parent key. This is useful when the source and target elements are siblings within the same flow scope. * */ type UseSourceParentKeyInstruction = { /** * The type of ancestor scope instruction. */ ancestorScopeType: string; }; /** * Instruction describing which elements to terminate. */ type ProcessInstanceModificationTerminateInstruction = ProcessInstanceModificationTerminateByIdInstruction | ProcessInstanceModificationTerminateByKeyInstruction; /** * Instruction describing which elements to terminate. The element instances are determined * at runtime by the given id. * */ type ProcessInstanceModificationTerminateByIdInstruction = { /** * The id of the elements to terminate. The element instances are determined at runtime. */ elementId: ElementId; }; /** * Instruction providing the key of the element instance to terminate. */ type ProcessInstanceModificationTerminateByKeyInstruction = { /** * The key of the element instance to terminate. */ elementInstanceKey: ElementInstanceKey; }; /** * Process instance states */ declare const ProcessInstanceStateEnum: { readonly ACTIVE: "ACTIVE"; readonly COMPLETED: "COMPLETED"; readonly TERMINATED: "TERMINATED"; }; type ProcessInstanceStateEnum = (typeof ProcessInstanceStateEnum)[keyof typeof ProcessInstanceStateEnum]; /** * Advanced filter * * Advanced ProcessInstanceStateEnum filter. */ type AdvancedProcessInstanceStateFilter = { /** * Checks for equality with the provided value. */ $eq?: ProcessInstanceStateEnum; /** * Checks for inequality with the provided value. */ $neq?: ProcessInstanceStateEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; /** * ProcessInstanceStateEnum property with full advanced search capabilities. */ type ProcessInstanceStateFilterProperty = ProcessInstanceStateExactMatch | AdvancedProcessInstanceStateFilter; type RoleCreateRequest = { /** * The ID of the new role. */ roleId: string; /** * The display name of the new role. */ name: string; /** * The description of the new role. */ description?: string; }; type RoleCreateResult = { /** * The ID of the created role. */ roleId: string; /** * The display name of the created role. */ name: string; /** * The description of the created role. */ description: string | null; }; type RoleUpdateRequest = { /** * The display name of the new role. */ name: string; /** * The description of the new role. */ description?: string; }; type RoleUpdateResult = { /** * The display name of the updated role. */ name: string; /** * The description of the updated role. */ description: string | null; /** * The ID of the updated role. */ roleId: string; }; /** * Role search response item. */ type RoleResult = { /** * The role name. */ name: string; /** * The role id. */ roleId: string; /** * The description of the role. */ description: string | null; }; type RoleSearchQuerySortRequest = { /** * The field to sort by. */ field: 'name' | 'roleId'; order?: SortOrderEnum; }; /** * Role search request. */ type RoleSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The role search filters. */ filter?: RoleFilter; }; /** * Role filter request */ type RoleFilter = { /** * The role ID search filters. */ roleId?: string; /** * The role name search filters. */ name?: string; }; /** * Role search response. */ type RoleSearchQueryResult = SearchQueryResponse & { /** * The matching roles. */ items: Array; }; type RoleUserResult = { username: Username; }; type RoleUserSearchResult = SearchQueryResponse & { /** * The matching users. */ items: Array; }; type RoleUserSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; }; type RoleUserSearchQuerySortRequest = { /** * The field to sort by. */ field: 'username'; order?: SortOrderEnum; }; type RoleClientResult = { /** * The ID of the client. */ clientId: string; }; type RoleClientSearchResult = SearchQueryResponse & { /** * The matching clients. */ items: Array; }; type RoleClientSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; }; type RoleClientSearchQuerySortRequest = { /** * The field to sort by. */ field: 'clientId'; order?: SortOrderEnum; }; type RoleGroupResult = { /** * The id of the group. */ groupId: string; }; type RoleGroupSearchResult = SearchQueryResponse & { /** * The matching groups. */ items: Array; }; type RoleGroupSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; }; type RoleMappingRuleSearchResult = SearchQueryResponse & { /** * The matching mapping rules. */ items: Array; }; type RoleGroupSearchQuerySortRequest = { /** * The field to sort by. */ field: 'groupId'; order?: SortOrderEnum; }; type SearchQueryRequest = { /** * Pagination criteria. */ page?: SearchQueryPageRequest; }; /** * Pagination criteria. Can use offset-based pagination (from/limit) OR cursor-based pagination (after/before + limit), but not both. */ type SearchQueryPageRequest = LimitPagination | OffsetPagination | CursorForwardPagination | CursorBackwardPagination; /** * Limit-based pagination */ type LimitPagination = { /** * The maximum number of items to return in one request. */ limit?: number; }; /** * Offset-based pagination */ type OffsetPagination = { /** * The index of items to start searching from. */ from?: number; /** * The maximum number of items to return in one request. */ limit?: number; }; /** * Cursor-based forward pagination */ type CursorForwardPagination = { /** * Use the `endCursor` value from the previous response to fetch the next page of results. */ after: EndCursor; /** * The maximum number of items to return in one request. */ limit?: number; }; /** * Cursor-based backward pagination */ type CursorBackwardPagination = { /** * Use the `startCursor` value from the previous response to fetch the previous page of results. */ before: StartCursor; /** * The maximum number of items to return in one request. */ limit?: number; }; type SearchQueryResponse = { page: SearchQueryPageResponse; }; /** * The order in which to sort the related field. */ declare const SortOrderEnum: { readonly ASC: "ASC"; readonly DESC: "DESC"; }; type SortOrderEnum = (typeof SortOrderEnum)[keyof typeof SortOrderEnum]; /** * Pagination information about the search results. */ type SearchQueryPageResponse = { /** * Total items matching the criteria. */ totalItems: number; /** * Indicates whether the `totalItems` value has been capped due to system limits. When true, `totalItems` is a lower bound and the actual number of matching items is greater than the reported value. * */ hasMoreTotalItems: boolean; /** * The cursor value for getting the previous page of results. Use this in the `before` field of an ensuing request. */ startCursor: StartCursor | null; /** * The cursor value for getting the next page of results. Use this in the `after` field of an ensuing request. */ endCursor: EndCursor | null; }; type SignalBroadcastRequest = { /** * The name of the signal to broadcast. */ signalName: string; /** * The signal variables as a JSON object. */ variables?: { [key: string]: unknown; }; /** * The ID of the tenant that owns the signal. */ tenantId?: TenantId; }; type SignalBroadcastResult = { /** * The tenant ID of the signal that was broadcast. */ tenantId: TenantId; /** * The key of the broadcasted signal. */ signalKey: SignalKey; }; type UsageMetricsResponse = UsageMetricsResponseItem & { /** * The amount of active tenants. */ activeTenants: number; /** * The usage metrics by tenants. Only available if request `withTenants` query parameter was `true`. */ tenants: { [key: string]: UsageMetricsResponseItem; }; }; type UsageMetricsResponseItem = { /** * The amount of created root process instances. */ processInstances: number; /** * The amount of executed decision instances. */ decisionInstances: number; /** * The amount of unique active task users. */ assignees: number; }; /** * Envelope for all system configuration sections. Each property * represents a feature area. * */ type SystemConfigurationResponse = { jobMetrics: JobMetricsConfigurationResponse; }; /** * Configuration for job metrics collection and export. */ type JobMetricsConfigurationResponse = { /** * Whether job metrics export is enabled. */ enabled: boolean; /** * The interval at which job metrics are exported, as an ISO 8601 duration. */ exportInterval: string; /** * The maximum length of the worker name used in job metrics labels. */ maxWorkerNameLength: number; /** * The maximum length of the job type used in job metrics labels. */ maxJobTypeLength: number; /** * The maximum length of the tenant ID used in job metrics labels. */ maxTenantIdLength: number; /** * The maximum number of unique metric keys tracked for job metrics. */ maxUniqueKeys: number; }; type TenantCreateRequest = { /** * The unique ID for the tenant. Must be 255 characters or less. Can contain letters, numbers, [`_`, `-`, `+`, `.`, `@`]. */ tenantId: string; /** * The name of the tenant. */ name: string; /** * The description of the tenant. */ description?: string; }; type TenantCreateResult = { tenantId: TenantId; /** * The name of the tenant. */ name: string; /** * The description of the tenant. */ description: string | null; }; type TenantUpdateRequest = { /** * The new name of the tenant. */ name: string; /** * The new description of the tenant. */ description?: string; }; type TenantUpdateResult = { tenantId: TenantId; /** * The name of the tenant. */ name: string; /** * The description of the tenant. */ description: string | null; }; /** * Tenant search response item. */ type TenantResult = { /** * The tenant name. */ name: string; tenantId: TenantId; /** * The tenant description. */ description: string | null; }; type TenantSearchQuerySortRequest = { /** * The field to sort by. */ field: 'key' | 'name' | 'tenantId'; order?: SortOrderEnum; }; /** * Tenant search request */ type TenantSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The tenant search filters. */ filter?: TenantFilter; }; /** * Tenant filter request */ type TenantFilter = { tenantId?: TenantId; /** * The name of the tenant. */ name?: string; }; /** * Tenant search response. */ type TenantSearchQueryResult = SearchQueryResponse & { /** * The matching tenants. */ items: Array; }; type TenantUserResult = { username: Username; }; type TenantUserSearchResult = SearchQueryResponse & { /** * The matching users. */ items: Array; }; type TenantUserSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; }; type TenantUserSearchQuerySortRequest = { /** * The field to sort by. */ field: 'username'; order?: SortOrderEnum; }; type TenantClientResult = { /** * The ID of the client. */ clientId: string; }; type TenantClientSearchResult = SearchQueryResponse & { /** * The matching clients. */ items: Array; }; type TenantClientSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; }; type TenantClientSearchQuerySortRequest = { /** * The field to sort by. */ field: 'clientId'; order?: SortOrderEnum; }; type TenantGroupResult = { /** * The groupId of the group. */ groupId: string; }; type TenantGroupSearchResult = SearchQueryResponse & { /** * The matching groups. */ items: Array; }; type TenantGroupSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; }; type TenantRoleSearchResult = SearchQueryResponse & { /** * The matching roles. */ items: Array; }; type TenantMappingRuleSearchResult = SearchQueryResponse & { /** * The matching mapping rules. */ items: Array; }; type TenantGroupSearchQuerySortRequest = { /** * The field to sort by. */ field: 'groupId'; order?: SortOrderEnum; }; type UserTaskSearchQuerySortRequest = { /** * The field to sort by. */ field: 'creationDate' | 'completionDate' | 'followUpDate' | 'dueDate' | 'priority' | 'name'; order?: SortOrderEnum; }; /** * User task search query request. */ type UserTaskSearchQuery = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The user task search filters. */ filter?: UserTaskFilter; }; /** * User task filter request. */ type UserTaskFilter = { /** * The user task state. */ state?: UserTaskStateFilterProperty; /** * The assignee of the user task. */ assignee?: StringFilterProperty; /** * The priority of the user task. */ priority?: IntegerFilterProperty; /** * The element ID of the user task. */ elementId?: ElementId; /** * The task name. This only works for data created with 8.8 and onwards. Instances from prior versions don't contain this data and cannot be found. * */ name?: StringFilterProperty; /** * The candidate group for this user task. */ candidateGroup?: StringFilterProperty; /** * The candidate user for this user task. */ candidateUser?: StringFilterProperty; /** * Tenant ID of this user task. */ tenantId?: StringFilterProperty; /** * The ID of the process definition. */ processDefinitionId?: ProcessDefinitionId; /** * The user task creation date. */ creationDate?: DateTimeFilterProperty; /** * The user task completion date. */ completionDate?: DateTimeFilterProperty; /** * The user task follow-up date. */ followUpDate?: DateTimeFilterProperty; /** * The user task due date. */ dueDate?: DateTimeFilterProperty; /** * The variables of the process instance. */ processInstanceVariables?: Array; /** * The local variables of the user task. */ localVariables?: Array; /** * The key for this user task. */ userTaskKey?: UserTaskKey; /** * The key of the process definition. */ processDefinitionKey?: ProcessDefinitionKey; /** * The key of the process instance. */ processInstanceKey?: ProcessInstanceKey; /** * The key of the element instance. */ elementInstanceKey?: ElementInstanceKey; tags?: TagSet; }; /** * User task search query response. */ type UserTaskSearchQueryResult = SearchQueryResponse & { /** * The matching user tasks. */ items: Array; }; type UserTaskResult = { /** * The name for this user task. */ name: string | null; state: UserTaskStateEnum; /** * The assignee of the user task. */ assignee: string | null; /** * The element ID of the user task. */ elementId: ElementId; /** * The candidate groups for this user task. */ candidateGroups: Array; /** * The candidate users for this user task. */ candidateUsers: Array; /** * The ID of the process definition. */ processDefinitionId: ProcessDefinitionId; /** * The creation date of a user task. */ creationDate: string; /** * The completion date of a user task. */ completionDate: string | null; /** * The follow date of a user task. */ followUpDate: string | null; /** * The due date of a user task. */ dueDate: string | null; tenantId: TenantId; /** * The external form reference. */ externalFormReference: string | null; /** * The version of the process definition. */ processDefinitionVersion: number; /** * Custom headers for the user task. */ customHeaders: { [key: string]: string; }; /** * The priority of a user task. The higher the value the higher the priority. */ priority: number; /** * The key of the user task. */ userTaskKey: UserTaskKey; /** * The key of the element instance. */ elementInstanceKey: ElementInstanceKey; /** * The name of the process definition. * This is `null` if the process has no name defined. * */ processName: string | null; /** * The key of the process definition. */ processDefinitionKey: ProcessDefinitionKey; /** * The key of the process instance. */ processInstanceKey: ProcessInstanceKey; /** * The key of the root process instance. The root process instance is the top-level * ancestor in the process instance hierarchy. This field is only present for data * belonging to process instance hierarchies created in version 8.9 or later. * */ rootProcessInstanceKey: ProcessInstanceKey | null; /** * The key of the form. */ formKey: FormKey | null; tags: TagSet; }; type UserTaskCompletionRequest = { /** * The variables to complete the user task with. */ variables?: { [key: string]: unknown; } | null; /** * A custom action value that will be accessible from user task events resulting from this endpoint invocation. If not provided, it will default to "complete". * */ action?: string | null; }; type UserTaskAssignmentRequest = { /** * The assignee for the user task. The assignee must not be empty or `null`. */ assignee?: string; /** * By default, the task is reassigned if it was already assigned. Set this to `false` to return an error in such cases. The task must then first be unassigned to be assigned again. Use this when you have users picking from group task queues to prevent race conditions. * */ allowOverride?: boolean | null; /** * A custom action value that will be accessible from user task events resulting from this endpoint invocation. If not provided, it will default to "assign". * */ action?: string | null; }; type UserTaskUpdateRequest = { changeset?: Changeset; /** * A custom action value that will be accessible from user task events resulting from this endpoint invocation. If not provided, it will default to "update". * */ action?: string | null; }; /** * JSON object with changed task attribute values. * * The following attributes can be adjusted with this endpoint, additional attributes * will be ignored: * * * `candidateGroups` - reset by providing an empty list * * `candidateUsers` - reset by providing an empty list * * `dueDate` - reset by providing an empty String * * `followUpDate` - reset by providing an empty String * * `priority` - minimum 0, maximum 100, default 50 * * Providing any of those attributes with a `null` value or omitting it preserves * the persisted attribute's value. * * The assignee cannot be adjusted with this endpoint, use the Assign task endpoint. * This ensures correct event emission for assignee changes. * */ type Changeset = { /** * The due date of the task. Reset by providing an empty String. */ dueDate?: string | null; /** * The follow-up date of the task. Reset by providing an empty String. */ followUpDate?: string | null; /** * The list of candidate users of the task. Reset by providing an empty list. */ candidateUsers?: Array | null; /** * The list of candidate groups of the task. Reset by providing an empty list. */ candidateGroups?: Array | null; /** * The priority of the task. */ priority?: number | null; [key: string]: unknown | string | null | string | null | Array | null | Array | null | number | null | undefined; } | null; type UserTaskVariableSearchQuerySortRequest = { /** * The field to sort by. */ field: 'value' | 'name' | 'tenantId' | 'variableKey' | 'scopeKey' | 'processInstanceKey'; order?: SortOrderEnum; }; /** * User task search query request. */ type UserTaskVariableSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The user task variable search filters. */ filter?: UserTaskVariableFilter; }; /** * User task effective variable search query request. Uses offset-based pagination only. * */ type UserTaskEffectiveVariableSearchQueryRequest = { /** * Pagination parameters. */ page?: OffsetPagination; /** * Sort field criteria. */ sort?: Array; /** * The user task variable search filters. */ filter?: UserTaskVariableFilter; }; /** * User task search query request. */ type UserTaskAuditLogSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; filter?: UserTaskAuditLogFilter; }; /** * The state of the user task. * Note: FAILED state is only for legacy job-worker-based tasks. * */ declare const UserTaskStateEnum: { readonly CREATING: "CREATING"; readonly CREATED: "CREATED"; readonly ASSIGNING: "ASSIGNING"; readonly UPDATING: "UPDATING"; readonly COMPLETING: "COMPLETING"; readonly COMPLETED: "COMPLETED"; readonly CANCELING: "CANCELING"; readonly CANCELED: "CANCELED"; readonly FAILED: "FAILED"; }; type UserTaskStateEnum = (typeof UserTaskStateEnum)[keyof typeof UserTaskStateEnum]; /** * The user task variable search filters. */ type UserTaskVariableFilter = { /** * Name of the variable. */ name?: StringFilterProperty; }; /** * UserTaskStateEnum property with full advanced search capabilities. */ type UserTaskStateFilterProperty = UserTaskStateExactMatch | AdvancedUserTaskStateFilter; /** * Advanced filter * * Advanced UserTaskStateEnum filter. */ type AdvancedUserTaskStateFilter = { /** * Checks for equality with the provided value. */ $eq?: UserTaskStateEnum; /** * Checks for inequality with the provided value. */ $neq?: UserTaskStateEnum; /** * Checks if the current property exists. */ $exists?: boolean; /** * Checks if the property matches any of the provided values. */ $in?: Array; $like?: LikeFilter; }; /** * The user task audit log search filters. */ type UserTaskAuditLogFilter = { /** * The audit log operation type search filter. */ operationType?: OperationTypeFilterProperty; /** * The audit log result search filter. */ result?: AuditLogResultFilterProperty; /** * The audit log timestamp filter. */ timestamp?: DateTimeFilterProperty; /** * The actor type search filter. */ actorType?: AuditLogActorTypeFilterProperty; /** * The actor ID search filter. */ actorId?: StringFilterProperty; }; type UserRequest = { /** * The password of the user. */ password: string; /** * The username of the user. */ username: string; /** * The name of the user. */ name?: string; /** * The email of the user. */ email?: string; }; type UserCreateResult = { username: Username; /** * The name of the user. */ name: string | null; /** * The email of the user. */ email: string | null; }; type UserUpdateRequest = { /** * The password of the user. If blank, the password is unchanged. */ password?: string; /** * The name of the user. */ name?: string; /** * The email of the user. */ email?: string; }; type UserUpdateResult = { username: Username; /** * The name of the user. */ name: string | null; /** * The email of the user. */ email: string | null; }; type UserResult = { username: Username; /** * The name of the user. */ name: string | null; /** * The email of the user. */ email: string | null; }; type UserSearchQuerySortRequest = { /** * The field to sort by. */ field: 'username' | 'name' | 'email'; order?: SortOrderEnum; }; type UserSearchQueryRequest = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The user search filters. */ filter?: UserFilter; }; /** * User search filter. */ type UserFilter = { /** * The username of the user. */ username?: StringFilterProperty; /** * The name of the user. */ name?: StringFilterProperty; /** * The email of the user. */ email?: StringFilterProperty; }; type UserSearchResult = SearchQueryResponse & { /** * The matching users. */ items: Array; }; type VariableSearchQuerySortRequest = { /** * The field to sort by. */ field: 'value' | 'name' | 'tenantId' | 'variableKey' | 'scopeKey' | 'processInstanceKey'; order?: SortOrderEnum; }; /** * Variable search query request. */ type VariableSearchQuery = SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array; /** * The variable search filters. */ filter?: VariableFilter; }; /** * Variable filter request. */ type VariableFilter = { /** * Name of the variable. */ name?: StringFilterProperty; /** * The value of the variable. * Variable values in filters need to be in serialized JSON format. For example, a variable * with string value `myValue` can be found with the filter value `"myValue"`. Consider * appropriate escaping for special characters in JSON strings when constructing filter values. * */ value?: StringFilterProperty; /** * Tenant ID of this variable. */ tenantId?: TenantId; /** * Whether the value is truncated or not. */ isTruncated?: boolean; /** * The key for this variable. */ variableKey?: VariableKeyFilterProperty; /** * The key of the scope that defines where this variable is directly defined. This can be a * process instance key (for process-level variables) or an element instance key (for local * variables scoped to tasks, subprocesses, gateways, events, etc.). Use this filter to * find variables directly defined in specific scopes. Note that this does not include * variables from parent scopes that would be visible through the scope hierarchy. * */ scopeKey?: ScopeKeyFilterProperty; /** * The key of the process instance of this variable. */ processInstanceKey?: ProcessInstanceKeyFilterProperty; }; /** * Variable search query response. */ type VariableSearchQueryResult = SearchQueryResponse & { /** * The matching variables. */ items: Array; }; /** * Variable search response item. */ type VariableSearchResult = VariableResultBase & { /** * Value of this variable. Can be truncated. */ value: string; /** * Whether the value is truncated or not. */ isTruncated: boolean; }; /** * Variable search response item. */ type VariableResult = VariableResultBase & { /** * Full value of this variable. */ value: string; }; /** * Variable response item. */ type VariableResultBase = { /** * Name of this variable. */ name: string; /** * Tenant ID of this variable. */ tenantId: TenantId; /** * The key for this variable. */ variableKey: VariableKey; /** * The key of the scope where this variable is directly defined. For process-level * variables, this is the process instance key. For local variables, this is the key of the * specific element instance (task, subprocess, gateway, event, etc.) where the variable is * directly defined. * */ scopeKey: ScopeKey; /** * The key of the process instance of this variable. */ processInstanceKey: ProcessInstanceKey; /** * The key of the root process instance. The root process instance is the top-level * ancestor in the process instance hierarchy. This field is only present for data * belonging to process instance hierarchies created in version 8.9 or later. * */ rootProcessInstanceKey: ProcessInstanceKey | null; }; type VariableValueFilterProperty = { /** * Name of the variable. */ name: string; /** * The value of the variable. * Variable values in filters need to be in serialized JSON format. For example, a variable * with string value `myValue` can be found with the filter value `"myValue"`. Consider * appropriate escaping for special characters in JSON strings when constructing filter values. * */ value: StringFilterProperty; }; type SetVariableRequest = { /** * JSON object representing the variables to set in the element’s scope. */ variables: { [key: string]: unknown; }; /** * If set to `true`, the variables are merged strictly into the local scope (as specified * by the `elementInstanceKey`). Otherwise, the variables are propagated to upper scopes * and set at the outermost one. * * Let's consider the following example: * There are two scopes '1' and '2'. Scope '1' is the parent scope of '2'. The effective * variables of the scopes are: * 1 => { "foo" : 2 } * 2 => { "bar" : 1 } * * An update request with elementInstanceKey as '2', variables { "foo": 5 }, and local set * to `true` leaves scope '1' unchanged and adjusts scope '2' to { "bar": 1, "foo": 5 }. By * default, with local set to `false`, scope '1' will be { "foo": 5 } and scope '2' will be * { "bar": 1 }. */ local?: boolean; operationReference?: OperationReference; }; /** * Exact match * * Matches the value exactly. */ type AuditLogEntityKeyExactMatch = AuditLogEntityKey; /** * Exact match * * Matches the value exactly. */ type EntityTypeExactMatch = AuditLogEntityTypeEnum; /** * Exact match * * Matches the value exactly. */ type OperationTypeExactMatch = AuditLogOperationTypeEnum; /** * Exact match * * Matches the value exactly. */ type CategoryExactMatch = AuditLogCategoryEnum; /** * Exact match * * Matches the value exactly. */ type AuditLogResultExactMatch = AuditLogResultEnum; /** * Exact match * * Matches the value exactly. */ type AuditLogActorTypeExactMatch = AuditLogActorTypeEnum; /** * Exact match * * Matches the value exactly. */ type BatchOperationTypeExactMatch = BatchOperationTypeEnum; /** * Exact match * * Matches the value exactly. */ type BatchOperationStateExactMatch = BatchOperationStateEnum; /** * Exact match * * Matches the value exactly. */ type BatchOperationItemStateExactMatch = BatchOperationItemStateEnum; /** * Exact match * * Matches the value exactly. */ type ClusterVariableScopeExactMatch = ClusterVariableScopeEnum; /** * Exact match * * Matches the value exactly. */ type DecisionInstanceStateExactMatch = DecisionInstanceStateEnum; /** * Exact match * * Matches the value exactly. */ type DeploymentKeyExactMatch = DeploymentKey; /** * Exact match * * Matches the value exactly. */ type ResourceKeyExactMatch = ResourceKey; /** * Exact match * * Matches the value exactly. */ type ElementInstanceStateExactMatch = ElementInstanceStateEnum; /** * Exact match * * Matches the value exactly. */ type GlobalListenerSourceExactMatch = GlobalListenerSourceEnum; /** * Exact match * * Matches the value exactly. */ type GlobalTaskListenerEventTypeExactMatch = GlobalTaskListenerEventTypeEnum; /** * Exact match * * Matches the value exactly. */ type IncidentErrorTypeExactMatch = IncidentErrorTypeEnum; /** * Exact match * * Matches the value exactly. */ type IncidentStateExactMatch = IncidentStateEnum; /** * Exact match * * Matches the value exactly. */ type JobKindExactMatch = JobKindEnum; /** * Exact match * * Matches the value exactly. */ type JobListenerEventTypeExactMatch = JobListenerEventTypeEnum; /** * Exact match * * Matches the value exactly. */ type JobStateExactMatch = JobStateEnum; /** * Exact match * * Matches the value exactly. */ type ProcessDefinitionKeyExactMatch = ProcessDefinitionKey; /** * Exact match * * Matches the value exactly. */ type ProcessInstanceKeyExactMatch = ProcessInstanceKey; /** * Exact match * * Matches the value exactly. */ type ElementInstanceKeyExactMatch = ElementInstanceKey; /** * Exact match * * Matches the value exactly. */ type JobKeyExactMatch = JobKey; /** * Exact match * * Matches the value exactly. */ type DecisionDefinitionKeyExactMatch = DecisionDefinitionKey; /** * Exact match * * Matches the value exactly. */ type ScopeKeyExactMatch = ScopeKey; /** * Exact match * * Matches the value exactly. */ type VariableKeyExactMatch = VariableKey; /** * Exact match * * Matches the value exactly. */ type DecisionEvaluationInstanceKeyExactMatch = DecisionEvaluationInstanceKey; /** * Exact match * * Matches the value exactly. */ type AuditLogKeyExactMatch = AuditLogKey; /** * Exact match * * Matches the value exactly. */ type FormKeyExactMatch = FormKey; /** * Exact match * * Matches the value exactly. */ type DecisionEvaluationKeyExactMatch = DecisionEvaluationKey; /** * Exact match * * Matches the value exactly. */ type DecisionRequirementsKeyExactMatch = DecisionRequirementsKey; /** * Exact match * * Matches the value exactly. */ type MessageSubscriptionStateExactMatch = MessageSubscriptionStateEnum; /** * Exact match * * Matches the value exactly. */ type MessageSubscriptionKeyExactMatch = MessageSubscriptionKey; /** * Exact match * * Matches the value exactly. */ type ProcessInstanceStateExactMatch = ProcessInstanceStateEnum; /** * Exact match * * Matches the value exactly. */ type UserTaskStateExactMatch = UserTaskStateEnum; type SearchAuditLogsData = { body?: AuditLogSearchQueryRequest; path?: never; query?: never; url: '/audit-logs/search'; }; type SearchAuditLogsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: unknown; }; type SearchAuditLogsError = SearchAuditLogsErrors[keyof SearchAuditLogsErrors]; type SearchAuditLogsResponses = { /** * The audit logs search result. */ 200: AuditLogSearchQueryResult; }; type SearchAuditLogsResponse = SearchAuditLogsResponses[keyof SearchAuditLogsResponses]; type GetAuditLogData = { body?: never; path: { /** * The audit log key. */ auditLogKey: AuditLogKey; }; query?: never; url: '/audit-logs/{auditLogKey}'; }; type GetAuditLogErrors = { /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The audit log with the given key was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetAuditLogError = GetAuditLogErrors[keyof GetAuditLogErrors]; type GetAuditLogResponses = { /** * The audit log entry is successfully returned. */ 200: AuditLogResult; }; type GetAuditLogResponse = GetAuditLogResponses[keyof GetAuditLogResponses]; type GetAuthenticationData = { body?: never; path?: never; query?: never; url: '/authentication/me'; }; type GetAuthenticationErrors = { /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetAuthenticationError = GetAuthenticationErrors[keyof GetAuthenticationErrors]; type GetAuthenticationResponses = { /** * The current user is successfully returned. */ 200: CamundaUserResult; }; type GetAuthenticationResponse = GetAuthenticationResponses[keyof GetAuthenticationResponses]; type CreateAuthorizationData = { body: AuthorizationRequest; path?: never; query?: never; url: '/authorizations'; }; type CreateAuthorizationErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The owner was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type CreateAuthorizationError = CreateAuthorizationErrors[keyof CreateAuthorizationErrors]; type CreateAuthorizationResponses = { /** * The authorization was created successfully. */ 201: AuthorizationCreateResult; }; type CreateAuthorizationResponse = CreateAuthorizationResponses[keyof CreateAuthorizationResponses]; type SearchAuthorizationsData = { body?: AuthorizationSearchQuery; path?: never; query?: never; url: '/authorizations/search'; }; type SearchAuthorizationsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchAuthorizationsError = SearchAuthorizationsErrors[keyof SearchAuthorizationsErrors]; type SearchAuthorizationsResponses = { /** * The authorization search result. */ 200: AuthorizationSearchResult; }; type SearchAuthorizationsResponse = SearchAuthorizationsResponses[keyof SearchAuthorizationsResponses]; type DeleteAuthorizationData = { body?: never; path: { /** * The key of the authorization to delete. */ authorizationKey: AuthorizationKey; }; query?: never; url: '/authorizations/{authorizationKey}'; }; type DeleteAuthorizationErrors = { /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * The authorization with the authorizationKey was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type DeleteAuthorizationError = DeleteAuthorizationErrors[keyof DeleteAuthorizationErrors]; type DeleteAuthorizationResponses = { /** * The authorization was deleted successfully. */ 204: void; }; type DeleteAuthorizationResponse = DeleteAuthorizationResponses[keyof DeleteAuthorizationResponses]; type GetAuthorizationData = { body?: never; path: { /** * The key of the authorization to get. */ authorizationKey: AuthorizationKey; }; query?: never; url: '/authorizations/{authorizationKey}'; }; type GetAuthorizationErrors = { /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The authorization with the given key was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetAuthorizationError = GetAuthorizationErrors[keyof GetAuthorizationErrors]; type GetAuthorizationResponses = { /** * The authorization was successfully returned. */ 200: AuthorizationResult; }; type GetAuthorizationResponse = GetAuthorizationResponses[keyof GetAuthorizationResponses]; type UpdateAuthorizationData = { body: AuthorizationRequest; path: { /** * The key of the authorization to delete. */ authorizationKey: AuthorizationKey; }; query?: never; url: '/authorizations/{authorizationKey}'; }; type UpdateAuthorizationErrors = { /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * The authorization with the authorizationKey was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UpdateAuthorizationError = UpdateAuthorizationErrors[keyof UpdateAuthorizationErrors]; type UpdateAuthorizationResponses = { /** * The authorization was updated successfully. */ 204: void; }; type UpdateAuthorizationResponse = UpdateAuthorizationResponses[keyof UpdateAuthorizationResponses]; type SearchBatchOperationItemsData = { body?: BatchOperationItemSearchQuery; path?: never; query?: never; url: '/batch-operation-items/search'; }; type SearchBatchOperationItemsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchBatchOperationItemsError = SearchBatchOperationItemsErrors[keyof SearchBatchOperationItemsErrors]; type SearchBatchOperationItemsResponses = { /** * The batch operation search result. */ 200: BatchOperationItemSearchQueryResult; }; type SearchBatchOperationItemsResponse = SearchBatchOperationItemsResponses[keyof SearchBatchOperationItemsResponses]; type SearchBatchOperationsData = { body?: BatchOperationSearchQuery; path?: never; query?: never; url: '/batch-operations/search'; }; type SearchBatchOperationsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchBatchOperationsError = SearchBatchOperationsErrors[keyof SearchBatchOperationsErrors]; type SearchBatchOperationsResponses = { /** * The batch operation search result. */ 200: BatchOperationSearchQueryResult; }; type SearchBatchOperationsResponse = SearchBatchOperationsResponses[keyof SearchBatchOperationsResponses]; type GetBatchOperationData = { body?: never; path: { /** * The key (or operate legacy ID) of the batch operation. */ batchOperationKey: BatchOperationKey; }; query?: never; url: '/batch-operations/{batchOperationKey}'; }; type GetBatchOperationErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The batch operation is not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetBatchOperationError = GetBatchOperationErrors[keyof GetBatchOperationErrors]; type GetBatchOperationResponses = { /** * The batch operation was found. */ 200: BatchOperationResponse; }; type GetBatchOperationResponse = GetBatchOperationResponses[keyof GetBatchOperationResponses]; type CancelBatchOperationData = { body?: unknown; path: { /** * The key (or operate legacy ID) of the batch operation. */ batchOperationKey: BatchOperationKey; }; query?: never; url: '/batch-operations/{batchOperationKey}/cancellation'; }; type CancelBatchOperationErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found. The batch operation was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type CancelBatchOperationError = CancelBatchOperationErrors[keyof CancelBatchOperationErrors]; type CancelBatchOperationResponses = { /** * The batch operation cancel request was created. */ 204: void; }; type CancelBatchOperationResponse = CancelBatchOperationResponses[keyof CancelBatchOperationResponses]; type ResumeBatchOperationData = { body?: unknown; path: { /** * The key (or operate legacy ID) of the batch operation. */ batchOperationKey: BatchOperationKey; }; query?: never; url: '/batch-operations/{batchOperationKey}/resumption'; }; type ResumeBatchOperationErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found. The batch operation was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type ResumeBatchOperationError = ResumeBatchOperationErrors[keyof ResumeBatchOperationErrors]; type ResumeBatchOperationResponses = { /** * The batch operation resume request was created. */ 204: void; }; type ResumeBatchOperationResponse = ResumeBatchOperationResponses[keyof ResumeBatchOperationResponses]; type SuspendBatchOperationData = { body?: unknown; path: { /** * The key (or operate legacy ID) of the batch operation. */ batchOperationKey: BatchOperationKey; }; query?: never; url: '/batch-operations/{batchOperationKey}/suspension'; }; type SuspendBatchOperationErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found. The batch operation was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type SuspendBatchOperationError = SuspendBatchOperationErrors[keyof SuspendBatchOperationErrors]; type SuspendBatchOperationResponses = { /** * The batch operation pause request was created. */ 204: void; }; type SuspendBatchOperationResponse = SuspendBatchOperationResponses[keyof SuspendBatchOperationResponses]; type PinClockData = { body: ClockPinRequest; path?: never; query?: never; url: '/clock'; }; type PinClockErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type PinClockError = PinClockErrors[keyof PinClockErrors]; type PinClockResponses = { /** * The clock was successfully pinned. */ 204: void; }; type PinClockResponse = PinClockResponses[keyof PinClockResponses]; type ResetClockData = { body?: never; path?: never; query?: never; url: '/clock/reset'; }; type ResetClockErrors = { /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type ResetClockError = ResetClockErrors[keyof ResetClockErrors]; type ResetClockResponses = { /** * The clock was successfully reset to the system time. */ 204: void; }; type ResetClockResponse = ResetClockResponses[keyof ResetClockResponses]; type CreateGlobalClusterVariableData = { body: CreateClusterVariableRequest; path?: never; query?: never; url: '/cluster-variables/global'; }; type CreateGlobalClusterVariableErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type CreateGlobalClusterVariableError = CreateGlobalClusterVariableErrors[keyof CreateGlobalClusterVariableErrors]; type CreateGlobalClusterVariableResponses = { /** * Cluster variable created */ 200: ClusterVariableResult; }; type CreateGlobalClusterVariableResponse = CreateGlobalClusterVariableResponses[keyof CreateGlobalClusterVariableResponses]; type DeleteGlobalClusterVariableData = { body?: never; path: { /** * The name of the cluster variable */ name: string; }; query?: never; url: '/cluster-variables/global/{name}'; }; type DeleteGlobalClusterVariableErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Cluster variable not found */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type DeleteGlobalClusterVariableError = DeleteGlobalClusterVariableErrors[keyof DeleteGlobalClusterVariableErrors]; type DeleteGlobalClusterVariableResponses = { /** * Cluster variable deleted successfully */ 204: void; }; type DeleteGlobalClusterVariableResponse = DeleteGlobalClusterVariableResponses[keyof DeleteGlobalClusterVariableResponses]; type GetGlobalClusterVariableData = { body?: never; path: { /** * The name of the cluster variable */ name: string; }; query?: never; url: '/cluster-variables/global/{name}'; }; type GetGlobalClusterVariableErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Cluster variable not found */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetGlobalClusterVariableError = GetGlobalClusterVariableErrors[keyof GetGlobalClusterVariableErrors]; type GetGlobalClusterVariableResponses = { /** * Cluster variable found */ 200: ClusterVariableResult; }; type GetGlobalClusterVariableResponse = GetGlobalClusterVariableResponses[keyof GetGlobalClusterVariableResponses]; type UpdateGlobalClusterVariableData = { body: UpdateClusterVariableRequest; path: { /** * The name of the cluster variable */ name: string; }; query?: never; url: '/cluster-variables/global/{name}'; }; type UpdateGlobalClusterVariableErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Cluster variable not found */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type UpdateGlobalClusterVariableError = UpdateGlobalClusterVariableErrors[keyof UpdateGlobalClusterVariableErrors]; type UpdateGlobalClusterVariableResponses = { /** * Cluster variable updated successfully */ 200: ClusterVariableResult; }; type UpdateGlobalClusterVariableResponse = UpdateGlobalClusterVariableResponses[keyof UpdateGlobalClusterVariableResponses]; type SearchClusterVariablesData = { body?: ClusterVariableSearchQueryRequest; path?: never; query?: { /** * When true (default), long variable values in the response are truncated. When false, full variable values are returned. */ truncateValues?: boolean; }; url: '/cluster-variables/search'; }; type SearchClusterVariablesErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchClusterVariablesError = SearchClusterVariablesErrors[keyof SearchClusterVariablesErrors]; type SearchClusterVariablesResponses = { /** * The cluster variable search result. */ 200: ClusterVariableSearchQueryResult; }; type SearchClusterVariablesResponse = SearchClusterVariablesResponses[keyof SearchClusterVariablesResponses]; type CreateTenantClusterVariableData = { body: CreateClusterVariableRequest; path: { /** * The tenant ID */ tenantId: TenantId; }; query?: never; url: '/cluster-variables/tenants/{tenantId}'; }; type CreateTenantClusterVariableErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The tenant with the given ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type CreateTenantClusterVariableError = CreateTenantClusterVariableErrors[keyof CreateTenantClusterVariableErrors]; type CreateTenantClusterVariableResponses = { /** * Cluster variable created */ 200: ClusterVariableResult; }; type CreateTenantClusterVariableResponse = CreateTenantClusterVariableResponses[keyof CreateTenantClusterVariableResponses]; type DeleteTenantClusterVariableData = { body?: never; path: { /** * The tenant ID */ tenantId: TenantId; /** * The name of the cluster variable */ name: string; }; query?: never; url: '/cluster-variables/tenants/{tenantId}/{name}'; }; type DeleteTenantClusterVariableErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Cluster variable not found */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type DeleteTenantClusterVariableError = DeleteTenantClusterVariableErrors[keyof DeleteTenantClusterVariableErrors]; type DeleteTenantClusterVariableResponses = { /** * Cluster variable deleted successfully */ 204: void; }; type DeleteTenantClusterVariableResponse = DeleteTenantClusterVariableResponses[keyof DeleteTenantClusterVariableResponses]; type GetTenantClusterVariableData = { body?: never; path: { /** * The tenant ID */ tenantId: TenantId; /** * The name of the cluster variable */ name: string; }; query?: never; url: '/cluster-variables/tenants/{tenantId}/{name}'; }; type GetTenantClusterVariableErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Cluster variable not found */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetTenantClusterVariableError = GetTenantClusterVariableErrors[keyof GetTenantClusterVariableErrors]; type GetTenantClusterVariableResponses = { /** * Cluster variable found */ 200: ClusterVariableResult; }; type GetTenantClusterVariableResponse = GetTenantClusterVariableResponses[keyof GetTenantClusterVariableResponses]; type UpdateTenantClusterVariableData = { body: UpdateClusterVariableRequest; path: { /** * The tenant ID */ tenantId: TenantId; /** * The name of the cluster variable */ name: string; }; query?: never; url: '/cluster-variables/tenants/{tenantId}/{name}'; }; type UpdateTenantClusterVariableErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Cluster variable not found */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type UpdateTenantClusterVariableError = UpdateTenantClusterVariableErrors[keyof UpdateTenantClusterVariableErrors]; type UpdateTenantClusterVariableResponses = { /** * Cluster variable updated successfully */ 200: ClusterVariableResult; }; type UpdateTenantClusterVariableResponse = UpdateTenantClusterVariableResponses[keyof UpdateTenantClusterVariableResponses]; type EvaluateConditionalsData = { body: ConditionalEvaluationInstruction; path?: never; query?: never; url: '/conditionals/evaluation'; }; type EvaluateConditionalsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The client is not authorized to start process instances for the specified process definition. * If a processDefinitionKey is not provided, this indicates that the client is not authorized * to start process instances for at least one of the matched process definitions. * */ 403: ProblemDetail; /** * The process definition was not found for the given processDefinitionKey. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type EvaluateConditionalsError = EvaluateConditionalsErrors[keyof EvaluateConditionalsErrors]; type EvaluateConditionalsResponses = { /** * Successfully evaluated root-level conditional start events. */ 200: EvaluateConditionalResult; }; type EvaluateConditionalsResponse = EvaluateConditionalsResponses[keyof EvaluateConditionalsResponses]; type SearchCorrelatedMessageSubscriptionsData = { body?: CorrelatedMessageSubscriptionSearchQuery; path?: never; query?: never; url: '/correlated-message-subscriptions/search'; }; type SearchCorrelatedMessageSubscriptionsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchCorrelatedMessageSubscriptionsError = SearchCorrelatedMessageSubscriptionsErrors[keyof SearchCorrelatedMessageSubscriptionsErrors]; type SearchCorrelatedMessageSubscriptionsResponses = { /** * The correlated message subscriptions search result. */ 200: CorrelatedMessageSubscriptionSearchQueryResult; }; type SearchCorrelatedMessageSubscriptionsResponse = SearchCorrelatedMessageSubscriptionsResponses[keyof SearchCorrelatedMessageSubscriptionsResponses]; type EvaluateDecisionData = { body: DecisionEvaluationInstruction; path?: never; query?: never; url: '/decision-definitions/evaluation'; }; type EvaluateDecisionErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The decision is not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type EvaluateDecisionError = EvaluateDecisionErrors[keyof EvaluateDecisionErrors]; type EvaluateDecisionResponses = { /** * The decision was evaluated. */ 200: EvaluateDecisionResult; }; type EvaluateDecisionResponse = EvaluateDecisionResponses[keyof EvaluateDecisionResponses]; type SearchDecisionDefinitionsData = { body?: DecisionDefinitionSearchQuery; path?: never; query?: never; url: '/decision-definitions/search'; }; type SearchDecisionDefinitionsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchDecisionDefinitionsError = SearchDecisionDefinitionsErrors[keyof SearchDecisionDefinitionsErrors]; type SearchDecisionDefinitionsResponses = { /** * The decision definition search result. */ 200: DecisionDefinitionSearchQueryResult; }; type SearchDecisionDefinitionsResponse = SearchDecisionDefinitionsResponses[keyof SearchDecisionDefinitionsResponses]; type GetDecisionDefinitionData = { body?: never; path: { /** * The assigned key of the decision definition, which acts as a unique identifier for this decision. */ decisionDefinitionKey: DecisionDefinitionKey; }; query?: never; url: '/decision-definitions/{decisionDefinitionKey}'; }; type GetDecisionDefinitionErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The decision definition with the given key was not found. More details are provided in the response body. * */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetDecisionDefinitionError = GetDecisionDefinitionErrors[keyof GetDecisionDefinitionErrors]; type GetDecisionDefinitionResponses = { /** * The decision definition is successfully returned. */ 200: DecisionDefinitionResult; }; type GetDecisionDefinitionResponse = GetDecisionDefinitionResponses[keyof GetDecisionDefinitionResponses]; type GetDecisionDefinitionXmlData = { body?: never; path: { /** * The assigned key of the decision definition, which acts as a unique identifier for this decision. */ decisionDefinitionKey: DecisionDefinitionKey; }; query?: never; url: '/decision-definitions/{decisionDefinitionKey}/xml'; }; type GetDecisionDefinitionXmlErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The decision definition with the given key was not found. More details are provided in the response body. * */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetDecisionDefinitionXmlError = GetDecisionDefinitionXmlErrors[keyof GetDecisionDefinitionXmlErrors]; type GetDecisionDefinitionXmlResponses = { /** * The XML of the decision definition is successfully returned. */ 200: string; }; type GetDecisionDefinitionXmlResponse = GetDecisionDefinitionXmlResponses[keyof GetDecisionDefinitionXmlResponses]; type SearchDecisionInstancesData = { body?: DecisionInstanceSearchQuery; path?: never; query?: never; url: '/decision-instances/search'; }; type SearchDecisionInstancesErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchDecisionInstancesError = SearchDecisionInstancesErrors[keyof SearchDecisionInstancesErrors]; type SearchDecisionInstancesResponses = { /** * The decision instance search result. */ 200: DecisionInstanceSearchQueryResult; }; type SearchDecisionInstancesResponse = SearchDecisionInstancesResponses[keyof SearchDecisionInstancesResponses]; type GetDecisionInstanceData = { body?: never; path: { /** * The assigned key of the decision instance, which acts as a unique identifier for this decision instance. */ decisionEvaluationInstanceKey: DecisionEvaluationInstanceKey; }; query?: never; url: '/decision-instances/{decisionEvaluationInstanceKey}'; }; type GetDecisionInstanceErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The decision instance with the given key was not found. More details are provided in the response body. * */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetDecisionInstanceError = GetDecisionInstanceErrors[keyof GetDecisionInstanceErrors]; type GetDecisionInstanceResponses = { /** * The decision instance is successfully returned. */ 200: DecisionInstanceGetQueryResult; }; type GetDecisionInstanceResponse = GetDecisionInstanceResponses[keyof GetDecisionInstanceResponses]; type DeleteDecisionInstanceData = { body?: { operationReference?: OperationReference; } | null; path: { /** * The key of the decision evaluation to delete. */ decisionEvaluationKey: DecisionEvaluationKey; }; query?: never; url: '/decision-instances/{decisionEvaluationKey}/deletion'; }; type DeleteDecisionInstanceErrors = { /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The decision instance is not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type DeleteDecisionInstanceError = DeleteDecisionInstanceErrors[keyof DeleteDecisionInstanceErrors]; type DeleteDecisionInstanceResponses = { /** * The decision instance is marked for deletion. */ 204: void; }; type DeleteDecisionInstanceResponse = DeleteDecisionInstanceResponses[keyof DeleteDecisionInstanceResponses]; type DeleteDecisionInstancesBatchOperationData = { body: DecisionInstanceDeletionBatchOperationRequest; path?: never; query?: never; url: '/decision-instances/deletion'; }; type DeleteDecisionInstancesBatchOperationErrors = { /** * The decision instance batch operation failed. More details are provided in the response body. * */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type DeleteDecisionInstancesBatchOperationError = DeleteDecisionInstancesBatchOperationErrors[keyof DeleteDecisionInstancesBatchOperationErrors]; type DeleteDecisionInstancesBatchOperationResponses = { /** * The batch operation request was created. */ 200: BatchOperationCreatedResult; }; type DeleteDecisionInstancesBatchOperationResponse = DeleteDecisionInstancesBatchOperationResponses[keyof DeleteDecisionInstancesBatchOperationResponses]; type SearchDecisionRequirementsData = { body?: DecisionRequirementsSearchQuery; path?: never; query?: never; url: '/decision-requirements/search'; }; type SearchDecisionRequirementsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchDecisionRequirementsError = SearchDecisionRequirementsErrors[keyof SearchDecisionRequirementsErrors]; type SearchDecisionRequirementsResponses = { /** * The decision requirements search result. */ 200: DecisionRequirementsSearchQueryResult; }; type SearchDecisionRequirementsResponse = SearchDecisionRequirementsResponses[keyof SearchDecisionRequirementsResponses]; type GetDecisionRequirementsData = { body?: never; path: { /** * The assigned key of the decision requirements, which acts as a unique identifier for this decision requirements. */ decisionRequirementsKey: DecisionRequirementsKey; }; query?: never; url: '/decision-requirements/{decisionRequirementsKey}'; }; type GetDecisionRequirementsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The decision requirements with the given key was not found. More details are provided in the response body. * */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetDecisionRequirementsError = GetDecisionRequirementsErrors[keyof GetDecisionRequirementsErrors]; type GetDecisionRequirementsResponses = { /** * The decision requirements is successfully returned. */ 200: DecisionRequirementsResult; }; type GetDecisionRequirementsResponse = GetDecisionRequirementsResponses[keyof GetDecisionRequirementsResponses]; type GetDecisionRequirementsXmlData = { body?: never; path: { /** * The assigned key of the decision requirements, which acts as a unique identifier for this decision. */ decisionRequirementsKey: DecisionRequirementsKey; }; query?: never; url: '/decision-requirements/{decisionRequirementsKey}/xml'; }; type GetDecisionRequirementsXmlErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The decision requirements with the given key was not found. More details are provided in the response body. * */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetDecisionRequirementsXmlError = GetDecisionRequirementsXmlErrors[keyof GetDecisionRequirementsXmlErrors]; type GetDecisionRequirementsXmlResponses = { /** * The XML of the decision requirements is successfully returned. */ 200: string; }; type GetDecisionRequirementsXmlResponse = GetDecisionRequirementsXmlResponses[keyof GetDecisionRequirementsXmlResponses]; type CreateDeploymentData = { body: { /** * The binary data to create the deployment resources. It is possible to have more than one form part with different form part names for the binary data to create a deployment. * */ resources: Array; tenantId?: TenantId; }; path?: never; query?: never; url: '/deployments'; }; type CreateDeploymentErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type CreateDeploymentError = CreateDeploymentErrors[keyof CreateDeploymentErrors]; type CreateDeploymentResponses = { /** * The resources are deployed. */ 200: DeploymentResult; }; type CreateDeploymentResponse = CreateDeploymentResponses[keyof CreateDeploymentResponses]; type CreateDocumentData = { body: { file: Blob | File; metadata?: DocumentMetadata; }; path?: never; query?: { /** * The ID of the document store to upload the documents to. Currently, only a single document store is supported per cluster. However, this attribute is included to allow for potential future support of multiple document stores. */ storeId?: string; /** * The ID of the document to upload. If not provided, a new ID will be generated. Specifying an existing ID will result in an error if the document already exists. * */ documentId?: DocumentId; }; url: '/documents'; }; type CreateDocumentErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The server cannot process the request because the media type (Content-Type) of the request payload is not supported * by the server for the requested resource and method. * */ 415: ProblemDetail; }; type CreateDocumentError = CreateDocumentErrors[keyof CreateDocumentErrors]; type CreateDocumentResponses = { /** * The document was uploaded successfully. */ 201: DocumentReference; }; type CreateDocumentResponse = CreateDocumentResponses[keyof CreateDocumentResponses]; type CreateDocumentsData = { body: { /** * The documents to upload. */ files: Array; /** * Optional JSON array of metadata object whose index aligns with each file entry. The metadata array must have the same length as the files array. * */ metadataList?: Array; }; path?: never; query?: { /** * The ID of the document store to upload the documents to. Currently, only a single document store is supported per cluster. However, this attribute is included to allow for potential future support of multiple document stores. */ storeId?: string; }; url: '/documents/batch'; }; type CreateDocumentsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The server cannot process the request because the media type (Content-Type) of the request payload is not supported * by the server for the requested resource and method. * */ 415: ProblemDetail; }; type CreateDocumentsError = CreateDocumentsErrors[keyof CreateDocumentsErrors]; type CreateDocumentsResponses = { /** * All documents were uploaded successfully. */ 201: DocumentCreationBatchResponse; /** * Some documents were uploaded successfully, others failed. */ 207: DocumentCreationBatchResponse; }; type CreateDocumentsResponse = CreateDocumentsResponses[keyof CreateDocumentsResponses]; type DeleteDocumentData = { body?: never; path: { /** * The ID of the document to delete. */ documentId: DocumentId; }; query?: { /** * The ID of the document store to delete the document from. */ storeId?: string; }; url: '/documents/{documentId}'; }; type DeleteDocumentErrors = { /** * The document with the given ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type DeleteDocumentError = DeleteDocumentErrors[keyof DeleteDocumentErrors]; type DeleteDocumentResponses = { /** * The document was deleted successfully. */ 204: void; }; type DeleteDocumentResponse = DeleteDocumentResponses[keyof DeleteDocumentResponses]; type GetDocumentData = { body?: never; path: { /** * The ID of the document to download. */ documentId: DocumentId; }; query?: { /** * The ID of the document store to download the document from. */ storeId?: string; /** * The hash of the document content that was computed by the document store during upload. The hash is part of the document reference that is returned when uploading a document. If the client fails to provide the correct hash, the request will be rejected. * */ contentHash?: string; }; url: '/documents/{documentId}'; }; type GetDocumentErrors = { /** * The document with the given ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetDocumentError = GetDocumentErrors[keyof GetDocumentErrors]; type GetDocumentResponses = { /** * The document was downloaded successfully. */ 200: Blob | File; }; type GetDocumentResponse = GetDocumentResponses[keyof GetDocumentResponses]; type CreateDocumentLinkData = { body?: DocumentLinkRequest; path: { /** * The ID of the document to link. */ documentId: DocumentId; }; query?: { /** * The ID of the document store where the document is located. */ storeId?: string; /** * The hash of the document content that was computed by the document store during upload. The hash is part of the document reference that is returned when uploading a document. If the client fails to provide the correct hash, the request will be rejected. * */ contentHash?: string; }; url: '/documents/{documentId}/links'; }; type CreateDocumentLinkErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; }; type CreateDocumentLinkError = CreateDocumentLinkErrors[keyof CreateDocumentLinkErrors]; type CreateDocumentLinkResponses = { /** * The document link was created successfully. */ 201: DocumentLink; }; type CreateDocumentLinkResponse = CreateDocumentLinkResponses[keyof CreateDocumentLinkResponses]; type ActivateAdHocSubProcessActivitiesData = { body: AdHocSubProcessActivateActivitiesInstruction; path: { /** * The key of the ad-hoc sub-process instance that contains the activities. */ adHocSubProcessInstanceKey: ElementInstanceKey; }; query?: never; url: '/element-instances/ad-hoc-activities/{adHocSubProcessInstanceKey}/activation'; }; type ActivateAdHocSubProcessActivitiesErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The ad-hoc sub-process instance is not found or the provided key does not identify an ad-hoc sub-process. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type ActivateAdHocSubProcessActivitiesError = ActivateAdHocSubProcessActivitiesErrors[keyof ActivateAdHocSubProcessActivitiesErrors]; type ActivateAdHocSubProcessActivitiesResponses = { /** * The ad-hoc sub-process instance is modified. */ 204: void; }; type ActivateAdHocSubProcessActivitiesResponse = ActivateAdHocSubProcessActivitiesResponses[keyof ActivateAdHocSubProcessActivitiesResponses]; type SearchElementInstancesData = { body?: ElementInstanceSearchQuery; path?: never; query?: never; url: '/element-instances/search'; }; type SearchElementInstancesErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchElementInstancesError = SearchElementInstancesErrors[keyof SearchElementInstancesErrors]; type SearchElementInstancesResponses = { /** * The element instance search result. */ 200: ElementInstanceSearchQueryResult; }; type SearchElementInstancesResponse = SearchElementInstancesResponses[keyof SearchElementInstancesResponses]; type GetElementInstanceData = { body?: never; path: { /** * The assigned key of the element instance, which acts as a unique identifier for this element instance. */ elementInstanceKey: ElementInstanceKey; }; query?: never; url: '/element-instances/{elementInstanceKey}'; }; type GetElementInstanceErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The element instance with the given key was not found. * More details are provided in the response body. * */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetElementInstanceError = GetElementInstanceErrors[keyof GetElementInstanceErrors]; type GetElementInstanceResponses = { /** * The element instance is successfully returned. */ 200: ElementInstanceResult; }; type GetElementInstanceResponse = GetElementInstanceResponses[keyof GetElementInstanceResponses]; type SearchElementInstanceIncidentsData = { body: IncidentSearchQuery; path: { /** * The unique key of the element instance to search incidents for. */ elementInstanceKey: ElementInstanceKey; }; query?: never; url: '/element-instances/{elementInstanceKey}/incidents/search'; }; type SearchElementInstanceIncidentsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The element instance with the given key was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchElementInstanceIncidentsError = SearchElementInstanceIncidentsErrors[keyof SearchElementInstanceIncidentsErrors]; type SearchElementInstanceIncidentsResponses = { /** * The element instance incident search result. */ 200: IncidentSearchQueryResult; }; type SearchElementInstanceIncidentsResponse = SearchElementInstanceIncidentsResponses[keyof SearchElementInstanceIncidentsResponses]; type CreateElementInstanceVariablesData = { body: SetVariableRequest; path: { /** * The key of the element instance to update the variables for. * This can be the process instance key (as obtained during instance creation), or a given * element, such as a service task (see the `elementInstanceKey` on the job message). * */ elementInstanceKey: ElementInstanceKey; }; query?: never; url: '/element-instances/{elementInstanceKey}/variables'; }; type CreateElementInstanceVariablesErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; /** * The request timed out between the gateway and the broker. For these endpoints, this often happens when user task listeners are configured and the corresponding listener job is not completed within the request timeout. Common causes include no available job workers for the listener type, busy or crashed job workers, or delayed job completion. As with any gateway timeout, general timeout causes (for example transient network issues) can also result in a 504 response. * Troubleshooting: - verify that job workers for the listener type are running and healthy - check worker logs for crashes, retries, and completion failures - check network connectivity between workers, gateway, and broker - retry with backoff after transient failures - fail without retries if a problem persists * */ 504: ProblemDetail; }; type CreateElementInstanceVariablesError = CreateElementInstanceVariablesErrors[keyof CreateElementInstanceVariablesErrors]; type CreateElementInstanceVariablesResponses = { /** * The variables were updated. */ 204: void; }; type CreateElementInstanceVariablesResponse = CreateElementInstanceVariablesResponses[keyof CreateElementInstanceVariablesResponses]; type EvaluateExpressionData = { body: ExpressionEvaluationRequest; path?: never; query?: never; url: '/expression/evaluation'; }; type EvaluateExpressionErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type EvaluateExpressionError = EvaluateExpressionErrors[keyof EvaluateExpressionErrors]; type EvaluateExpressionResponses = { /** * Expression evaluated successfully */ 200: ExpressionEvaluationResult; }; type EvaluateExpressionResponse = EvaluateExpressionResponses[keyof EvaluateExpressionResponses]; type CreateGlobalTaskListenerData = { body: CreateGlobalTaskListenerRequest; path?: never; query?: never; url: '/global-task-listeners'; }; type CreateGlobalTaskListenerErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * A global listener with this id already exists. */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type CreateGlobalTaskListenerError = CreateGlobalTaskListenerErrors[keyof CreateGlobalTaskListenerErrors]; type CreateGlobalTaskListenerResponses = { /** * The global user task listener was created successfully. */ 201: GlobalTaskListenerResult; }; type CreateGlobalTaskListenerResponse = CreateGlobalTaskListenerResponses[keyof CreateGlobalTaskListenerResponses]; type DeleteGlobalTaskListenerData = { body?: never; path: { /** * The id of the global user task listener to delete. */ id: GlobalListenerId; }; query?: never; url: '/global-task-listeners/{id}'; }; type DeleteGlobalTaskListenerErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The global user task listener was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type DeleteGlobalTaskListenerError = DeleteGlobalTaskListenerErrors[keyof DeleteGlobalTaskListenerErrors]; type DeleteGlobalTaskListenerResponses = { /** * The global listener was deleted successfully. */ 204: void; }; type DeleteGlobalTaskListenerResponse = DeleteGlobalTaskListenerResponses[keyof DeleteGlobalTaskListenerResponses]; type GetGlobalTaskListenerData = { body?: never; path: { /** * The id of the global user task listener. */ id: GlobalListenerId; }; query?: never; url: '/global-task-listeners/{id}'; }; type GetGlobalTaskListenerErrors = { /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The global user task listener with the given id was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetGlobalTaskListenerError = GetGlobalTaskListenerErrors[keyof GetGlobalTaskListenerErrors]; type GetGlobalTaskListenerResponses = { /** * The global user task listener is successfully returned. */ 200: GlobalTaskListenerResult; }; type GetGlobalTaskListenerResponse = GetGlobalTaskListenerResponses[keyof GetGlobalTaskListenerResponses]; type UpdateGlobalTaskListenerData = { body: UpdateGlobalTaskListenerRequest; path: { /** * The id of the global user task listener to update. */ id: GlobalListenerId; }; query?: never; url: '/global-task-listeners/{id}'; }; type UpdateGlobalTaskListenerErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The global user task listener was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UpdateGlobalTaskListenerError = UpdateGlobalTaskListenerErrors[keyof UpdateGlobalTaskListenerErrors]; type UpdateGlobalTaskListenerResponses = { /** * The global listener was updated successfully. */ 200: GlobalTaskListenerResult; }; type UpdateGlobalTaskListenerResponse = UpdateGlobalTaskListenerResponses[keyof UpdateGlobalTaskListenerResponses]; type SearchGlobalTaskListenersData = { body?: GlobalTaskListenerSearchQueryRequest; path?: never; query?: never; url: '/global-task-listeners/search'; }; type SearchGlobalTaskListenersErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchGlobalTaskListenersError = SearchGlobalTaskListenersErrors[keyof SearchGlobalTaskListenersErrors]; type SearchGlobalTaskListenersResponses = { /** * The global user task listener search result. */ 200: GlobalTaskListenerSearchQueryResult; }; type SearchGlobalTaskListenersResponse = SearchGlobalTaskListenersResponses[keyof SearchGlobalTaskListenersResponses]; type CreateGroupData = { body?: GroupCreateRequest; path?: never; query?: never; url: '/groups'; }; type CreateGroupErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type CreateGroupError = CreateGroupErrors[keyof CreateGroupErrors]; type CreateGroupResponses = { /** * The group was created successfully. */ 201: GroupCreateResult; }; type CreateGroupResponse = CreateGroupResponses[keyof CreateGroupResponses]; type SearchGroupsData = { body?: GroupSearchQueryRequest; path?: never; query?: never; url: '/groups/search'; }; type SearchGroupsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchGroupsError = SearchGroupsErrors[keyof SearchGroupsErrors]; type SearchGroupsResponses = { /** * The groups search result. */ 200: GroupSearchQueryResult; }; type SearchGroupsResponse = SearchGroupsResponses[keyof SearchGroupsResponses]; type DeleteGroupData = { body?: never; path: { /** * The group ID. */ groupId: string; }; query?: never; url: '/groups/{groupId}'; }; type DeleteGroupErrors = { /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * The group with the given ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type DeleteGroupError = DeleteGroupErrors[keyof DeleteGroupErrors]; type DeleteGroupResponses = { /** * The group was deleted successfully. */ 204: void; }; type DeleteGroupResponse = DeleteGroupResponses[keyof DeleteGroupResponses]; type GetGroupData = { body?: never; path: { /** * The group ID. */ groupId: string; }; query?: never; url: '/groups/{groupId}'; }; type GetGroupErrors = { /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The group with the given ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetGroupError = GetGroupErrors[keyof GetGroupErrors]; type GetGroupResponses = { /** * The group is successfully returned. */ 200: GroupResult; }; type GetGroupResponse = GetGroupResponses[keyof GetGroupResponses]; type UpdateGroupData = { body: GroupUpdateRequest; path: { /** * The group ID. */ groupId: string; }; query?: never; url: '/groups/{groupId}'; }; type UpdateGroupErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * The group with the given ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UpdateGroupError = UpdateGroupErrors[keyof UpdateGroupErrors]; type UpdateGroupResponses = { /** * The group was updated successfully. */ 200: GroupUpdateResult; }; type UpdateGroupResponse = UpdateGroupResponses[keyof UpdateGroupResponses]; type SearchClientsForGroupData = { body?: SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array<{ /** * The field to sort by. */ field: 'clientId'; order?: SortOrderEnum; }>; }; path: { /** * The group ID. */ groupId: string; }; query?: never; url: '/groups/{groupId}/clients/search'; }; type SearchClientsForGroupErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The group with the given ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchClientsForGroupError = SearchClientsForGroupErrors[keyof SearchClientsForGroupErrors]; type SearchClientsForGroupResponses = { /** * The clients assigned to the group. */ 200: SearchQueryResponse & { /** * The matching client IDs. */ items: Array<{ /** * The ID of the client. */ clientId: string; }>; }; }; type SearchClientsForGroupResponse = SearchClientsForGroupResponses[keyof SearchClientsForGroupResponses]; type UnassignClientFromGroupData = { body?: never; path: { /** * The group ID. */ groupId: string; /** * The client ID. */ clientId: string; }; query?: never; url: '/groups/{groupId}/clients/{clientId}'; }; type UnassignClientFromGroupErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The group with the given ID was not found, or the client is not assigned to this group. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UnassignClientFromGroupError = UnassignClientFromGroupErrors[keyof UnassignClientFromGroupErrors]; type UnassignClientFromGroupResponses = { /** * The client was unassigned successfully from the group. */ 204: void; }; type UnassignClientFromGroupResponse = UnassignClientFromGroupResponses[keyof UnassignClientFromGroupResponses]; type AssignClientToGroupData = { body?: never; path: { /** * The group ID. */ groupId: string; /** * The client ID. */ clientId: string; }; query?: never; url: '/groups/{groupId}/clients/{clientId}'; }; type AssignClientToGroupErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The group with the given ID was not found. */ 404: ProblemDetail; /** * The client with the given ID is already assigned to the group. */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type AssignClientToGroupError = AssignClientToGroupErrors[keyof AssignClientToGroupErrors]; type AssignClientToGroupResponses = { /** * The client was assigned successfully to the group. */ 204: void; }; type AssignClientToGroupResponse = AssignClientToGroupResponses[keyof AssignClientToGroupResponses]; type SearchMappingRulesForGroupData = { body?: MappingRuleSearchQueryRequest; path: { /** * The group ID. */ groupId: string; }; query?: never; url: '/groups/{groupId}/mapping-rules/search'; }; type SearchMappingRulesForGroupErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The group with the given ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchMappingRulesForGroupError = SearchMappingRulesForGroupErrors[keyof SearchMappingRulesForGroupErrors]; type SearchMappingRulesForGroupResponses = { /** * The mapping rules assigned to the group. */ 200: SearchQueryResponse & { /** * The matching mapping rules. */ items: Array; }; }; type SearchMappingRulesForGroupResponse = SearchMappingRulesForGroupResponses[keyof SearchMappingRulesForGroupResponses]; type UnassignMappingRuleFromGroupData = { body?: never; path: { /** * The group ID. */ groupId: string; /** * The mapping rule ID. */ mappingRuleId: string; }; query?: never; url: '/groups/{groupId}/mapping-rules/{mappingRuleId}'; }; type UnassignMappingRuleFromGroupErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The group or mapping rule with the given ID was not found, or the mapping rule is not assigned to this group. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UnassignMappingRuleFromGroupError = UnassignMappingRuleFromGroupErrors[keyof UnassignMappingRuleFromGroupErrors]; type UnassignMappingRuleFromGroupResponses = { /** * The mapping rule was unassigned successfully from the group. */ 204: void; }; type UnassignMappingRuleFromGroupResponse = UnassignMappingRuleFromGroupResponses[keyof UnassignMappingRuleFromGroupResponses]; type AssignMappingRuleToGroupData = { body?: never; path: { /** * The group ID. */ groupId: string; /** * The mapping rule ID. */ mappingRuleId: string; }; query?: never; url: '/groups/{groupId}/mapping-rules/{mappingRuleId}'; }; type AssignMappingRuleToGroupErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The group or mapping rule with the given ID was not found. */ 404: ProblemDetail; /** * The mapping rule with the given ID is already assigned to the group. */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type AssignMappingRuleToGroupError = AssignMappingRuleToGroupErrors[keyof AssignMappingRuleToGroupErrors]; type AssignMappingRuleToGroupResponses = { /** * The mapping rule was assigned successfully to the group. */ 204: void; }; type AssignMappingRuleToGroupResponse = AssignMappingRuleToGroupResponses[keyof AssignMappingRuleToGroupResponses]; type SearchRolesForGroupData = { body?: RoleSearchQueryRequest; path: { /** * The group ID. */ groupId: string; }; query?: never; url: '/groups/{groupId}/roles/search'; }; type SearchRolesForGroupErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The group with the given ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchRolesForGroupError = SearchRolesForGroupErrors[keyof SearchRolesForGroupErrors]; type SearchRolesForGroupResponses = { /** * The roles assigned to the group. */ 200: SearchQueryResponse & { /** * The matching roles. */ items: Array; }; }; type SearchRolesForGroupResponse = SearchRolesForGroupResponses[keyof SearchRolesForGroupResponses]; type SearchUsersForGroupData = { body?: SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array<{ /** * The field to sort by. */ field: 'username'; order?: SortOrderEnum; }>; }; path: { /** * The group ID. */ groupId: string; }; query?: never; url: '/groups/{groupId}/users/search'; }; type SearchUsersForGroupErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The group with the given ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchUsersForGroupError = SearchUsersForGroupErrors[keyof SearchUsersForGroupErrors]; type SearchUsersForGroupResponses = { /** * The users assigned to the group. */ 200: SearchQueryResponse & { /** * The matching members. */ items: Array<{ username: Username; }>; }; }; type SearchUsersForGroupResponse = SearchUsersForGroupResponses[keyof SearchUsersForGroupResponses]; type UnassignUserFromGroupData = { body?: never; path: { /** * The group ID. */ groupId: string; /** * The user username. */ username: Username; }; query?: never; url: '/groups/{groupId}/users/{username}'; }; type UnassignUserFromGroupErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The group or user with the given ID was not found, or the user is not assigned to this group. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UnassignUserFromGroupError = UnassignUserFromGroupErrors[keyof UnassignUserFromGroupErrors]; type UnassignUserFromGroupResponses = { /** * The user was unassigned successfully from the group. */ 204: void; }; type UnassignUserFromGroupResponse = UnassignUserFromGroupResponses[keyof UnassignUserFromGroupResponses]; type AssignUserToGroupData = { body?: never; path: { /** * The group ID. */ groupId: string; /** * The user username. */ username: Username; }; query?: never; url: '/groups/{groupId}/users/{username}'; }; type AssignUserToGroupErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The group or user with the given ID or username was not found. */ 404: ProblemDetail; /** * The user with the given ID is already assigned to the group. */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type AssignUserToGroupError = AssignUserToGroupErrors[keyof AssignUserToGroupErrors]; type AssignUserToGroupResponses = { /** * The user was assigned successfully to the group. */ 204: void; }; type AssignUserToGroupResponse = AssignUserToGroupResponses[keyof AssignUserToGroupResponses]; type SearchIncidentsData = { body?: IncidentSearchQuery; path?: never; query?: never; url: '/incidents/search'; }; type SearchIncidentsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchIncidentsError = SearchIncidentsErrors[keyof SearchIncidentsErrors]; type SearchIncidentsResponses = { /** * The incident search result. */ 200: IncidentSearchQueryResult; }; type SearchIncidentsResponse = SearchIncidentsResponses[keyof SearchIncidentsResponses]; type GetIncidentData = { body?: never; path: { /** * The assigned key of the incident, which acts as a unique identifier for this incident. */ incidentKey: IncidentKey; }; query?: never; url: '/incidents/{incidentKey}'; }; type GetIncidentErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The incident with the given key was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetIncidentError = GetIncidentErrors[keyof GetIncidentErrors]; type GetIncidentResponses = { /** * The incident is successfully returned. */ 200: IncidentResult; }; type GetIncidentResponse = GetIncidentResponses[keyof GetIncidentResponses]; type ResolveIncidentData = { body?: IncidentResolutionRequest; path: { /** * Key of the incident to resolve. */ incidentKey: IncidentKey; }; query?: never; url: '/incidents/{incidentKey}/resolution'; }; type ResolveIncidentErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The incident with the incidentKey is not found. */ 404: ProblemDetail; /** * The incident cannot be resolved due to an invalid state. * For example, the associated job may have no retries left. * */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type ResolveIncidentError = ResolveIncidentErrors[keyof ResolveIncidentErrors]; type ResolveIncidentResponses = { /** * The incident is marked as resolved. */ 204: void; }; type ResolveIncidentResponse = ResolveIncidentResponses[keyof ResolveIncidentResponses]; type GetProcessInstanceStatisticsByDefinitionData = { body: IncidentProcessInstanceStatisticsByDefinitionQuery; path?: never; query?: never; url: '/incidents/statistics/process-instances-by-definition'; }; type GetProcessInstanceStatisticsByDefinitionErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetProcessInstanceStatisticsByDefinitionError = GetProcessInstanceStatisticsByDefinitionErrors[keyof GetProcessInstanceStatisticsByDefinitionErrors]; type GetProcessInstanceStatisticsByDefinitionResponses = { /** * The process instance incident statistics grouped by process definition are successfully * returned. * */ 200: IncidentProcessInstanceStatisticsByDefinitionQueryResult; }; type GetProcessInstanceStatisticsByDefinitionResponse = GetProcessInstanceStatisticsByDefinitionResponses[keyof GetProcessInstanceStatisticsByDefinitionResponses]; type GetProcessInstanceStatisticsByErrorData = { body?: IncidentProcessInstanceStatisticsByErrorQuery; path?: never; query?: never; url: '/incidents/statistics/process-instances-by-error'; }; type GetProcessInstanceStatisticsByErrorErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetProcessInstanceStatisticsByErrorError = GetProcessInstanceStatisticsByErrorErrors[keyof GetProcessInstanceStatisticsByErrorErrors]; type GetProcessInstanceStatisticsByErrorResponses = { /** * The statistics about process instances with incident, grouped by error hash code are * successfully returned. * */ 200: IncidentProcessInstanceStatisticsByErrorQueryResult; }; type GetProcessInstanceStatisticsByErrorResponse = GetProcessInstanceStatisticsByErrorResponses[keyof GetProcessInstanceStatisticsByErrorResponses]; type ActivateJobsData = { body: JobActivationRequest; path?: never; query?: never; url: '/jobs/activation'; }; type ActivateJobsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type ActivateJobsError = ActivateJobsErrors[keyof ActivateJobsErrors]; type ActivateJobsResponses = { /** * The list of activated jobs. */ 200: JobActivationResult; }; type ActivateJobsResponse = ActivateJobsResponses[keyof ActivateJobsResponses]; type SearchJobsData = { body?: JobSearchQuery; path?: never; query?: never; url: '/jobs/search'; }; type SearchJobsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchJobsError = SearchJobsErrors[keyof SearchJobsErrors]; type SearchJobsResponses = { /** * The job search result. */ 200: JobSearchQueryResult; }; type SearchJobsResponse = SearchJobsResponses[keyof SearchJobsResponses]; type UpdateJobData = { body: JobUpdateRequest; path: { /** * The key of the job to update. */ jobKey: JobKey; }; query?: never; url: '/jobs/{jobKey}'; }; type UpdateJobErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The job with the jobKey is not found. */ 404: ProblemDetail; /** * The job with the given key is in the wrong state currently. More details are provided in the response body. * */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UpdateJobError = UpdateJobErrors[keyof UpdateJobErrors]; type UpdateJobResponses = { /** * The job was updated successfully. */ 204: void; }; type UpdateJobResponse = UpdateJobResponses[keyof UpdateJobResponses]; type CompleteJobData = { body?: JobCompletionRequest; path: { /** * The key of the job to complete. */ jobKey: JobKey; }; query?: never; url: '/jobs/{jobKey}/completion'; }; type CompleteJobErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The job with the given key was not found. */ 404: ProblemDetail; /** * The job with the given key is in the wrong state currently. More details are provided in the response body. * */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type CompleteJobError = CompleteJobErrors[keyof CompleteJobErrors]; type CompleteJobResponses = { /** * The job was completed successfully. */ 204: void; }; type CompleteJobResponse = CompleteJobResponses[keyof CompleteJobResponses]; type ThrowJobErrorData = { body: JobErrorRequest$1; path: { /** * The key of the job. */ jobKey: JobKey; }; query?: never; url: '/jobs/{jobKey}/error'; }; type ThrowJobErrorErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The job with the given key was not found or is not activated. * */ 404: ProblemDetail; /** * The job with the given key is in the wrong state currently. More details are provided in the response body. * */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type ThrowJobErrorError = ThrowJobErrorErrors[keyof ThrowJobErrorErrors]; type ThrowJobErrorResponses = { /** * An error is thrown for the job. */ 204: void; }; type ThrowJobErrorResponse = ThrowJobErrorResponses[keyof ThrowJobErrorResponses]; type FailJobData = { body?: JobFailRequest; path: { /** * The key of the job to fail. */ jobKey: JobKey; }; query?: never; url: '/jobs/{jobKey}/failure'; }; type FailJobErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The job with the given jobKey is not found. It was completed by another worker, or the process instance itself was canceled. * */ 404: ProblemDetail; /** * The job with the given key is in the wrong state (i.e: not ACTIVATED or ACTIVATABLE). The job was failed by another worker with retries = 0, and the process is now in an incident state. * */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type FailJobError = FailJobErrors[keyof FailJobErrors]; type FailJobResponses = { /** * The job is failed. */ 204: void; }; type FailJobResponse = FailJobResponses[keyof FailJobResponses]; type GetGlobalJobStatisticsData = { body?: never; path?: never; query: { /** * Start of the time window to filter metrics. ISO 8601 date-time format. * */ from: string; /** * End of the time window to filter metrics. ISO 8601 date-time format. * */ to: string; /** * Optional job type to limit the aggregation to a single job type. */ jobType?: string; }; url: '/jobs/statistics/global'; }; type GetGlobalJobStatisticsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetGlobalJobStatisticsError = GetGlobalJobStatisticsErrors[keyof GetGlobalJobStatisticsErrors]; type GetGlobalJobStatisticsResponses = { /** * Global job metrics */ 200: GlobalJobStatisticsQueryResult; }; type GetGlobalJobStatisticsResponse = GetGlobalJobStatisticsResponses[keyof GetGlobalJobStatisticsResponses]; type GetJobTypeStatisticsData = { body: JobTypeStatisticsQuery; path?: never; query?: never; url: '/jobs/statistics/by-types'; }; type GetJobTypeStatisticsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetJobTypeStatisticsError = GetJobTypeStatisticsErrors[keyof GetJobTypeStatisticsErrors]; type GetJobTypeStatisticsResponses = { /** * The job type statistics result. */ 200: JobTypeStatisticsQueryResult; }; type GetJobTypeStatisticsResponse = GetJobTypeStatisticsResponses[keyof GetJobTypeStatisticsResponses]; type GetJobWorkerStatisticsData = { body: JobWorkerStatisticsQuery; path?: never; query?: never; url: '/jobs/statistics/by-workers'; }; type GetJobWorkerStatisticsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetJobWorkerStatisticsError = GetJobWorkerStatisticsErrors[keyof GetJobWorkerStatisticsErrors]; type GetJobWorkerStatisticsResponses = { /** * The job worker statistics result. */ 200: JobWorkerStatisticsQueryResult; }; type GetJobWorkerStatisticsResponse = GetJobWorkerStatisticsResponses[keyof GetJobWorkerStatisticsResponses]; type GetJobTimeSeriesStatisticsData = { body: JobTimeSeriesStatisticsQuery; path?: never; query?: never; url: '/jobs/statistics/time-series'; }; type GetJobTimeSeriesStatisticsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetJobTimeSeriesStatisticsError = GetJobTimeSeriesStatisticsErrors[keyof GetJobTimeSeriesStatisticsErrors]; type GetJobTimeSeriesStatisticsResponses = { /** * The job time-series statistics result. */ 200: JobTimeSeriesStatisticsQueryResult; }; type GetJobTimeSeriesStatisticsResponse = GetJobTimeSeriesStatisticsResponses[keyof GetJobTimeSeriesStatisticsResponses]; type GetJobErrorStatisticsData = { body: JobErrorStatisticsQuery; path?: never; query?: never; url: '/jobs/statistics/errors'; }; type GetJobErrorStatisticsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetJobErrorStatisticsError = GetJobErrorStatisticsErrors[keyof GetJobErrorStatisticsErrors]; type GetJobErrorStatisticsResponses = { /** * The job error statistics result. */ 200: JobErrorStatisticsQueryResult; }; type GetJobErrorStatisticsResponse = GetJobErrorStatisticsResponses[keyof GetJobErrorStatisticsResponses]; type GetLicenseData = { body?: never; path?: never; query?: never; url: '/license'; }; type GetLicenseErrors = { /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetLicenseError = GetLicenseErrors[keyof GetLicenseErrors]; type GetLicenseResponses = { /** * Obtains the current status of the Camunda license. */ 200: LicenseResponse; }; type GetLicenseResponse = GetLicenseResponses[keyof GetLicenseResponses]; type CreateMappingRuleData = { body?: MappingRuleCreateRequest; path?: never; query?: never; url: '/mapping-rules'; }; type CreateMappingRuleErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request to create a mapping rule was denied. * More details are provided in the response body. * */ 403: ProblemDetail; /** * The request to create a mapping rule was denied. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type CreateMappingRuleError = CreateMappingRuleErrors[keyof CreateMappingRuleErrors]; type CreateMappingRuleResponses = { /** * The mapping rule was created successfully. */ 201: MappingRuleCreateUpdateResult; }; type CreateMappingRuleResponse = CreateMappingRuleResponses[keyof CreateMappingRuleResponses]; type SearchMappingRuleData = { body?: MappingRuleSearchQueryRequest; path?: never; query?: never; url: '/mapping-rules/search'; }; type SearchMappingRuleErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchMappingRuleError = SearchMappingRuleErrors[keyof SearchMappingRuleErrors]; type SearchMappingRuleResponses = { /** * The mapping rule search result. */ 200: SearchQueryResponse & { /** * The matching mapping rules. */ items: Array; }; }; type SearchMappingRuleResponse = SearchMappingRuleResponses[keyof SearchMappingRuleResponses]; type DeleteMappingRuleData = { body?: never; path: { /** * The ID of the mapping rule to delete. */ mappingRuleId: string; }; query?: never; url: '/mapping-rules/{mappingRuleId}'; }; type DeleteMappingRuleErrors = { /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * The mapping rule with the mappingRuleId was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type DeleteMappingRuleError = DeleteMappingRuleErrors[keyof DeleteMappingRuleErrors]; type DeleteMappingRuleResponses = { /** * The mapping rule was deleted successfully. */ 204: void; }; type DeleteMappingRuleResponse = DeleteMappingRuleResponses[keyof DeleteMappingRuleResponses]; type GetMappingRuleData = { body?: never; path: { /** * The ID of the mapping rule to get. */ mappingRuleId: string; }; query?: never; url: '/mapping-rules/{mappingRuleId}'; }; type GetMappingRuleErrors = { /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * The mapping rule with the mappingRuleId was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetMappingRuleError = GetMappingRuleErrors[keyof GetMappingRuleErrors]; type GetMappingRuleResponses = { /** * The mapping rule was returned successfully. */ 200: MappingRuleResult; }; type GetMappingRuleResponse = GetMappingRuleResponses[keyof GetMappingRuleResponses]; type UpdateMappingRuleData = { body?: MappingRuleUpdateRequest; path: { /** * The ID of the mapping rule to update. */ mappingRuleId: string; }; query?: never; url: '/mapping-rules/{mappingRuleId}'; }; type UpdateMappingRuleErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request to update a mapping rule was denied. * More details are provided in the response body. * */ 403: ProblemDetail; /** * The request to update a mapping rule was denied. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UpdateMappingRuleError = UpdateMappingRuleErrors[keyof UpdateMappingRuleErrors]; type UpdateMappingRuleResponses = { /** * The mapping rule was updated successfully. */ 200: MappingRuleCreateUpdateResult; }; type UpdateMappingRuleResponse = UpdateMappingRuleResponses[keyof UpdateMappingRuleResponses]; type SearchMessageSubscriptionsData = { body?: MessageSubscriptionSearchQuery; path?: never; query?: never; url: '/message-subscriptions/search'; }; type SearchMessageSubscriptionsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchMessageSubscriptionsError = SearchMessageSubscriptionsErrors[keyof SearchMessageSubscriptionsErrors]; type SearchMessageSubscriptionsResponses = { /** * The message subscription search result. */ 200: MessageSubscriptionSearchQueryResult; }; type SearchMessageSubscriptionsResponse = SearchMessageSubscriptionsResponses[keyof SearchMessageSubscriptionsResponses]; type CorrelateMessageData = { body: MessageCorrelationRequest; path?: never; query?: never; url: '/messages/correlation'; }; type CorrelateMessageErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type CorrelateMessageError = CorrelateMessageErrors[keyof CorrelateMessageErrors]; type CorrelateMessageResponses = { /** * The message is correlated to one or more process instances */ 200: MessageCorrelationResult; }; type CorrelateMessageResponse = CorrelateMessageResponses[keyof CorrelateMessageResponses]; type PublishMessageData = { body: MessagePublicationRequest; path?: never; query?: never; url: '/messages/publication'; }; type PublishMessageErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type PublishMessageError = PublishMessageErrors[keyof PublishMessageErrors]; type PublishMessageResponses = { /** * The message was published. */ 200: MessagePublicationResult; }; type PublishMessageResponse = PublishMessageResponses[keyof PublishMessageResponses]; type SearchProcessDefinitionsData = { body?: ProcessDefinitionSearchQuery; path?: never; query?: never; url: '/process-definitions/search'; }; type SearchProcessDefinitionsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchProcessDefinitionsError = SearchProcessDefinitionsErrors[keyof SearchProcessDefinitionsErrors]; type SearchProcessDefinitionsResponses = { /** * The process definition search result. */ 200: ProcessDefinitionSearchQueryResult; }; type SearchProcessDefinitionsResponse = SearchProcessDefinitionsResponses[keyof SearchProcessDefinitionsResponses]; type GetProcessDefinitionMessageSubscriptionStatisticsData = { body?: ProcessDefinitionMessageSubscriptionStatisticsQuery; path?: never; query?: never; url: '/process-definitions/statistics/message-subscriptions'; }; type GetProcessDefinitionMessageSubscriptionStatisticsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetProcessDefinitionMessageSubscriptionStatisticsError = GetProcessDefinitionMessageSubscriptionStatisticsErrors[keyof GetProcessDefinitionMessageSubscriptionStatisticsErrors]; type GetProcessDefinitionMessageSubscriptionStatisticsResponses = { /** * The process definition message subscription statistics result. */ 200: ProcessDefinitionMessageSubscriptionStatisticsQueryResult; }; type GetProcessDefinitionMessageSubscriptionStatisticsResponse = GetProcessDefinitionMessageSubscriptionStatisticsResponses[keyof GetProcessDefinitionMessageSubscriptionStatisticsResponses]; type GetProcessDefinitionInstanceStatisticsData = { body?: ProcessDefinitionInstanceStatisticsQuery; path?: never; query?: never; url: '/process-definitions/statistics/process-instances'; }; type GetProcessDefinitionInstanceStatisticsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetProcessDefinitionInstanceStatisticsError = GetProcessDefinitionInstanceStatisticsErrors[keyof GetProcessDefinitionInstanceStatisticsErrors]; type GetProcessDefinitionInstanceStatisticsResponses = { /** * The process definition instance statistic result. */ 200: ProcessDefinitionInstanceStatisticsQueryResult; }; type GetProcessDefinitionInstanceStatisticsResponse = GetProcessDefinitionInstanceStatisticsResponses[keyof GetProcessDefinitionInstanceStatisticsResponses]; type GetProcessDefinitionData = { body?: never; path: { /** * The assigned key of the process definition, which acts as a unique identifier for this process definition. * */ processDefinitionKey: ProcessDefinitionKey; }; query?: never; url: '/process-definitions/{processDefinitionKey}'; }; type GetProcessDefinitionErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The process definition with the given key was not found. More details are provided in the response body. * */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetProcessDefinitionError = GetProcessDefinitionErrors[keyof GetProcessDefinitionErrors]; type GetProcessDefinitionResponses = { /** * The process definition is successfully returned. */ 200: ProcessDefinitionResult; }; type GetProcessDefinitionResponse = GetProcessDefinitionResponses[keyof GetProcessDefinitionResponses]; type GetStartProcessFormData = { body?: never; path: { /** * The process key. */ processDefinitionKey: ProcessDefinitionKey; }; query?: never; url: '/process-definitions/{processDefinitionKey}/form'; }; type GetStartProcessFormErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetStartProcessFormError = GetStartProcessFormErrors[keyof GetStartProcessFormErrors]; type GetStartProcessFormResponses = { /** * The form is successfully returned. */ 200: FormResult; /** * The process was found, but no form is associated with it. */ 204: void; }; type GetStartProcessFormResponse = GetStartProcessFormResponses[keyof GetStartProcessFormResponses]; type GetProcessDefinitionStatisticsData = { body?: ProcessDefinitionElementStatisticsQuery; path: { /** * The assigned key of the process definition, which acts as a unique identifier for this process definition. */ processDefinitionKey: ProcessDefinitionKey; }; query?: never; url: '/process-definitions/{processDefinitionKey}/statistics/element-instances'; }; type GetProcessDefinitionStatisticsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetProcessDefinitionStatisticsError = GetProcessDefinitionStatisticsErrors[keyof GetProcessDefinitionStatisticsErrors]; type GetProcessDefinitionStatisticsResponses = { /** * The process definition statistics result. */ 200: ProcessDefinitionElementStatisticsQueryResult; }; type GetProcessDefinitionStatisticsResponse = GetProcessDefinitionStatisticsResponses[keyof GetProcessDefinitionStatisticsResponses]; type GetProcessDefinitionXmlData = { body?: never; path: { /** * The assigned key of the process definition, which acts as a unique identifier for this process definition. * */ processDefinitionKey: ProcessDefinitionKey; }; query?: never; url: '/process-definitions/{processDefinitionKey}/xml'; }; type GetProcessDefinitionXmlErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The process definition with the given key was not found. * More details are provided in the response body. * */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetProcessDefinitionXmlError = GetProcessDefinitionXmlErrors[keyof GetProcessDefinitionXmlErrors]; type GetProcessDefinitionXmlResponses = { /** * The XML of the process definition is successfully returned. */ 200: string; /** * The process definition was found but does not have XML. */ 204: string; }; type GetProcessDefinitionXmlResponse = GetProcessDefinitionXmlResponses[keyof GetProcessDefinitionXmlResponses]; type GetProcessDefinitionInstanceVersionStatisticsData = { body: ProcessDefinitionInstanceVersionStatisticsQuery; path?: never; query?: never; url: '/process-definitions/statistics/process-instances-by-version'; }; type GetProcessDefinitionInstanceVersionStatisticsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetProcessDefinitionInstanceVersionStatisticsError = GetProcessDefinitionInstanceVersionStatisticsErrors[keyof GetProcessDefinitionInstanceVersionStatisticsErrors]; type GetProcessDefinitionInstanceVersionStatisticsResponses = { /** * The process definition instance version statistic result. */ 200: ProcessDefinitionInstanceVersionStatisticsQueryResult; }; type GetProcessDefinitionInstanceVersionStatisticsResponse = GetProcessDefinitionInstanceVersionStatisticsResponses[keyof GetProcessDefinitionInstanceVersionStatisticsResponses]; type CreateProcessInstanceData = { body: ProcessInstanceCreationInstruction; path?: never; query?: never; url: '/process-instances'; }; type CreateProcessInstanceErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The process instance creation was rejected due to a business ID uniqueness conflict. * This can happen only when Business ID Uniqueness Control is enabled and an * active root process instance with the provided business ID already exists * for the same process definition and tenant. * */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; /** * The process instance creation request timed out in the gateway. * This can happen if the `awaitCompletion` request parameter is set to `true` * and the created process instance did not complete within the defined request timeout. * This often happens when the created instance is not fully automated or contains wait states. * */ 504: ProblemDetail; }; type CreateProcessInstanceError = CreateProcessInstanceErrors[keyof CreateProcessInstanceErrors]; type CreateProcessInstanceResponses = { /** * The process instance was created. */ 200: CreateProcessInstanceResult; }; type CreateProcessInstanceResponse = CreateProcessInstanceResponses[keyof CreateProcessInstanceResponses]; type CancelProcessInstancesBatchOperationData = { body: ProcessInstanceCancellationBatchOperationRequest; path?: never; query?: never; url: '/process-instances/cancellation'; }; type CancelProcessInstancesBatchOperationErrors = { /** * The process instance batch operation failed. More details are provided in the response body. * */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type CancelProcessInstancesBatchOperationError = CancelProcessInstancesBatchOperationErrors[keyof CancelProcessInstancesBatchOperationErrors]; type CancelProcessInstancesBatchOperationResponses = { /** * The batch operation request was created. */ 200: BatchOperationCreatedResult; }; type CancelProcessInstancesBatchOperationResponse = CancelProcessInstancesBatchOperationResponses[keyof CancelProcessInstancesBatchOperationResponses]; type DeleteProcessInstancesBatchOperationData = { body: ProcessInstanceDeletionBatchOperationRequest; path?: never; query?: never; url: '/process-instances/deletion'; }; type DeleteProcessInstancesBatchOperationErrors = { /** * The process instance batch operation failed. More details are provided in the response body. * */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type DeleteProcessInstancesBatchOperationError = DeleteProcessInstancesBatchOperationErrors[keyof DeleteProcessInstancesBatchOperationErrors]; type DeleteProcessInstancesBatchOperationResponses = { /** * The batch operation request was created. */ 200: BatchOperationCreatedResult; }; type DeleteProcessInstancesBatchOperationResponse = DeleteProcessInstancesBatchOperationResponses[keyof DeleteProcessInstancesBatchOperationResponses]; type ResolveIncidentsBatchOperationData = { body?: ProcessInstanceIncidentResolutionBatchOperationRequest; path?: never; query?: never; url: '/process-instances/incident-resolution'; }; type ResolveIncidentsBatchOperationErrors = { /** * The process instance batch operation failed. More details are provided in the response body. * */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type ResolveIncidentsBatchOperationError = ResolveIncidentsBatchOperationErrors[keyof ResolveIncidentsBatchOperationErrors]; type ResolveIncidentsBatchOperationResponses = { /** * The batch operation request was created. */ 200: BatchOperationCreatedResult; }; type ResolveIncidentsBatchOperationResponse = ResolveIncidentsBatchOperationResponses[keyof ResolveIncidentsBatchOperationResponses]; type MigrateProcessInstancesBatchOperationData = { body: ProcessInstanceMigrationBatchOperationRequest; path?: never; query?: never; url: '/process-instances/migration'; }; type MigrateProcessInstancesBatchOperationErrors = { /** * The process instance batch operation failed. More details are provided in the response body. * */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type MigrateProcessInstancesBatchOperationError = MigrateProcessInstancesBatchOperationErrors[keyof MigrateProcessInstancesBatchOperationErrors]; type MigrateProcessInstancesBatchOperationResponses = { /** * The batch operation request was created. */ 200: BatchOperationCreatedResult; }; type MigrateProcessInstancesBatchOperationResponse = MigrateProcessInstancesBatchOperationResponses[keyof MigrateProcessInstancesBatchOperationResponses]; type ModifyProcessInstancesBatchOperationData = { body: ProcessInstanceModificationBatchOperationRequest; path?: never; query?: never; url: '/process-instances/modification'; }; type ModifyProcessInstancesBatchOperationErrors = { /** * The process instance batch operation failed. More details are provided in the response body. * */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type ModifyProcessInstancesBatchOperationError = ModifyProcessInstancesBatchOperationErrors[keyof ModifyProcessInstancesBatchOperationErrors]; type ModifyProcessInstancesBatchOperationResponses = { /** * The batch operation request was created. */ 200: BatchOperationCreatedResult; }; type ModifyProcessInstancesBatchOperationResponse = ModifyProcessInstancesBatchOperationResponses[keyof ModifyProcessInstancesBatchOperationResponses]; type SearchProcessInstancesData = { body?: ProcessInstanceSearchQuery; path?: never; query?: never; url: '/process-instances/search'; }; type SearchProcessInstancesErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchProcessInstancesError = SearchProcessInstancesErrors[keyof SearchProcessInstancesErrors]; type SearchProcessInstancesResponses = { /** * The process instance search result. */ 200: ProcessInstanceSearchQueryResult; }; type SearchProcessInstancesResponse = SearchProcessInstancesResponses[keyof SearchProcessInstancesResponses]; type GetProcessInstanceData = { body?: never; path: { /** * The process instance key. */ processInstanceKey: ProcessInstanceKey; }; query?: never; url: '/process-instances/{processInstanceKey}'; }; type GetProcessInstanceErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The process instance with the given key was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetProcessInstanceError = GetProcessInstanceErrors[keyof GetProcessInstanceErrors]; type GetProcessInstanceResponses = { /** * The process instance is successfully returned. */ 200: ProcessInstanceResult; }; type GetProcessInstanceResponse = GetProcessInstanceResponses[keyof GetProcessInstanceResponses]; type GetProcessInstanceCallHierarchyData = { body?: never; path: { /** * The key of the process instance to fetch the hierarchy for. */ processInstanceKey: ProcessInstanceKey; }; query?: never; url: '/process-instances/{processInstanceKey}/call-hierarchy'; }; type GetProcessInstanceCallHierarchyErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The process instance is not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetProcessInstanceCallHierarchyError = GetProcessInstanceCallHierarchyErrors[keyof GetProcessInstanceCallHierarchyErrors]; type GetProcessInstanceCallHierarchyResponses = { /** * The call hierarchy is successfully returned. */ 200: Array; }; type GetProcessInstanceCallHierarchyResponse = GetProcessInstanceCallHierarchyResponses[keyof GetProcessInstanceCallHierarchyResponses]; type CancelProcessInstanceData = { body?: { operationReference?: OperationReference; } | null; path: { /** * The key of the process instance to cancel. */ processInstanceKey: ProcessInstanceKey; }; query?: never; url: '/process-instances/{processInstanceKey}/cancellation'; }; type CancelProcessInstanceErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The process instance is not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; /** * The request timed out between the gateway and the broker. For these endpoints, this often happens when user task listeners are configured and the corresponding listener job is not completed within the request timeout. Common causes include no available job workers for the listener type, busy or crashed job workers, or delayed job completion. As with any gateway timeout, general timeout causes (for example transient network issues) can also result in a 504 response. * Troubleshooting: - verify that job workers for the listener type are running and healthy - check worker logs for crashes, retries, and completion failures - check network connectivity between workers, gateway, and broker - retry with backoff after transient failures - fail without retries if a problem persists * */ 504: ProblemDetail; }; type CancelProcessInstanceError = CancelProcessInstanceErrors[keyof CancelProcessInstanceErrors]; type CancelProcessInstanceResponses = { /** * The process instance is canceled. */ 204: void; }; type CancelProcessInstanceResponse = CancelProcessInstanceResponses[keyof CancelProcessInstanceResponses]; type DeleteProcessInstanceData = { body?: { operationReference?: OperationReference; } | null; path: { /** * The key of the process instance to delete. */ processInstanceKey: ProcessInstanceKey; }; query?: never; url: '/process-instances/{processInstanceKey}/deletion'; }; type DeleteProcessInstanceErrors = { /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The process instance is not found. */ 404: ProblemDetail; /** * The process instance is not in a completed or terminated state and cannot be deleted. */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type DeleteProcessInstanceError = DeleteProcessInstanceErrors[keyof DeleteProcessInstanceErrors]; type DeleteProcessInstanceResponses = { /** * The process instance is marked for deletion. */ 204: void; }; type DeleteProcessInstanceResponse = DeleteProcessInstanceResponses[keyof DeleteProcessInstanceResponses]; type ResolveProcessInstanceIncidentsData = { body?: never; path: { /** * The key of the process instance to resolve incidents for. */ processInstanceKey: ProcessInstanceKey; }; query?: never; url: '/process-instances/{processInstanceKey}/incident-resolution'; }; type ResolveProcessInstanceIncidentsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * The process instance is not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type ResolveProcessInstanceIncidentsError = ResolveProcessInstanceIncidentsErrors[keyof ResolveProcessInstanceIncidentsErrors]; type ResolveProcessInstanceIncidentsResponses = { /** * The batch operation request for incident resolution was created. */ 200: BatchOperationCreatedResult; }; type ResolveProcessInstanceIncidentsResponse = ResolveProcessInstanceIncidentsResponses[keyof ResolveProcessInstanceIncidentsResponses]; type SearchProcessInstanceIncidentsData = { body?: IncidentSearchQuery; path: { /** * The assigned key of the process instance, which acts as a unique identifier for this process instance. */ processInstanceKey: ProcessInstanceKey; }; query?: never; url: '/process-instances/{processInstanceKey}/incidents/search'; }; type SearchProcessInstanceIncidentsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The process instance with the given key was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchProcessInstanceIncidentsError = SearchProcessInstanceIncidentsErrors[keyof SearchProcessInstanceIncidentsErrors]; type SearchProcessInstanceIncidentsResponses = { /** * The process instance search result. */ 200: IncidentSearchQueryResult; }; type SearchProcessInstanceIncidentsResponse = SearchProcessInstanceIncidentsResponses[keyof SearchProcessInstanceIncidentsResponses]; type MigrateProcessInstanceData = { body: ProcessInstanceMigrationInstruction; path: { /** * The key of the process instance that should be migrated. */ processInstanceKey: ProcessInstanceKey; }; query?: never; url: '/process-instances/{processInstanceKey}/migration'; }; type MigrateProcessInstanceErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The process instance is not found. */ 404: ProblemDetail; /** * The process instance migration failed. More details are provided in the response body. * */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type MigrateProcessInstanceError = MigrateProcessInstanceErrors[keyof MigrateProcessInstanceErrors]; type MigrateProcessInstanceResponses = { /** * The process instance is migrated. */ 204: void; }; type MigrateProcessInstanceResponse = MigrateProcessInstanceResponses[keyof MigrateProcessInstanceResponses]; type ModifyProcessInstanceData = { body: ProcessInstanceModificationInstruction; path: { /** * The key of the process instance that should be modified. */ processInstanceKey: ProcessInstanceKey; }; query?: never; url: '/process-instances/{processInstanceKey}/modification'; }; type ModifyProcessInstanceErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The process instance is not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type ModifyProcessInstanceError = ModifyProcessInstanceErrors[keyof ModifyProcessInstanceErrors]; type ModifyProcessInstanceResponses = { /** * The process instance is modified. */ 204: void; }; type ModifyProcessInstanceResponse = ModifyProcessInstanceResponses[keyof ModifyProcessInstanceResponses]; type GetProcessInstanceSequenceFlowsData = { body?: never; path: { /** * The assigned key of the process instance, which acts as a unique identifier for this process instance. */ processInstanceKey: ProcessInstanceKey; }; query?: never; url: '/process-instances/{processInstanceKey}/sequence-flows'; }; type GetProcessInstanceSequenceFlowsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetProcessInstanceSequenceFlowsError = GetProcessInstanceSequenceFlowsErrors[keyof GetProcessInstanceSequenceFlowsErrors]; type GetProcessInstanceSequenceFlowsResponses = { /** * The process instance sequence flows result. */ 200: ProcessInstanceSequenceFlowsQueryResult; }; type GetProcessInstanceSequenceFlowsResponse = GetProcessInstanceSequenceFlowsResponses[keyof GetProcessInstanceSequenceFlowsResponses]; type GetProcessInstanceStatisticsData = { body?: never; path: { /** * The assigned key of the process instance, which acts as a unique identifier for this process instance. */ processInstanceKey: ProcessInstanceKey; }; query?: never; url: '/process-instances/{processInstanceKey}/statistics/element-instances'; }; type GetProcessInstanceStatisticsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetProcessInstanceStatisticsError = GetProcessInstanceStatisticsErrors[keyof GetProcessInstanceStatisticsErrors]; type GetProcessInstanceStatisticsResponses = { /** * The process instance statistics result. */ 200: ProcessInstanceElementStatisticsQueryResult; }; type GetProcessInstanceStatisticsResponse = GetProcessInstanceStatisticsResponses[keyof GetProcessInstanceStatisticsResponses]; type GetResourceData = { body?: never; path: { /** * The unique key identifying the resource. */ resourceKey: ResourceKey; }; query?: never; url: '/resources/{resourceKey}'; }; type GetResourceErrors = { /** * A resource with the given key was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetResourceError = GetResourceErrors[keyof GetResourceErrors]; type GetResourceResponses = { /** * The resource is successfully returned. */ 200: ResourceResult; }; type GetResourceResponse = GetResourceResponses[keyof GetResourceResponses]; type GetResourceContentData = { body?: never; path: { /** * The unique key identifying the resource. */ resourceKey: ResourceKey; }; query?: never; url: '/resources/{resourceKey}/content'; }; type GetResourceContentErrors = { /** * A resource with the given key was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetResourceContentError = GetResourceContentErrors[keyof GetResourceContentErrors]; type GetResourceContentResponses = { /** * The resource content is successfully returned. */ 200: string; }; type GetResourceContentResponse = GetResourceContentResponses[keyof GetResourceContentResponses]; type DeleteResourceData = { body?: DeleteResourceRequest; path: { /** * The key of the resource to delete. * This can be the key of a process definition, the key of a decision requirements * definition or the key of a form definition * */ resourceKey: ResourceKey; }; query?: never; url: '/resources/{resourceKey}/deletion'; }; type DeleteResourceErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The resource is not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type DeleteResourceError = DeleteResourceErrors[keyof DeleteResourceErrors]; type DeleteResourceResponses = { /** * The resource is deleted. */ 200: DeleteResourceResponse; }; type DeleteResourceResponse2 = DeleteResourceResponses[keyof DeleteResourceResponses]; type CreateRoleData = { body?: RoleCreateRequest; path?: never; query?: never; url: '/roles'; }; type CreateRoleErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type CreateRoleError = CreateRoleErrors[keyof CreateRoleErrors]; type CreateRoleResponses = { /** * The role was created successfully. */ 201: RoleCreateResult; }; type CreateRoleResponse = CreateRoleResponses[keyof CreateRoleResponses]; type SearchRolesData = { body?: RoleSearchQueryRequest; path?: never; query?: never; url: '/roles/search'; }; type SearchRolesErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchRolesError = SearchRolesErrors[keyof SearchRolesErrors]; type SearchRolesResponses = { /** * The roles search result. */ 200: RoleSearchQueryResult; }; type SearchRolesResponse = SearchRolesResponses[keyof SearchRolesResponses]; type DeleteRoleData = { body?: never; path: { /** * The role ID. */ roleId: string; }; query?: never; url: '/roles/{roleId}'; }; type DeleteRoleErrors = { /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * The role with the ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type DeleteRoleError = DeleteRoleErrors[keyof DeleteRoleErrors]; type DeleteRoleResponses = { /** * The role was deleted successfully. */ 204: void; }; type DeleteRoleResponse = DeleteRoleResponses[keyof DeleteRoleResponses]; type GetRoleData = { body?: never; path: { /** * The role ID. */ roleId: string; }; query?: never; url: '/roles/{roleId}'; }; type GetRoleErrors = { /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The role with the given ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetRoleError = GetRoleErrors[keyof GetRoleErrors]; type GetRoleResponses = { /** * The role is successfully returned. */ 200: RoleResult; }; type GetRoleResponse = GetRoleResponses[keyof GetRoleResponses]; type UpdateRoleData = { body: RoleUpdateRequest; path: { /** * The role ID. */ roleId: string; }; query?: never; url: '/roles/{roleId}'; }; type UpdateRoleErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * The role with the ID is not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UpdateRoleError = UpdateRoleErrors[keyof UpdateRoleErrors]; type UpdateRoleResponses = { /** * The role was updated successfully. */ 200: RoleUpdateResult; }; type UpdateRoleResponse = UpdateRoleResponses[keyof UpdateRoleResponses]; type SearchClientsForRoleData = { body?: SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array<{ /** * The field to sort by. */ field: 'clientId'; order?: SortOrderEnum; }>; }; path: { /** * The role ID. */ roleId: string; }; query?: never; url: '/roles/{roleId}/clients/search'; }; type SearchClientsForRoleErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The role with the given ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchClientsForRoleError = SearchClientsForRoleErrors[keyof SearchClientsForRoleErrors]; type SearchClientsForRoleResponses = { /** * The clients with the assigned role. */ 200: SearchQueryResponse & { /** * The matching clients. */ items: Array<{ /** * The ID of the client. */ clientId: string; }>; }; }; type SearchClientsForRoleResponse = SearchClientsForRoleResponses[keyof SearchClientsForRoleResponses]; type UnassignRoleFromClientData = { body?: never; path: { /** * The role ID. */ roleId: string; /** * The client ID. */ clientId: string; }; query?: never; url: '/roles/{roleId}/clients/{clientId}'; }; type UnassignRoleFromClientErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The role or client with the given ID or username was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UnassignRoleFromClientError = UnassignRoleFromClientErrors[keyof UnassignRoleFromClientErrors]; type UnassignRoleFromClientResponses = { /** * The role was unassigned successfully from the client. */ 204: void; }; type UnassignRoleFromClientResponse = UnassignRoleFromClientResponses[keyof UnassignRoleFromClientResponses]; type AssignRoleToClientData = { body?: never; path: { /** * The role ID. */ roleId: string; /** * The client ID. */ clientId: string; }; query?: never; url: '/roles/{roleId}/clients/{clientId}'; }; type AssignRoleToClientErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The role with the given ID was not found. */ 404: ProblemDetail; /** * The role was already assigned to the client with the given ID. */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type AssignRoleToClientError = AssignRoleToClientErrors[keyof AssignRoleToClientErrors]; type AssignRoleToClientResponses = { /** * The role was assigned successfully to the client. */ 204: void; }; type AssignRoleToClientResponse = AssignRoleToClientResponses[keyof AssignRoleToClientResponses]; type SearchGroupsForRoleData = { body?: RoleGroupSearchQueryRequest; path: { /** * The role ID. */ roleId: string; }; query?: never; url: '/roles/{roleId}/groups/search'; }; type SearchGroupsForRoleErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The role with the given ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchGroupsForRoleError = SearchGroupsForRoleErrors[keyof SearchGroupsForRoleErrors]; type SearchGroupsForRoleResponses = { /** * The groups with assigned role. */ 200: RoleGroupSearchResult; }; type SearchGroupsForRoleResponse = SearchGroupsForRoleResponses[keyof SearchGroupsForRoleResponses]; type UnassignRoleFromGroupData = { body?: never; path: { /** * The role ID. */ roleId: string; /** * The group ID. */ groupId: string; }; query?: never; url: '/roles/{roleId}/groups/{groupId}'; }; type UnassignRoleFromGroupErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The role or group with the given ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UnassignRoleFromGroupError = UnassignRoleFromGroupErrors[keyof UnassignRoleFromGroupErrors]; type UnassignRoleFromGroupResponses = { /** * The role was unassigned successfully from the group. */ 204: void; }; type UnassignRoleFromGroupResponse = UnassignRoleFromGroupResponses[keyof UnassignRoleFromGroupResponses]; type AssignRoleToGroupData = { body?: never; path: { /** * The role ID. */ roleId: string; /** * The group ID. */ groupId: string; }; query?: never; url: '/roles/{roleId}/groups/{groupId}'; }; type AssignRoleToGroupErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The role or group with the given ID was not found. */ 404: ProblemDetail; /** * The role is already assigned to the group with the given ID. */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type AssignRoleToGroupError = AssignRoleToGroupErrors[keyof AssignRoleToGroupErrors]; type AssignRoleToGroupResponses = { /** * The role was assigned successfully to the group. */ 204: void; }; type AssignRoleToGroupResponse = AssignRoleToGroupResponses[keyof AssignRoleToGroupResponses]; type SearchMappingRulesForRoleData = { body?: MappingRuleSearchQueryRequest; path: { /** * The role ID. */ roleId: string; }; query?: never; url: '/roles/{roleId}/mapping-rules/search'; }; type SearchMappingRulesForRoleErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The role with the given ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchMappingRulesForRoleError = SearchMappingRulesForRoleErrors[keyof SearchMappingRulesForRoleErrors]; type SearchMappingRulesForRoleResponses = { /** * The mapping rules with assigned role. */ 200: SearchQueryResponse & { /** * The matching mapping rules. */ items: Array; }; }; type SearchMappingRulesForRoleResponse = SearchMappingRulesForRoleResponses[keyof SearchMappingRulesForRoleResponses]; type UnassignRoleFromMappingRuleData = { body?: never; path: { /** * The role ID. */ roleId: string; /** * The mapping rule ID. */ mappingRuleId: string; }; query?: never; url: '/roles/{roleId}/mapping-rules/{mappingRuleId}'; }; type UnassignRoleFromMappingRuleErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The role or mapping rule with the given ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UnassignRoleFromMappingRuleError = UnassignRoleFromMappingRuleErrors[keyof UnassignRoleFromMappingRuleErrors]; type UnassignRoleFromMappingRuleResponses = { /** * The role was unassigned successfully from the mapping rule. */ 204: void; }; type UnassignRoleFromMappingRuleResponse = UnassignRoleFromMappingRuleResponses[keyof UnassignRoleFromMappingRuleResponses]; type AssignRoleToMappingRuleData = { body?: never; path: { /** * The role ID. */ roleId: string; /** * The mapping rule ID. */ mappingRuleId: string; }; query?: never; url: '/roles/{roleId}/mapping-rules/{mappingRuleId}'; }; type AssignRoleToMappingRuleErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The role or mapping rule with the given ID was not found. */ 404: ProblemDetail; /** * The role is already assigned to the mapping rule with the given ID. */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type AssignRoleToMappingRuleError = AssignRoleToMappingRuleErrors[keyof AssignRoleToMappingRuleErrors]; type AssignRoleToMappingRuleResponses = { /** * The role was assigned successfully to the mapping rule. */ 204: void; }; type AssignRoleToMappingRuleResponse = AssignRoleToMappingRuleResponses[keyof AssignRoleToMappingRuleResponses]; type SearchUsersForRoleData = { body?: SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array<{ /** * The field to sort by. */ field: 'username'; order?: SortOrderEnum; }>; }; path: { /** * The role ID. */ roleId: string; }; query?: never; url: '/roles/{roleId}/users/search'; }; type SearchUsersForRoleErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The role with the given ID was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchUsersForRoleError = SearchUsersForRoleErrors[keyof SearchUsersForRoleErrors]; type SearchUsersForRoleResponses = { /** * The users with the assigned role. */ 200: SearchQueryResponse & { /** * The matching users. */ items: Array<{ username: Username; }>; }; }; type SearchUsersForRoleResponse = SearchUsersForRoleResponses[keyof SearchUsersForRoleResponses]; type UnassignRoleFromUserData = { body?: never; path: { /** * The role ID. */ roleId: string; /** * The user username. */ username: Username; }; query?: never; url: '/roles/{roleId}/users/{username}'; }; type UnassignRoleFromUserErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The role or user with the given ID or username was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UnassignRoleFromUserError = UnassignRoleFromUserErrors[keyof UnassignRoleFromUserErrors]; type UnassignRoleFromUserResponses = { /** * The role was unassigned successfully from the user. */ 204: void; }; type UnassignRoleFromUserResponse = UnassignRoleFromUserResponses[keyof UnassignRoleFromUserResponses]; type AssignRoleToUserData = { body?: never; path: { /** * The role ID. */ roleId: string; /** * The user username. */ username: Username; }; query?: never; url: '/roles/{roleId}/users/{username}'; }; type AssignRoleToUserErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The role or user with the given ID or username was not found. */ 404: ProblemDetail; /** * The role is already assigned to the user with the given ID. */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type AssignRoleToUserError = AssignRoleToUserErrors[keyof AssignRoleToUserErrors]; type AssignRoleToUserResponses = { /** * The role was assigned successfully to the user. */ 204: void; }; type AssignRoleToUserResponse = AssignRoleToUserResponses[keyof AssignRoleToUserResponses]; type CreateAdminUserData = { body: UserRequest; path?: never; query?: never; url: '/setup/user'; }; type CreateAdminUserErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type CreateAdminUserError = CreateAdminUserErrors[keyof CreateAdminUserErrors]; type CreateAdminUserResponses = { /** * The admin user was created successfully. */ 201: UserCreateResult; }; type CreateAdminUserResponse = CreateAdminUserResponses[keyof CreateAdminUserResponses]; type BroadcastSignalData = { body: SignalBroadcastRequest; path?: never; query?: never; url: '/signals/broadcast'; }; type BroadcastSignalErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The signal is not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type BroadcastSignalError = BroadcastSignalErrors[keyof BroadcastSignalErrors]; type BroadcastSignalResponses = { /** * The signal was broadcast. */ 200: SignalBroadcastResult; }; type BroadcastSignalResponse = BroadcastSignalResponses[keyof BroadcastSignalResponses]; type GetStatusData = { body?: never; path?: never; query?: never; url: '/status'; }; type GetStatusErrors = { /** * The cluster is DOWN and does not have any partition with a healthy leader. */ 503: unknown; }; type GetStatusResponses = { /** * The cluster is UP and has at least one partition with a healthy leader. */ 204: void; }; type GetStatusResponse = GetStatusResponses[keyof GetStatusResponses]; type GetUsageMetricsData = { body?: never; path?: never; query: { /** * The start date for usage metrics, including this date. Value in ISO 8601 format. */ startTime: string; /** * The end date for usage metrics, including this date. Value in ISO 8601 format. */ endTime: string; /** * Restrict results to a specific tenant ID. If not provided, results for all tenants are returned. */ tenantId?: TenantId; /** * Whether to return tenant metrics in addition to the total metrics or not. Default false. */ withTenants?: boolean; }; url: '/system/usage-metrics'; }; type GetUsageMetricsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetUsageMetricsError = GetUsageMetricsErrors[keyof GetUsageMetricsErrors]; type GetUsageMetricsResponses = { /** * The usage metrics search result. */ 200: UsageMetricsResponse; }; type GetUsageMetricsResponse = GetUsageMetricsResponses[keyof GetUsageMetricsResponses]; type GetSystemConfigurationData = { body?: never; path?: never; query?: never; url: '/system/configuration'; }; type GetSystemConfigurationErrors = { /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetSystemConfigurationError = GetSystemConfigurationErrors[keyof GetSystemConfigurationErrors]; type GetSystemConfigurationResponses = { /** * Current system configuration grouped by feature area. */ 200: SystemConfigurationResponse; }; type GetSystemConfigurationResponse = GetSystemConfigurationResponses[keyof GetSystemConfigurationResponses]; type CreateTenantData = { body: TenantCreateRequest; path?: never; query?: never; url: '/tenants'; }; type CreateTenantErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found. The resource was not found. */ 404: ProblemDetail; /** * Tenant with this id already exists. */ 409: unknown; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type CreateTenantError = CreateTenantErrors[keyof CreateTenantErrors]; type CreateTenantResponses = { /** * The tenant was created successfully. */ 201: TenantCreateResult; }; type CreateTenantResponse = CreateTenantResponses[keyof CreateTenantResponses]; type SearchTenantsData = { body?: TenantSearchQueryRequest; path?: never; query?: never; url: '/tenants/search'; }; type SearchTenantsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchTenantsError = SearchTenantsErrors[keyof SearchTenantsErrors]; type SearchTenantsResponses = { /** * The tenants search result */ 200: TenantSearchQueryResult; }; type SearchTenantsResponse = SearchTenantsResponses[keyof SearchTenantsResponses]; type DeleteTenantData = { body?: never; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; }; query?: never; url: '/tenants/{tenantId}'; }; type DeleteTenantErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found. The tenant was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type DeleteTenantError = DeleteTenantErrors[keyof DeleteTenantErrors]; type DeleteTenantResponses = { /** * The tenant was deleted successfully. */ 204: void; }; type DeleteTenantResponse = DeleteTenantResponses[keyof DeleteTenantResponses]; type GetTenantData = { body?: never; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; }; query?: never; url: '/tenants/{tenantId}'; }; type GetTenantErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Tenant not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetTenantError = GetTenantErrors[keyof GetTenantErrors]; type GetTenantResponses = { /** * The tenant was retrieved successfully. */ 200: TenantResult; }; type GetTenantResponse = GetTenantResponses[keyof GetTenantResponses]; type UpdateTenantData = { body: TenantUpdateRequest; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; }; query?: never; url: '/tenants/{tenantId}'; }; type UpdateTenantErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found. The tenant was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UpdateTenantError = UpdateTenantErrors[keyof UpdateTenantErrors]; type UpdateTenantResponses = { /** * The tenant was updated successfully. */ 200: TenantUpdateResult; }; type UpdateTenantResponse = UpdateTenantResponses[keyof UpdateTenantResponses]; type SearchClientsForTenantData = { body?: SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array<{ /** * The field to sort by. */ field: 'clientId'; order?: SortOrderEnum; }>; }; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; }; query?: never; url: '/tenants/{tenantId}/clients/search'; }; type SearchClientsForTenantResponses = { /** * The search result of users for the tenant. */ 200: SearchQueryResponse & { /** * The matching clients. */ items: Array<{ /** * The ID of the client. */ clientId: string; }>; }; }; type SearchClientsForTenantResponse = SearchClientsForTenantResponses[keyof SearchClientsForTenantResponses]; type UnassignClientFromTenantData = { body?: never; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; /** * The unique identifier of the application. */ clientId: string; }; query?: never; url: '/tenants/{tenantId}/clients/{clientId}'; }; type UnassignClientFromTenantErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The tenant does not exist or the client was not assigned to it. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UnassignClientFromTenantError = UnassignClientFromTenantErrors[keyof UnassignClientFromTenantErrors]; type UnassignClientFromTenantResponses = { /** * The client was successfully unassigned from the tenant. */ 204: void; }; type UnassignClientFromTenantResponse = UnassignClientFromTenantResponses[keyof UnassignClientFromTenantResponses]; type AssignClientToTenantData = { body?: never; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; /** * The unique identifier of the application. */ clientId: string; }; query?: never; url: '/tenants/{tenantId}/clients/{clientId}'; }; type AssignClientToTenantErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The tenant was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type AssignClientToTenantError = AssignClientToTenantErrors[keyof AssignClientToTenantErrors]; type AssignClientToTenantResponses = { /** * The client was successfully assigned to the tenant. */ 204: void; }; type AssignClientToTenantResponse = AssignClientToTenantResponses[keyof AssignClientToTenantResponses]; type SearchGroupIdsForTenantData = { body?: TenantGroupSearchQueryRequest; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; }; query?: never; url: '/tenants/{tenantId}/groups/search'; }; type SearchGroupIdsForTenantResponses = { /** * The search result of groups for the tenant. */ 200: TenantGroupSearchResult; }; type SearchGroupIdsForTenantResponse = SearchGroupIdsForTenantResponses[keyof SearchGroupIdsForTenantResponses]; type UnassignGroupFromTenantData = { body?: never; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; /** * The unique identifier of the group. */ groupId: string; }; query?: never; url: '/tenants/{tenantId}/groups/{groupId}'; }; type UnassignGroupFromTenantErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found. The tenant or group was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UnassignGroupFromTenantError = UnassignGroupFromTenantErrors[keyof UnassignGroupFromTenantErrors]; type UnassignGroupFromTenantResponses = { /** * The group was successfully unassigned from the tenant. */ 204: void; }; type UnassignGroupFromTenantResponse = UnassignGroupFromTenantResponses[keyof UnassignGroupFromTenantResponses]; type AssignGroupToTenantData = { body?: never; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; /** * The unique identifier of the group. */ groupId: string; }; query?: never; url: '/tenants/{tenantId}/groups/{groupId}'; }; type AssignGroupToTenantErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found. The tenant or group was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type AssignGroupToTenantError = AssignGroupToTenantErrors[keyof AssignGroupToTenantErrors]; type AssignGroupToTenantResponses = { /** * The group was successfully assigned to the tenant. */ 204: void; }; type AssignGroupToTenantResponse = AssignGroupToTenantResponses[keyof AssignGroupToTenantResponses]; type SearchMappingRulesForTenantData = { body?: MappingRuleSearchQueryRequest; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; }; query?: never; url: '/tenants/{tenantId}/mapping-rules/search'; }; type SearchMappingRulesForTenantResponses = { /** * The search result of MappingRules for the tenant. */ 200: SearchQueryResponse & { /** * The matching mapping rules. */ items: Array; }; }; type SearchMappingRulesForTenantResponse = SearchMappingRulesForTenantResponses[keyof SearchMappingRulesForTenantResponses]; type UnassignMappingRuleFromTenantData = { body?: never; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; /** * The unique identifier of the mapping rule. */ mappingRuleId: string; }; query?: never; url: '/tenants/{tenantId}/mapping-rules/{mappingRuleId}'; }; type UnassignMappingRuleFromTenantErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found. The tenant or mapping rule was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UnassignMappingRuleFromTenantError = UnassignMappingRuleFromTenantErrors[keyof UnassignMappingRuleFromTenantErrors]; type UnassignMappingRuleFromTenantResponses = { /** * The mapping rule was successfully unassigned from the tenant. */ 204: void; }; type UnassignMappingRuleFromTenantResponse = UnassignMappingRuleFromTenantResponses[keyof UnassignMappingRuleFromTenantResponses]; type AssignMappingRuleToTenantData = { body?: never; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; /** * The unique identifier of the mapping rule. */ mappingRuleId: string; }; query?: never; url: '/tenants/{tenantId}/mapping-rules/{mappingRuleId}'; }; type AssignMappingRuleToTenantErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found. The tenant or mapping rule was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type AssignMappingRuleToTenantError = AssignMappingRuleToTenantErrors[keyof AssignMappingRuleToTenantErrors]; type AssignMappingRuleToTenantResponses = { /** * The mapping rule was successfully assigned to the tenant. */ 204: void; }; type AssignMappingRuleToTenantResponse = AssignMappingRuleToTenantResponses[keyof AssignMappingRuleToTenantResponses]; type SearchRolesForTenantData = { body?: RoleSearchQueryRequest; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; }; query?: never; url: '/tenants/{tenantId}/roles/search'; }; type SearchRolesForTenantResponses = { /** * The search result of roles for the tenant. */ 200: SearchQueryResponse & { /** * The matching roles. */ items: Array; }; }; type SearchRolesForTenantResponse = SearchRolesForTenantResponses[keyof SearchRolesForTenantResponses]; type UnassignRoleFromTenantData = { body?: never; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; /** * The unique identifier of the role. */ roleId: string; }; query?: never; url: '/tenants/{tenantId}/roles/{roleId}'; }; type UnassignRoleFromTenantErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found. The tenant or role was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UnassignRoleFromTenantError = UnassignRoleFromTenantErrors[keyof UnassignRoleFromTenantErrors]; type UnassignRoleFromTenantResponses = { /** * The role was successfully unassigned from the tenant. */ 204: void; }; type UnassignRoleFromTenantResponse = UnassignRoleFromTenantResponses[keyof UnassignRoleFromTenantResponses]; type AssignRoleToTenantData = { body?: never; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; /** * The unique identifier of the role. */ roleId: string; }; query?: never; url: '/tenants/{tenantId}/roles/{roleId}'; }; type AssignRoleToTenantErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found. The tenant or role was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type AssignRoleToTenantError = AssignRoleToTenantErrors[keyof AssignRoleToTenantErrors]; type AssignRoleToTenantResponses = { /** * The role was successfully assigned to the tenant. */ 204: void; }; type AssignRoleToTenantResponse = AssignRoleToTenantResponses[keyof AssignRoleToTenantResponses]; type SearchUsersForTenantData = { body?: SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array<{ /** * The field to sort by. */ field: 'username'; order?: SortOrderEnum; }>; }; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; }; query?: never; url: '/tenants/{tenantId}/users/search'; }; type SearchUsersForTenantResponses = { /** * The search result of users for the tenant. */ 200: SearchQueryResponse & { /** * The matching users. */ items: Array<{ username: Username; }>; }; }; type SearchUsersForTenantResponse = SearchUsersForTenantResponses[keyof SearchUsersForTenantResponses]; type UnassignUserFromTenantData = { body?: never; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; /** * The unique identifier of the user. */ username: Username; }; query?: never; url: '/tenants/{tenantId}/users/{username}'; }; type UnassignUserFromTenantErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found. The tenant or user was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UnassignUserFromTenantError = UnassignUserFromTenantErrors[keyof UnassignUserFromTenantErrors]; type UnassignUserFromTenantResponses = { /** * The user was successfully unassigned from the tenant. */ 204: void; }; type UnassignUserFromTenantResponse = UnassignUserFromTenantResponses[keyof UnassignUserFromTenantResponses]; type AssignUserToTenantData = { body?: never; path: { /** * The unique identifier of the tenant. */ tenantId: TenantId; /** * The unique identifier of the user. */ username: Username; }; query?: never; url: '/tenants/{tenantId}/users/{username}'; }; type AssignUserToTenantErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found. The tenant or user was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type AssignUserToTenantError = AssignUserToTenantErrors[keyof AssignUserToTenantErrors]; type AssignUserToTenantResponses = { /** * The user was successfully assigned to the tenant. */ 204: void; }; type AssignUserToTenantResponse = AssignUserToTenantResponses[keyof AssignUserToTenantResponses]; type GetTopologyData = { body?: never; path?: never; query?: never; url: '/topology'; }; type GetTopologyErrors = { /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetTopologyError = GetTopologyErrors[keyof GetTopologyErrors]; type GetTopologyResponses = { /** * Obtains the current topology of the cluster the gateway is part of. */ 200: TopologyResponse; }; type GetTopologyResponse = GetTopologyResponses[keyof GetTopologyResponses]; type CreateUserData = { body: UserRequest; path?: never; query?: never; url: '/users'; }; type CreateUserErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * A user with this username already exists. */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type CreateUserError = CreateUserErrors[keyof CreateUserErrors]; type CreateUserResponses = { /** * The user was created successfully. */ 201: UserCreateResult; }; type CreateUserResponse = CreateUserResponses[keyof CreateUserResponses]; type SearchUsersData = { body?: UserSearchQueryRequest; path?: never; query?: never; url: '/users/search'; }; type SearchUsersErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchUsersError = SearchUsersErrors[keyof SearchUsersErrors]; type SearchUsersResponses = { /** * The user search result. */ 200: SearchQueryResponse & { /** * The matching users. */ items: Array<{ username: Username; /** * The name of the user. */ name: string | null; /** * The email of the user. */ email: string | null; }>; }; }; type SearchUsersResponse = SearchUsersResponses[keyof SearchUsersResponses]; type DeleteUserData = { body?: never; path: { /** * The username of the user to delete. */ username: Username; }; query?: never; url: '/users/{username}'; }; type DeleteUserErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The user is not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type DeleteUserError = DeleteUserErrors[keyof DeleteUserErrors]; type DeleteUserResponses = { /** * The user was deleted successfully. */ 204: void; }; type DeleteUserResponse = DeleteUserResponses[keyof DeleteUserResponses]; type GetUserData = { body?: never; path: { /** * The username of the user. */ username: Username; }; query?: never; url: '/users/{username}'; }; type GetUserErrors = { /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The user with the given username was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetUserError = GetUserErrors[keyof GetUserErrors]; type GetUserResponses = { /** * The user is successfully returned. */ 200: { username: Username; /** * The name of the user. */ name: string | null; /** * The email of the user. */ email: string | null; }; }; type GetUserResponse = GetUserResponses[keyof GetUserResponses]; type UpdateUserData = { body: UserUpdateRequest; path: { /** * The username of the user to update. */ username: Username; }; query?: never; url: '/users/{username}'; }; type UpdateUserErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The user was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; }; type UpdateUserError = UpdateUserErrors[keyof UpdateUserErrors]; type UpdateUserResponses = { /** * The user was updated successfully. */ 200: { username: Username; /** * The name of the user. */ name: string | null; /** * The email of the user. */ email: string | null; }; }; type UpdateUserResponse = UpdateUserResponses[keyof UpdateUserResponses]; type SearchUserTasksData = { body?: UserTaskSearchQuery; path?: never; query?: never; url: '/user-tasks/search'; }; type SearchUserTasksErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchUserTasksError = SearchUserTasksErrors[keyof SearchUserTasksErrors]; type SearchUserTasksResponses = { /** * The user task search result. */ 200: UserTaskSearchQueryResult; }; type SearchUserTasksResponse = SearchUserTasksResponses[keyof SearchUserTasksResponses]; type GetUserTaskData = { body?: never; path: { /** * The user task key. */ userTaskKey: UserTaskKey; }; query?: never; url: '/user-tasks/{userTaskKey}'; }; type GetUserTaskErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * The user task with the given key was not found. */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetUserTaskError = GetUserTaskErrors[keyof GetUserTaskErrors]; type GetUserTaskResponses = { /** * The user task is successfully returned. */ 200: UserTaskResult; }; type GetUserTaskResponse = GetUserTaskResponses[keyof GetUserTaskResponses]; type UpdateUserTaskData = { body?: UserTaskUpdateRequest; path: { /** * The key of the user task to update. */ userTaskKey: UserTaskKey; }; query?: never; url: '/user-tasks/{userTaskKey}'; }; type UpdateUserTaskErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The user task with the given key was not found. */ 404: ProblemDetail; /** * The user task with the given key is in the wrong state currently. More details are provided in the response body. * */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; /** * The request timed out between the gateway and the broker. For these endpoints, this often happens when user task listeners are configured and the corresponding listener job is not completed within the request timeout. Common causes include no available job workers for the listener type, busy or crashed job workers, or delayed job completion. As with any gateway timeout, general timeout causes (for example transient network issues) can also result in a 504 response. * Troubleshooting: - verify that job workers for the listener type are running and healthy - check worker logs for crashes, retries, and completion failures - check network connectivity between workers, gateway, and broker - retry with backoff after transient failures - fail without retries if a problem persists * */ 504: ProblemDetail; }; type UpdateUserTaskError = UpdateUserTaskErrors[keyof UpdateUserTaskErrors]; type UpdateUserTaskResponses = { /** * The user task was updated successfully. */ 204: void; }; type UpdateUserTaskResponse = UpdateUserTaskResponses[keyof UpdateUserTaskResponses]; type UnassignUserTaskData = { body?: never; path: { /** * The key of the user task. */ userTaskKey: UserTaskKey; }; query?: never; url: '/user-tasks/{userTaskKey}/assignee'; }; type UnassignUserTaskErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The user task with the given key was not found. */ 404: ProblemDetail; /** * The user task with the given key is in the wrong state currently. More details are provided in the response body. * */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; /** * The request timed out between the gateway and the broker. For these endpoints, this often happens when user task listeners are configured and the corresponding listener job is not completed within the request timeout. Common causes include no available job workers for the listener type, busy or crashed job workers, or delayed job completion. As with any gateway timeout, general timeout causes (for example transient network issues) can also result in a 504 response. * Troubleshooting: - verify that job workers for the listener type are running and healthy - check worker logs for crashes, retries, and completion failures - check network connectivity between workers, gateway, and broker - retry with backoff after transient failures - fail without retries if a problem persists * */ 504: ProblemDetail; }; type UnassignUserTaskError = UnassignUserTaskErrors[keyof UnassignUserTaskErrors]; type UnassignUserTaskResponses = { /** * The user task was unassigned successfully. */ 204: void; }; type UnassignUserTaskResponse = UnassignUserTaskResponses[keyof UnassignUserTaskResponses]; type AssignUserTaskData = { body: UserTaskAssignmentRequest; path: { /** * The key of the user task to assign. */ userTaskKey: UserTaskKey; }; query?: never; url: '/user-tasks/{userTaskKey}/assignment'; }; type AssignUserTaskErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The user task with the given key was not found. */ 404: ProblemDetail; /** * The user task with the given key is in the wrong state currently. More details are provided in the response body. * */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; /** * The request timed out between the gateway and the broker. For these endpoints, this often happens when user task listeners are configured and the corresponding listener job is not completed within the request timeout. Common causes include no available job workers for the listener type, busy or crashed job workers, or delayed job completion. As with any gateway timeout, general timeout causes (for example transient network issues) can also result in a 504 response. * Troubleshooting: - verify that job workers for the listener type are running and healthy - check worker logs for crashes, retries, and completion failures - check network connectivity between workers, gateway, and broker - retry with backoff after transient failures - fail without retries if a problem persists * */ 504: ProblemDetail; }; type AssignUserTaskError = AssignUserTaskErrors[keyof AssignUserTaskErrors]; type AssignUserTaskResponses = { /** * The user task's assignment was adjusted. */ 204: void; }; type AssignUserTaskResponse = AssignUserTaskResponses[keyof AssignUserTaskResponses]; type SearchUserTaskAuditLogsData = { body?: UserTaskAuditLogSearchQueryRequest; path: { /** * The key of the user task. */ userTaskKey: UserTaskKey; }; query?: never; url: '/user-tasks/{userTaskKey}/audit-logs/search'; }; type SearchUserTaskAuditLogsErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchUserTaskAuditLogsError = SearchUserTaskAuditLogsErrors[keyof SearchUserTaskAuditLogsErrors]; type SearchUserTaskAuditLogsResponses = { /** * The user task audit log search result. */ 200: AuditLogSearchQueryResult; }; type SearchUserTaskAuditLogsResponse = SearchUserTaskAuditLogsResponses[keyof SearchUserTaskAuditLogsResponses]; type CompleteUserTaskData = { body?: UserTaskCompletionRequest; path: { /** * The key of the user task to complete. */ userTaskKey: UserTaskKey; }; query?: never; url: '/user-tasks/{userTaskKey}/completion'; }; type CompleteUserTaskErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The user task with the given key was not found. */ 404: ProblemDetail; /** * The user task with the given key is in the wrong state currently. More details are provided in the response body. * */ 409: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; /** * The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure . * */ 503: ProblemDetail; /** * The request timed out between the gateway and the broker. For these endpoints, this often happens when user task listeners are configured and the corresponding listener job is not completed within the request timeout. Common causes include no available job workers for the listener type, busy or crashed job workers, or delayed job completion. As with any gateway timeout, general timeout causes (for example transient network issues) can also result in a 504 response. * Troubleshooting: - verify that job workers for the listener type are running and healthy - check worker logs for crashes, retries, and completion failures - check network connectivity between workers, gateway, and broker - retry with backoff after transient failures - fail without retries if a problem persists * */ 504: ProblemDetail; }; type CompleteUserTaskError = CompleteUserTaskErrors[keyof CompleteUserTaskErrors]; type CompleteUserTaskResponses = { /** * The user task was completed successfully. */ 204: void; }; type CompleteUserTaskResponse = CompleteUserTaskResponses[keyof CompleteUserTaskResponses]; type SearchUserTaskEffectiveVariablesData = { /** * User task effective variable search query request. Uses offset-based pagination only. * */ body?: { /** * Pagination parameters. */ page?: OffsetPagination; /** * Sort field criteria. */ sort?: Array<{ /** * The field to sort by. */ field: 'value' | 'name' | 'tenantId' | 'variableKey' | 'scopeKey' | 'processInstanceKey'; order?: SortOrderEnum; }>; /** * The user task variable search filters. */ filter?: UserTaskVariableFilter; }; path: { /** * The key of the user task. */ userTaskKey: UserTaskKey; }; query?: { /** * When true (default), long variable values in the response are truncated. When false, full variable values are returned. */ truncateValues?: boolean; }; url: '/user-tasks/{userTaskKey}/effective-variables/search'; }; type SearchUserTaskEffectiveVariablesErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchUserTaskEffectiveVariablesError = SearchUserTaskEffectiveVariablesErrors[keyof SearchUserTaskEffectiveVariablesErrors]; type SearchUserTaskEffectiveVariablesResponses = { /** * The user task effective variable search result. */ 200: VariableSearchQueryResult; }; type SearchUserTaskEffectiveVariablesResponse = SearchUserTaskEffectiveVariablesResponses[keyof SearchUserTaskEffectiveVariablesResponses]; type GetUserTaskFormData = { body?: never; path: { /** * The user task key. */ userTaskKey: UserTaskKey; }; query?: never; url: '/user-tasks/{userTaskKey}/form'; }; type GetUserTaskFormErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetUserTaskFormError = GetUserTaskFormErrors[keyof GetUserTaskFormErrors]; type GetUserTaskFormResponses = { /** * The form is successfully returned. */ 200: FormResult; /** * The user task was found, but no form is associated with it. */ 204: void; }; type GetUserTaskFormResponse = GetUserTaskFormResponses[keyof GetUserTaskFormResponses]; type SearchUserTaskVariablesData = { /** * User task search query request. */ body?: SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array<{ /** * The field to sort by. */ field: 'value' | 'name' | 'tenantId' | 'variableKey' | 'scopeKey' | 'processInstanceKey'; order?: SortOrderEnum; }>; /** * The user task variable search filters. */ filter?: UserTaskVariableFilter; }; path: { /** * The key of the user task. */ userTaskKey: UserTaskKey; }; query?: { /** * When true (default), long variable values in the response are truncated. When false, full variable values are returned. */ truncateValues?: boolean; }; url: '/user-tasks/{userTaskKey}/variables/search'; }; type SearchUserTaskVariablesErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchUserTaskVariablesError = SearchUserTaskVariablesErrors[keyof SearchUserTaskVariablesErrors]; type SearchUserTaskVariablesResponses = { /** * The user task variable search result. */ 200: VariableSearchQueryResult; }; type SearchUserTaskVariablesResponse = SearchUserTaskVariablesResponses[keyof SearchUserTaskVariablesResponses]; type SearchVariablesData = { /** * Variable search query request. */ body?: SearchQueryRequest & { /** * Sort field criteria. */ sort?: Array<{ /** * The field to sort by. */ field: 'value' | 'name' | 'tenantId' | 'variableKey' | 'scopeKey' | 'processInstanceKey'; order?: SortOrderEnum; }>; /** * The variable search filters. */ filter?: VariableFilter; }; path?: never; query?: { /** * When true (default), long variable values in the response are truncated. When false, full variable values are returned. */ truncateValues?: boolean; }; url: '/variables/search'; }; type SearchVariablesErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type SearchVariablesError = SearchVariablesErrors[keyof SearchVariablesErrors]; type SearchVariablesResponses = { /** * The variable search result. */ 200: VariableSearchQueryResult; }; type SearchVariablesResponse = SearchVariablesResponses[keyof SearchVariablesResponses]; type GetVariableData = { body?: never; path: { /** * The variable key. */ variableKey: VariableKey; }; query?: never; url: '/variables/{variableKey}'; }; type GetVariableErrors = { /** * The provided data is not valid. */ 400: ProblemDetail; /** * The request lacks valid authentication credentials. */ 401: ProblemDetail; /** * Forbidden. The request is not allowed. */ 403: ProblemDetail; /** * Not found */ 404: ProblemDetail; /** * An internal error occurred while processing the request. */ 500: ProblemDetail; }; type GetVariableError = GetVariableErrors[keyof GetVariableErrors]; type GetVariableResponses = { /** * The variable is successfully returned. */ 200: VariableResult; }; type GetVariableResponse = GetVariableResponses[keyof GetVariableResponses]; declare function assertConstraint(value: string, label: string, c: { pattern?: string; minLength?: number; maxLength?: number; }): void; /** * System-generated entity key for an audit log entry. */ type AuditLogEntityKey = CamundaKey<'AuditLogEntityKey'>; declare namespace AuditLogEntityKey { function assumeExists(value: string): AuditLogEntityKey; function getValue(key: AuditLogEntityKey): string; function isValid(value: string): boolean; } /** * System-generated key for an audit log entry. */ type AuditLogKey = CamundaKey<'AuditLogKey'>; declare namespace AuditLogKey { function assumeExists(value: string): AuditLogKey; function getValue(key: AuditLogKey): string; function isValid(value: string): boolean; } /** * System-generated key for an authorization. */ type AuthorizationKey = CamundaKey<'AuthorizationKey'>; declare namespace AuthorizationKey { function assumeExists(value: string): AuthorizationKey; function getValue(key: AuthorizationKey): string; function isValid(value: string): boolean; } /** * System-generated key for an batch operation. */ type BatchOperationKey = CamundaKey<'BatchOperationKey'>; declare namespace BatchOperationKey { function assumeExists(value: string): BatchOperationKey; function getValue(key: BatchOperationKey): string; function isValid(value: string): boolean; } /** * An optional, user-defined string identifier that identifies the process instance * within the scope of a process definition (scoped by tenant). If provided and uniqueness * enforcement is enabled, the engine will reject creation if another root process instance * with the same business id is already active for the same process definition. * Note that any active child process instances with the same business id are not taken into account. * */ type BusinessId = CamundaKey<'BusinessId'>; declare namespace BusinessId { function assumeExists(value: string): BusinessId; function getValue(key: BusinessId): string; function isValid(value: string): boolean; } /** * System-generated key for a conditional evaluation. */ type ConditionalEvaluationKey = CamundaKey<'ConditionalEvaluationKey'>; declare namespace ConditionalEvaluationKey { function assumeExists(value: string): ConditionalEvaluationKey; function getValue(key: ConditionalEvaluationKey): string; function isValid(value: string): boolean; } /** * Id of a decision definition, from the model. Only ids of decision definitions that are deployed are useful. */ type DecisionDefinitionId = CamundaKey<'DecisionDefinitionId'>; declare namespace DecisionDefinitionId { function assumeExists(value: string): DecisionDefinitionId; function getValue(key: DecisionDefinitionId): string; function isValid(value: string): boolean; } /** * System-generated key for a decision definition. */ type DecisionDefinitionKey = CamundaKey<'DecisionDefinitionKey'>; declare namespace DecisionDefinitionKey { function assumeExists(value: string): DecisionDefinitionKey; function getValue(key: DecisionDefinitionKey): string; function isValid(value: string): boolean; } /** * System-generated identifier for a decision evaluation instance. It is composed of the * parent decision evaluation key and the 1-based index of the evaluated decision within * that evaluation, joined by a hyphen (format: `-`). * */ type DecisionEvaluationInstanceKey = CamundaKey<'DecisionEvaluationInstanceKey'>; declare namespace DecisionEvaluationInstanceKey { function assumeExists(value: string): DecisionEvaluationInstanceKey; function getValue(key: DecisionEvaluationInstanceKey): string; function isValid(value: string): boolean; } /** * System-generated key for a decision evaluation. */ type DecisionEvaluationKey = CamundaKey<'DecisionEvaluationKey'>; declare namespace DecisionEvaluationKey { function assumeExists(value: string): DecisionEvaluationKey; function getValue(key: DecisionEvaluationKey): string; function isValid(value: string): boolean; } /** * System-generated key for a deployed decision instance. */ type DecisionInstanceKey = CamundaKey<'DecisionInstanceKey'>; declare namespace DecisionInstanceKey { function assumeExists(value: string): DecisionInstanceKey; function getValue(key: DecisionInstanceKey): string; function isValid(value: string): boolean; } /** * System-generated key for a deployed decision requirements definition. */ type DecisionRequirementsKey = CamundaKey<'DecisionRequirementsKey'>; declare namespace DecisionRequirementsKey { function assumeExists(value: string): DecisionRequirementsKey; function getValue(key: DecisionRequirementsKey): string; function isValid(value: string): boolean; } /** * Key for a deployment. */ type DeploymentKey = CamundaKey<'DeploymentKey'>; declare namespace DeploymentKey { function assumeExists(value: string): DeploymentKey; function getValue(key: DeploymentKey): string; function isValid(value: string): boolean; } /** * Document Id that uniquely identifies a document. */ type DocumentId = CamundaKey<'DocumentId'>; declare namespace DocumentId { function assumeExists(value: string): DocumentId; function getValue(key: DocumentId): string; function isValid(value: string): boolean; } /** * The model-defined id of an element. */ type ElementId = CamundaKey<'ElementId'>; declare namespace ElementId { function assumeExists(value: string): ElementId; function getValue(key: ElementId): string; function isValid(value: string): boolean; } /** * System-generated key for a element instance. */ type ElementInstanceKey = CamundaKey<'ElementInstanceKey'>; declare namespace ElementInstanceKey { function assumeExists(value: string): ElementInstanceKey; function getValue(key: ElementInstanceKey): string; function isValid(value: string): boolean; } /** * The end cursor in a search query result set. */ type EndCursor = CamundaKey<'EndCursor'>; declare namespace EndCursor { function assumeExists(value: string): EndCursor; function getValue(key: EndCursor): string; function isValid(value: string): boolean; } /** * The user-defined id for the form */ type FormId = CamundaKey<'FormId'>; declare namespace FormId { function assumeExists(value: string): FormId; function getValue(key: FormId): string; function isValid(value: string): boolean; } /** * System-generated key for a deployed form. */ type FormKey = CamundaKey<'FormKey'>; declare namespace FormKey { function assumeExists(value: string): FormKey; function getValue(key: FormKey): string; function isValid(value: string): boolean; } /** * The user-defined id for the global listener */ type GlobalListenerId = CamundaKey<'GlobalListenerId'>; declare namespace GlobalListenerId { function assumeExists(value: string): GlobalListenerId; function getValue(key: GlobalListenerId): string; function isValid(value: string): boolean; } /** * System-generated key for a incident. */ type IncidentKey = CamundaKey<'IncidentKey'>; declare namespace IncidentKey { function assumeExists(value: string): IncidentKey; function getValue(key: IncidentKey): string; function isValid(value: string): boolean; } /** * System-generated key for a job. */ type JobKey = CamundaKey<'JobKey'>; declare namespace JobKey { function assumeExists(value: string): JobKey; function getValue(key: JobKey): string; function isValid(value: string): boolean; } /** * System-generated key for an message. */ type MessageKey = CamundaKey<'MessageKey'>; declare namespace MessageKey { function assumeExists(value: string): MessageKey; function getValue(key: MessageKey): string; function isValid(value: string): boolean; } /** * System-generated key for a message subscription. */ type MessageSubscriptionKey = CamundaKey<'MessageSubscriptionKey'>; declare namespace MessageSubscriptionKey { function assumeExists(value: string): MessageSubscriptionKey; function getValue(key: MessageSubscriptionKey): string; function isValid(value: string): boolean; } /** * Id of a process definition, from the model. Only ids of process definitions that are deployed are useful. */ type ProcessDefinitionId = CamundaKey<'ProcessDefinitionId'>; declare namespace ProcessDefinitionId { function assumeExists(value: string): ProcessDefinitionId; function getValue(key: ProcessDefinitionId): string; function isValid(value: string): boolean; } /** * System-generated key for a deployed process definition. */ type ProcessDefinitionKey = CamundaKey<'ProcessDefinitionKey'>; declare namespace ProcessDefinitionKey { function assumeExists(value: string): ProcessDefinitionKey; function getValue(key: ProcessDefinitionKey): string; function isValid(value: string): boolean; } /** * System-generated key for a process instance. */ type ProcessInstanceKey = CamundaKey<'ProcessInstanceKey'>; declare namespace ProcessInstanceKey { function assumeExists(value: string): ProcessInstanceKey; function getValue(key: ProcessInstanceKey): string; function isValid(value: string): boolean; } /** * System-generated key for an signal. */ type SignalKey = CamundaKey<'SignalKey'>; declare namespace SignalKey { function assumeExists(value: string): SignalKey; function getValue(key: SignalKey): string; function isValid(value: string): boolean; } /** * The start cursor in a search query result set. */ type StartCursor = CamundaKey<'StartCursor'>; declare namespace StartCursor { function assumeExists(value: string): StartCursor; function getValue(key: StartCursor): string; function isValid(value: string): boolean; } /** * A tag. Needs to start with a letter; then alphanumerics, `_`, `-`, `:`, or `.`; length ≤ 100. */ type Tag = CamundaKey<'Tag'>; declare namespace Tag { function fromString(value: string): Tag; function getValue(key: Tag): string; function isValid(value: string): boolean; } /** * The unique identifier of the tenant. */ type TenantId = CamundaKey<'TenantId'>; declare namespace TenantId { function assumeExists(value: string): TenantId; function getValue(key: TenantId): string; function isValid(value: string): boolean; } /** * The unique name of a user. */ type Username = CamundaKey<'Username'>; declare namespace Username { function assumeExists(value: string): Username; function getValue(key: Username): string; function isValid(value: string): boolean; } /** * System-generated key for a user task. */ type UserTaskKey = CamundaKey<'UserTaskKey'>; declare namespace UserTaskKey { function assumeExists(value: string): UserTaskKey; function getValue(key: UserTaskKey): string; function isValid(value: string): boolean; } /** * System-generated key for a variable. */ type VariableKey = CamundaKey<'VariableKey'>; declare namespace VariableKey { function assumeExists(value: string): VariableKey; function getValue(key: VariableKey): string; function isValid(value: string): boolean; } type Options = Options$1 & { /** * You can provide a client instance returned by `createClient()` instead of * individual options. This might be also useful if you want to implement a * custom client. */ client?: Client; /** * You can pass arbitrary values through the `meta` object. This can be * used to access values that aren't defined as part of the SDK function. */ meta?: Record; }; /** * Search audit logs * * Search for audit logs based on given criteria. */ declare const searchAuditLogs: (options?: Options) => RequestResult; /** * Get audit log * * Get an audit log entry by auditLogKey. */ declare const getAuditLog: (options: Options) => RequestResult; /** * Get current user * * Retrieves the current authenticated user. */ declare const getAuthentication: (options?: Options) => RequestResult; /** * Create authorization * * Create the authorization. */ declare const createAuthorization: (options: Options) => RequestResult; /** * Search authorizations * * Search for authorizations based on given criteria. */ declare const searchAuthorizations: (options?: Options) => RequestResult; /** * Delete authorization * * Deletes the authorization with the given key. */ declare const deleteAuthorization: (options: Options) => RequestResult; /** * Get authorization * * Get authorization by the given key. */ declare const getAuthorization: (options: Options) => RequestResult; /** * Update authorization * * Update the authorization with the given key. */ declare const updateAuthorization: (options: Options) => RequestResult; /** * Search batch operation items * * Search for batch operation items based on given criteria. */ declare const searchBatchOperationItems: (options?: Options) => RequestResult; /** * Search batch operations * * Search for batch operations based on given criteria. */ declare const searchBatchOperations: (options?: Options) => RequestResult; /** * Get batch operation * * Get batch operation by key. */ declare const getBatchOperation: (options: Options) => RequestResult; /** * Cancel Batch operation * * Cancels a running batch operation. * This is done asynchronously, the progress can be tracked using the batch operation status endpoint (/batch-operations/{batchOperationKey}). * */ declare const cancelBatchOperation: (options: Options) => RequestResult; /** * Resume Batch operation * * Resumes a suspended batch operation. * This is done asynchronously, the progress can be tracked using the batch operation status endpoint (/batch-operations/{batchOperationKey}). * */ declare const resumeBatchOperation: (options: Options) => RequestResult; /** * Suspend Batch operation * * Suspends a running batch operation. * This is done asynchronously, the progress can be tracked using the batch operation status endpoint (/batch-operations/{batchOperationKey}). * */ declare const suspendBatchOperation: (options: Options) => RequestResult; /** * Pin internal clock (alpha) * * Set a precise, static time for the Zeebe engine's internal clock. * When the clock is pinned, it remains at the specified time and does not advance. * To change the time, the clock must be pinned again with a new timestamp. * * This endpoint is an alpha feature and may be subject to change * in future releases. * */ declare const pinClock: (options: Options) => RequestResult; /** * Reset internal clock (alpha) * * Resets the Zeebe engine's internal clock to the current system time, enabling it to tick in real-time. * This operation is useful for returning the clock to * normal behavior after it has been pinned to a specific time. * * This endpoint is an alpha feature and may be subject to change * in future releases. * */ declare const resetClock: (options?: Options) => RequestResult; /** * Create a global-scoped cluster variable * * Create a global-scoped cluster variable. */ declare const createGlobalClusterVariable: (options: Options) => RequestResult; /** * Delete a global-scoped cluster variable * * Delete a global-scoped cluster variable. */ declare const deleteGlobalClusterVariable: (options: Options) => RequestResult; /** * Get a global-scoped cluster variable * * Get a global-scoped cluster variable. */ declare const getGlobalClusterVariable: (options: Options) => RequestResult; /** * Update a global-scoped cluster variable * * Updates the value of an existing global cluster variable. * The variable must exist, otherwise a 404 error is returned. * */ declare const updateGlobalClusterVariable: (options: Options) => RequestResult; /** * Search for cluster variables based on given criteria. By default, long variable values in the response are truncated. */ declare const searchClusterVariables: (options?: Options) => RequestResult; /** * Create a tenant-scoped cluster variable * * Create a new cluster variable for the given tenant. */ declare const createTenantClusterVariable: (options: Options) => RequestResult; /** * Delete a tenant-scoped cluster variable * * Delete a tenant-scoped cluster variable. */ declare const deleteTenantClusterVariable: (options: Options) => RequestResult; /** * Get a tenant-scoped cluster variable * * Get a tenant-scoped cluster variable. */ declare const getTenantClusterVariable: (options: Options) => RequestResult; /** * Update a tenant-scoped cluster variable * * Updates the value of an existing tenant-scoped cluster variable. * The variable must exist, otherwise a 404 error is returned. * */ declare const updateTenantClusterVariable: (options: Options) => RequestResult; /** * Evaluate root level conditional start events * * Evaluates root-level conditional start events for process definitions. * If the evaluation is successful, it will return the keys of all created process instances, along with their associated process definition key. * Multiple root-level conditional start events of the same process definition can trigger if their conditions evaluate to true. * */ declare const evaluateConditionals: (options: Options) => RequestResult; /** * Search correlated message subscriptions * * Search correlated message subscriptions based on given criteria. */ declare const searchCorrelatedMessageSubscriptions: (options?: Options) => RequestResult; /** * Evaluate decision * * Evaluates a decision. * You specify the decision to evaluate either by using its unique key (as returned by * DeployResource), or using the decision ID. When using the decision ID, the latest deployed * version of the decision is used. * */ declare const evaluateDecision: (options: Options) => RequestResult; /** * Search decision definitions * * Search for decision definitions based on given criteria. */ declare const searchDecisionDefinitions: (options?: Options) => RequestResult; /** * Get decision definition * * Returns a decision definition by key. */ declare const getDecisionDefinition: (options: Options) => RequestResult; /** * Get decision definition XML * * Returns decision definition as XML. */ declare const getDecisionDefinitionXml: (options: Options) => RequestResult; /** * Search decision instances * * Search for decision instances based on given criteria. */ declare const searchDecisionInstances: (options?: Options) => RequestResult; /** * Get decision instance * * Returns a decision instance. */ declare const getDecisionInstance: (options: Options) => RequestResult; /** * Delete decision instance * * Delete all associated decision evaluations based on provided key. */ declare const deleteDecisionInstance: (options: Options) => RequestResult; /** * Delete decision instances (batch) * * Delete multiple decision instances. This will delete the historic data from secondary storage. * This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}). * */ declare const deleteDecisionInstancesBatchOperation: (options: Options) => RequestResult; /** * Search decision requirements * * Search for decision requirements based on given criteria. */ declare const searchDecisionRequirements: (options?: Options) => RequestResult; /** * Get decision requirements * * Returns Decision Requirements as JSON. */ declare const getDecisionRequirements: (options: Options) => RequestResult; /** * Get decision requirements XML * * Returns decision requirements as XML. */ declare const getDecisionRequirementsXml: (options: Options) => RequestResult; /** * Deploy resources * * Deploys one or more resources (e.g. processes, decision models, or forms). * This is an atomic call, i.e. either all resources are deployed or none of them are. * */ declare const createDeployment: (options: Options) => RequestResult; /** * Upload document * * Upload a document to the Camunda 8 cluster. * * Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production) * */ declare const createDocument: (options: Options) => RequestResult; /** * Upload multiple documents * * Upload multiple documents to the Camunda 8 cluster. * * The caller must provide a file name for each document, which will be used in case of a multi-status response * to identify which documents failed to upload. The file name can be provided in the `Content-Disposition` header * of the file part or in the `fileName` field of the metadata. You can add a parallel array of metadata objects. These * are matched with the files based on index, and must have the same length as the files array. * To pass homogenous metadata for all files, spread the metadata over the metadata array. * A filename value provided explicitly via the metadata array in the request overrides the `Content-Disposition` header * of the file part. * * In case of a multi-status response, the response body will contain a list of `DocumentBatchProblemDetail` objects, * each of which contains the file name of the document that failed to upload and the reason for the failure. * The client can choose to retry the whole batch or individual documents based on the response. * * Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production) * */ declare const createDocuments: (options: Options) => RequestResult; /** * Delete document * * Delete a document from the Camunda 8 cluster. * * Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production) * */ declare const deleteDocument: (options: Options) => RequestResult; /** * Download document * * Download a document from the Camunda 8 cluster. * * Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production) * */ declare const getDocument: (options: Options) => RequestResult; /** * Create document link * * Create a link to a document in the Camunda 8 cluster. * * Note that this is currently supported for document stores of type: AWS, GCP * */ declare const createDocumentLink: (options: Options) => RequestResult; /** * Activate activities within an ad-hoc sub-process * * Activates selected activities within an ad-hoc sub-process identified by element ID. * The provided element IDs must exist within the ad-hoc sub-process instance identified by the * provided adHocSubProcessInstanceKey. * */ declare const activateAdHocSubProcessActivities: (options: Options) => RequestResult; /** * Search element instances * * Search for element instances based on given criteria. */ declare const searchElementInstances: (options?: Options) => RequestResult; /** * Get element instance * * Returns element instance as JSON. */ declare const getElementInstance: (options: Options) => RequestResult; /** * Search for incidents of a specific element instance * * Search for incidents caused by the specified element instance, including incidents of any child instances created from this element instance. * * Although the `elementInstanceKey` is provided as a path parameter to indicate the root element instance, * you may also include an `elementInstanceKey` within the filter object to narrow results to specific * child element instances. This is useful, for example, if you want to isolate incidents associated with * nested or subordinate elements within the given element instance while excluding incidents directly tied * to the root element itself. * */ declare const searchElementInstanceIncidents: (options: Options) => RequestResult; /** * Update element instance variables * * Updates all the variables of a particular scope (for example, process instance, element instance) with the given variable data. * Specify the element instance in the `elementInstanceKey` parameter. * Variable updates can be delayed by listener-related processing; if processing exceeds the * request timeout, this endpoint can return 504. Other gateway timeout causes are also * possible. Retry with backoff and inspect listener worker availability and logs when this * repeats. * */ declare const createElementInstanceVariables: (options: Options) => RequestResult; /** * Evaluate an expression * * Evaluates a FEEL expression and returns the result. Supports references to tenant scoped cluster variables when a tenant ID is provided. */ declare const evaluateExpression: (options: Options) => RequestResult; /** * Create global user task listener * * Create a new global user task listener. */ declare const createGlobalTaskListener: (options: Options) => RequestResult; /** * Delete global user task listener * * Deletes a global user task listener. */ declare const deleteGlobalTaskListener: (options: Options) => RequestResult; /** * Get global user task listener * * Get a global user task listener by its id. */ declare const getGlobalTaskListener: (options: Options) => RequestResult; /** * Update global user task listener * * Updates a global user task listener. */ declare const updateGlobalTaskListener: (options: Options) => RequestResult; /** * Search global user task listeners * * Search for global user task listeners based on given criteria. */ declare const searchGlobalTaskListeners: (options?: Options) => RequestResult; /** * Create group * * Create a new group. */ declare const createGroup: (options?: Options) => RequestResult; /** * Search groups * * Search for groups based on given criteria. */ declare const searchGroups: (options?: Options) => RequestResult; /** * Delete group * * Deletes the group with the given ID. */ declare const deleteGroup: (options: Options) => RequestResult; /** * Get group * * Get a group by its ID. */ declare const getGroup: (options: Options) => RequestResult; /** * Update group * * Update a group with the given ID. */ declare const updateGroup: (options: Options) => RequestResult; /** * Search group clients * * Search clients assigned to a group. */ declare const searchClientsForGroup: (options: Options) => RequestResult; /** * Unassign a client from a group * * Unassigns a client from a group. * The client is removed as a group member, with associated authorizations, roles, and tenant assignments no longer applied. * */ declare const unassignClientFromGroup: (options: Options) => RequestResult; /** * Assign a client to a group * * Assigns a client to a group, making it a member of the group. * Members of the group inherit the group authorizations, roles, and tenant assignments. * */ declare const assignClientToGroup: (options: Options) => RequestResult; /** * Search group mapping rules * * Search mapping rules assigned to a group. */ declare const searchMappingRulesForGroup: (options: Options) => RequestResult; /** * Unassign a mapping rule from a group * * Unassigns a mapping rule from a group. */ declare const unassignMappingRuleFromGroup: (options: Options) => RequestResult; /** * Assign a mapping rule to a group * * Assigns a mapping rule to a group. */ declare const assignMappingRuleToGroup: (options: Options) => RequestResult; /** * Search group roles * * Search roles assigned to a group. */ declare const searchRolesForGroup: (options: Options) => RequestResult; /** * Search group users * * Search users assigned to a group. */ declare const searchUsersForGroup: (options: Options) => RequestResult; /** * Unassign a user from a group * * Unassigns a user from a group. * The user is removed as a group member, with associated authorizations, roles, and tenant assignments no longer applied. * */ declare const unassignUserFromGroup: (options: Options) => RequestResult; /** * Assign a user to a group * * Assigns a user to a group, making the user a member of the group. * Group members inherit the group authorizations, roles, and tenant assignments. * */ declare const assignUserToGroup: (options: Options) => RequestResult; /** * Search incidents * * Search for incidents based on given criteria. * */ declare const searchIncidents: (options?: Options) => RequestResult; /** * Get incident * * Returns incident as JSON. * */ declare const getIncident: (options: Options) => RequestResult; /** * Resolve incident * * Marks the incident as resolved; most likely a call to Update job will be necessary * to reset the job's retries, followed by this call. * */ declare const resolveIncident: (options: Options) => RequestResult; /** * Get process instance statistics by definition * * Returns statistics for active process instances with incidents, grouped by process * definition. The result set is scoped to a specific incident error hash code, which must be * provided as a filter in the request body. * */ declare const getProcessInstanceStatisticsByDefinition: (options: Options) => RequestResult; /** * Get process instance statistics by error * * Returns statistics for active process instances that currently have active incidents, * grouped by incident error hash code. * */ declare const getProcessInstanceStatisticsByError: (options?: Options) => RequestResult; /** * Activate jobs * * Iterate through all known partitions and activate jobs up to the requested maximum. * */ declare const activateJobs: (options: Options) => RequestResult; /** * Search jobs * * Search for jobs based on given criteria. */ declare const searchJobs: (options?: Options) => RequestResult; /** * Update job * * Update a job with the given key. */ declare const updateJob: (options: Options) => RequestResult; /** * Complete job * * Complete a job with the given payload, which allows completing the associated service task. * */ declare const completeJob: (options: Options) => RequestResult; /** * Throw error for job * * Reports a business error (i.e. non-technical) that occurs while processing a job. * */ declare const throwJobError: (options: Options) => RequestResult; /** * Fail job * * Mark the job as failed. * */ declare const failJob: (options: Options) => RequestResult; /** * Global job statistics * * Returns global aggregated counts for jobs. Filter by the creation time window (required) and optionally by jobType. * */ declare const getGlobalJobStatistics: (options: Options) => RequestResult; /** * Get job statistics by type * * Get statistics about jobs, grouped by job type. * */ declare const getJobTypeStatistics: (options: Options) => RequestResult; /** * Get job statistics by worker * * Get statistics about jobs, grouped by worker, for a given job type. * */ declare const getJobWorkerStatistics: (options: Options) => RequestResult; /** * Get time-series metrics for a job type * * Returns a list of time-bucketed metrics ordered ascending by time. * The `from` and `to` fields select the time window of interest. * Each item in the response corresponds to one time bucket of the requested resolution. * */ declare const getJobTimeSeriesStatistics: (options: Options) => RequestResult; /** * Get error metrics for a job type * * Returns aggregated metrics per error for the given jobType. * */ declare const getJobErrorStatistics: (options: Options) => RequestResult; /** * Get license status * * Obtains the status of the current Camunda license. */ declare const getLicense: (options?: Options) => RequestResult; /** * Create mapping rule * * Create a new mapping rule * */ declare const createMappingRule: (options?: Options) => RequestResult; /** * Search mapping rules * * Search for mapping rules based on given criteria. * */ declare const searchMappingRule: (options?: Options) => RequestResult; /** * Delete a mapping rule * * Deletes the mapping rule with the given ID. * */ declare const deleteMappingRule: (options: Options) => RequestResult; /** * Get a mapping rule * * Gets the mapping rule with the given ID. * */ declare const getMappingRule: (options: Options) => RequestResult; /** * Update mapping rule * * Update a mapping rule. * */ declare const updateMappingRule: (options: Options) => RequestResult; /** * Search message subscriptions * * Search for message subscriptions based on given criteria. */ declare const searchMessageSubscriptions: (options?: Options) => RequestResult; /** * Correlate message * * Publishes a message and correlates it to a subscription. * If correlation is successful it will return the first process instance key the message correlated with. * The message is not buffered. * Use the publish message endpoint to send messages that can be buffered. * */ declare const correlateMessage: (options: Options) => RequestResult; /** * Publish message * * Publishes a single message. * Messages are published to specific partitions computed from their correlation keys. * Messages can be buffered. * The endpoint does not wait for a correlation result. * Use the message correlation endpoint for such use cases. * */ declare const publishMessage: (options: Options) => RequestResult; /** * Search process definitions * * Search for process definitions based on given criteria. */ declare const searchProcessDefinitions: (options?: Options) => RequestResult; /** * Get message subscription statistics * * Get message subscription statistics, grouped by process definition. * */ declare const getProcessDefinitionMessageSubscriptionStatistics: (options?: Options) => RequestResult; /** * Get process instance statistics * * Get statistics about process instances, grouped by process definition and tenant. * */ declare const getProcessDefinitionInstanceStatistics: (options?: Options) => RequestResult; /** * Get process definition * * Returns process definition as JSON. */ declare const getProcessDefinition: (options: Options) => RequestResult; /** * Get process start form * * Get the start form of a process. * Note that this endpoint will only return linked forms. This endpoint does not support embedded forms. * */ declare const getStartProcessForm: (options: Options) => RequestResult; /** * Get process definition statistics * * Get statistics about elements in currently running process instances by process definition key and search filter. */ declare const getProcessDefinitionStatistics: (options: Options) => RequestResult; /** * Get process definition XML * * Returns process definition as XML. */ declare const getProcessDefinitionXml: (options: Options) => RequestResult; /** * Get process instance statistics by version * * Get statistics about process instances, grouped by version for a given process definition. * The process definition ID must be provided as a required field in the request body filter. * */ declare const getProcessDefinitionInstanceVersionStatistics: (options: Options) => RequestResult; /** * Create process instance * * Creates and starts an instance of the specified process. * The process definition to use to create the instance can be specified either using its unique key * (as returned by Deploy resources), or using the BPMN process id and a version. * * Waits for the completion of the process instance before returning a result * when awaitCompletion is enabled. * */ declare const createProcessInstance: (options: Options) => RequestResult; /** * Cancel process instances (batch) * * Cancels multiple running process instances. * Since only ACTIVE root instances can be cancelled, any given filters for state and * parentProcessInstanceKey are ignored and overridden during this batch operation. * This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}). * */ declare const cancelProcessInstancesBatchOperation: (options: Options) => RequestResult; /** * Delete process instances (batch) * * Delete multiple process instances. This will delete the historic data from secondary storage. * Only process instances in a final state (COMPLETED or TERMINATED) can be deleted. * This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}). * */ declare const deleteProcessInstancesBatchOperation: (options: Options) => RequestResult; /** * Resolve related incidents (batch) * * Resolves multiple instances of process instances. * Since only process instances with ACTIVE state can have unresolved incidents, any given * filters for state are ignored and overridden during this batch operation. * This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}). * */ declare const resolveIncidentsBatchOperation: (options?: Options) => RequestResult; /** * Migrate process instances (batch) * * Migrate multiple process instances. * Since only process instances with ACTIVE state can be migrated, any given * filters for state are ignored and overridden during this batch operation. * This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}). * */ declare const migrateProcessInstancesBatchOperation: (options: Options) => RequestResult; /** * Modify process instances (batch) * * Modify multiple process instances. * Since only process instances with ACTIVE state can be modified, any given * filters for state are ignored and overridden during this batch operation. * In contrast to single modification operation, it is not possible to add variable instructions or modify by element key. * It is only possible to use the element id of the source and target. * This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}). * */ declare const modifyProcessInstancesBatchOperation: (options: Options) => RequestResult; /** * Search process instances * * Search for process instances based on given criteria. */ declare const searchProcessInstances: (options?: Options) => RequestResult; /** * Get process instance * * Get the process instance by the process instance key. */ declare const getProcessInstance: (options: Options) => RequestResult; /** * Get call hierarchy * * Returns the call hierarchy for a given process instance, showing its ancestry up to the root instance. */ declare const getProcessInstanceCallHierarchy: (options: Options) => RequestResult; /** * Cancel process instance * * 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. Cancellation can wait on listener-related processing; when that processing does not complete in time, this endpoint can return 504. Other gateway timeout causes are also possible. Retry with backoff and inspect listener worker availability and logs when this repeats. * */ declare const cancelProcessInstance: (options: Options) => RequestResult; /** * Delete process instance * * Deletes a process instance. Only instances that are completed or terminated can be deleted. */ declare const deleteProcessInstance: (options: Options) => RequestResult; /** * Resolve related incidents * * Creates a batch operation to resolve multiple incidents of a process instance. */ declare const resolveProcessInstanceIncidents: (options: Options) => RequestResult; /** * Search related incidents * * Search for incidents caused by the process instance or any of its called process or decision instances. * * Although the `processInstanceKey` is provided as a path parameter to indicate the root process instance, * you may also include a `processInstanceKey` within the filter object to narrow results to specific * child process instances. This is useful, for example, if you want to isolate incidents associated with * subprocesses or called processes under the root instance while excluding incidents directly tied to the root. * */ declare const searchProcessInstanceIncidents: (options: Options) => RequestResult; /** * Migrate process instance * * Migrates a process instance to a new process definition. * This request can contain multiple mapping instructions to define mapping between the active * process instance's elements and target process definition elements. * * Use this to upgrade a process instance to a new version of a process or to * a different process definition, e.g. to keep your running instances up-to-date with the * latest process improvements. * */ declare const migrateProcessInstance: (options: Options) => RequestResult; /** * Modify process instance * * Modifies a running process instance. * This request can contain multiple instructions to activate an element of the process or * to terminate an active instance of an element. * * Use this to repair a process instance that is stuck on an element or took an unintended path. * For example, because an external system is not available or doesn't respond as expected. * */ declare const modifyProcessInstance: (options: Options) => RequestResult; /** * Get sequence flows * * Get sequence flows taken by the process instance. */ declare const getProcessInstanceSequenceFlows: (options: Options) => RequestResult; /** * Get element instance statistics * * Get statistics about elements by the process instance key. */ declare const getProcessInstanceStatistics: (options: Options) => RequestResult; /** * Get resource * * Returns a deployed resource. * :::info * Currently, this endpoint only supports RPA resources. * ::: * */ declare const getResource: (options: Options) => RequestResult; /** * Get resource content * * Returns the content of a deployed resource. * :::info * Currently, this endpoint only supports RPA resources. * ::: * */ declare const getResourceContent: (options: Options) => RequestResult; /** * Delete resource * * Deletes a deployed resource. This can be a process definition, decision requirements * definition, or form definition deployed using the deploy resources endpoint. Specify the * resource you want to delete in the `resourceKey` parameter. * * Once a resource has been deleted it cannot be recovered. If the resource needs to be * available again, a new deployment of the resource is required. * * By default, only the resource itself is deleted from the runtime state. To also delete the * historic data associated with a resource, set the `deleteHistory` flag in the request body * to `true`. The historic data is deleted asynchronously via a batch operation. The details of * the created batch operation are included in the response. Note that history deletion is only * supported for process resources; for other resource types this flag is ignored and no history * will be deleted. */ declare const deleteResource: (options: Options) => RequestResult; /** * Create role * * Create a new role. */ declare const createRole: (options?: Options) => RequestResult; /** * Search roles * * Search for roles based on given criteria. */ declare const searchRoles: (options?: Options) => RequestResult; /** * Delete role * * Deletes the role with the given ID. */ declare const deleteRole: (options: Options) => RequestResult; /** * Get role * * Get a role by its ID. */ declare const getRole: (options: Options) => RequestResult; /** * Update role * * Update a role with the given ID. */ declare const updateRole: (options: Options) => RequestResult; /** * Search role clients * * Search clients with assigned role. */ declare const searchClientsForRole: (options: Options) => RequestResult; /** * Unassign a role from a client * * Unassigns the specified role from the client. The client will no longer inherit the authorizations associated with this role. */ declare const unassignRoleFromClient: (options: Options) => RequestResult; /** * Assign a role to a client * * Assigns the specified role to the client. The client will inherit the authorizations associated with this role. */ declare const assignRoleToClient: (options: Options) => RequestResult; /** * Search role groups * * Search groups with assigned role. */ declare const searchGroupsForRole: (options: Options) => RequestResult; /** * Unassign a role from a group * * Unassigns the specified role from the group. All group members (user or client) no longer inherit the authorizations associated with this role. */ declare const unassignRoleFromGroup: (options: Options) => RequestResult; /** * Assign a role to a group * * Assigns the specified role to the group. Every member of the group (user or client) will inherit the authorizations associated with this role. */ declare const assignRoleToGroup: (options: Options) => RequestResult; /** * Search role mapping rules * * Search mapping rules with assigned role. */ declare const searchMappingRulesForRole: (options: Options) => RequestResult; /** * Unassign a role from a mapping rule * * Unassigns a role from a mapping rule. */ declare const unassignRoleFromMappingRule: (options: Options) => RequestResult; /** * Assign a role to a mapping rule * * Assigns a role to a mapping rule. */ declare const assignRoleToMappingRule: (options: Options) => RequestResult; /** * Search role users * * Search users with assigned role. */ declare const searchUsersForRole: (options: Options) => RequestResult; /** * Unassign a role from a user * * Unassigns a role from a user. The user will no longer inherit the authorizations associated with this role. */ declare const unassignRoleFromUser: (options: Options) => RequestResult; /** * Assign a role to a user * * Assigns the specified role to the user. The user will inherit the authorizations associated with this role. */ declare const assignRoleToUser: (options: Options) => RequestResult; /** * Create admin user * * 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. */ declare const createAdminUser: (options: Options) => RequestResult; /** * Broadcast signal * * Broadcasts a signal. */ declare const broadcastSignal: (options: Options) => RequestResult; /** * Get cluster status * * Checks the health status of the cluster by verifying if there's at least one partition with a healthy leader. */ declare const getStatus: (options?: Options) => RequestResult; /** * Get usage metrics * * Retrieve the usage metrics based on given criteria. */ declare const getUsageMetrics: (options: Options) => RequestResult; /** * System configuration (alpha) * * Returns the current system configuration. The response is an envelope * that groups settings by feature area. * * This endpoint is an alpha feature and may be subject to change * in future releases. * */ declare const getSystemConfiguration: (options?: Options) => RequestResult; /** * Create tenant * * Creates a new tenant. */ declare const createTenant: (options: Options) => RequestResult; /** * Search tenants * * Retrieves a filtered and sorted list of tenants. */ declare const searchTenants: (options?: Options) => RequestResult; /** * Delete tenant * * Deletes an existing tenant. */ declare const deleteTenant: (options: Options) => RequestResult; /** * Get tenant * * Retrieves a single tenant by tenant ID. */ declare const getTenant: (options: Options) => RequestResult; /** * Update tenant * * Updates an existing tenant. */ declare const updateTenant: (options: Options) => RequestResult; /** * Search clients for tenant * * Retrieves a filtered and sorted list of clients for a specified tenant. */ declare const searchClientsForTenant: (options: Options) => RequestResult; /** * Unassign a client from a tenant * * Unassigns the client from the specified tenant. * The client can no longer access tenant data. * */ declare const unassignClientFromTenant: (options: Options) => RequestResult; /** * Assign a client to a tenant * * Assign the client to the specified tenant. * The client can then access tenant data and perform authorized actions. * */ declare const assignClientToTenant: (options: Options) => RequestResult; /** * Search groups for tenant * * Retrieves a filtered and sorted list of groups for a specified tenant. */ declare const searchGroupIdsForTenant: (options: Options) => RequestResult; /** * Unassign a group from a tenant * * Unassigns a group from a specified tenant. * Members of the group (users, clients) will no longer have access to the tenant's data - except they are assigned directly to the tenant. * */ declare const unassignGroupFromTenant: (options: Options) => RequestResult; /** * Assign a group to a tenant * * Assigns a group to a specified tenant. * Group members (users, clients) can then access tenant data and perform authorized actions. * */ declare const assignGroupToTenant: (options: Options) => RequestResult; /** * Search mapping rules for tenant * * Retrieves a filtered and sorted list of MappingRules for a specified tenant. */ declare const searchMappingRulesForTenant: (options: Options) => RequestResult; /** * Unassign a mapping rule from a tenant * * Unassigns a single mapping rule from a specified tenant without deleting the rule. */ declare const unassignMappingRuleFromTenant: (options: Options) => RequestResult; /** * Assign a mapping rule to a tenant * * Assign a single mapping rule to a specified tenant. */ declare const assignMappingRuleToTenant: (options: Options) => RequestResult; /** * Search roles for tenant * * Retrieves a filtered and sorted list of roles for a specified tenant. */ declare const searchRolesForTenant: (options: Options) => RequestResult; /** * Unassign a role from a tenant * * Unassigns a role from a specified tenant. * Users, Clients or Groups, that have the role assigned, will no longer have access to the * tenant's data - unless they are assigned directly to the tenant. * */ declare const unassignRoleFromTenant: (options: Options) => RequestResult; /** * Assign a role to a tenant * * Assigns a role to a specified tenant. * 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. * */ declare const assignRoleToTenant: (options: Options) => RequestResult; /** * Search users for tenant * * Retrieves a filtered and sorted list of users for a specified tenant. */ declare const searchUsersForTenant: (options: Options) => RequestResult; /** * Unassign a user from a tenant * * Unassigns the user from the specified tenant. * The user can no longer access tenant data. * */ declare const unassignUserFromTenant: (options: Options) => RequestResult; /** * Assign a user to a tenant * * Assign a single user to a specified tenant. The user can then access tenant data and perform authorized actions. */ declare const assignUserToTenant: (options: Options) => RequestResult; /** * Get cluster topology * * Obtains the current topology of the cluster the gateway is part of. */ declare const getTopology: (options?: Options) => RequestResult; /** * Create user * * Create a new user. */ declare const createUser: (options: Options) => RequestResult; /** * Search users * * Search for users based on given criteria. */ declare const searchUsers: (options?: Options) => RequestResult; /** * Delete user * * Deletes a user. */ declare const deleteUser: (options: Options) => RequestResult; /** * Get user * * Get a user by its username. */ declare const getUser: (options: Options) => RequestResult; /** * Update user * * Updates a user. */ declare const updateUser: (options: Options) => RequestResult; /** * Search user tasks * * Search for user tasks based on given criteria. */ declare const searchUserTasks: (options?: Options) => RequestResult; /** * Get user task * * Get the user task by the user task key. */ declare const getUserTask: (options: Options) => RequestResult; /** * Update user task * * Update a user task with the given key. Updates wait for blocking task listeners on this lifecycle transition. If listener processing is delayed beyond the request timeout, this endpoint can return 504. Other gateway timeout causes are also possible. Retry with backoff and inspect listener worker availability and logs when this repeats. * */ declare const updateUserTask: (options: Options) => RequestResult; /** * Unassign user task * * Removes the assignee of a task with the given key. Unassignment waits for blocking task listeners on this lifecycle transition. If listener processing is delayed beyond the request timeout, this endpoint can return 504. Other gateway timeout causes are also possible. Retry with backoff and inspect listener worker availability and logs when this repeats. * */ declare const unassignUserTask: (options: Options) => RequestResult; /** * Assign user task * * Assigns a user task with the given key to the given assignee. Assignment waits for blocking task listeners on this lifecycle transition. If listener processing is delayed beyond the request timeout, this endpoint can return 504. Other gateway timeout causes are also possible. Retry with backoff and inspect listener worker availability and logs when this repeats. * */ declare const assignUserTask: (options: Options) => RequestResult; /** * Search user task audit logs * * Search for user task audit logs based on given criteria. */ declare const searchUserTaskAuditLogs: (options: Options) => RequestResult; /** * Complete user task * * Completes a user task with the given key. Completion waits for blocking task listeners on this lifecycle transition. If listener processing is delayed beyond the request timeout, this endpoint can return 504. Other gateway timeout causes are also possible. Retry with backoff and inspect listener worker availability and logs when this repeats. * */ declare const completeUserTask: (options: Options) => RequestResult; /** * Search user task effective variables * * Search for the effective variables of a user task. This endpoint returns deduplicated * variables where each variable name appears at most once. When the same variable name exists * at multiple scope levels in the scope hierarchy, the value from the innermost scope (closest * to the user task) takes precedence. This is useful for retrieving the actual runtime state * of variables as seen by the user task. By default, long variable values in the response are * truncated. * */ declare const searchUserTaskEffectiveVariables: (options: Options) => RequestResult; /** * Get user task form * * Get the form of a user task. * Note that this endpoint will only return linked forms. This endpoint does not support embedded forms. * */ declare const getUserTaskForm: (options: Options) => RequestResult; /** * Search user task variables * * Search for user task variables based on given criteria. This endpoint returns all variable * documents visible from the user task's scope, including variables from parent scopes in the * scope hierarchy. If the same variable name exists at multiple scope levels, each scope's * variable is returned as a separate result. Use the * `/user-tasks/{userTaskKey}/effective-variables/search` endpoint to get deduplicated variables * where the innermost scope takes precedence. By default, long variable values in the response * are truncated. * */ declare const searchUserTaskVariables: (options: Options) => RequestResult; /** * Search variables * * Search for variables based on given criteria. * * This endpoint returns variables that exist directly at the specified scopes - it does not * include variables from parent scopes that would be visible through the scope hierarchy. * * Variables can be process-level (scoped to the process instance) or local (scoped to specific * BPMN elements like tasks, subprocesses, etc.). * * By default, long variable values in the response are truncated. */ declare const searchVariables: (options?: Options) => RequestResult; /** * Get variable * * Get a variable by its key. * * This endpoint returns both process-level and local (element-scoped) variables. * The variable's scopeKey indicates whether it's a process-level variable or scoped to a * specific element instance. */ declare const getVariable: (options: Options) => RequestResult; /** Manages eventual consistency for a given operation */ interface ConsistencyOptions { waitUpToMs: number; pollIntervalMs?: number; predicate?: (result: T) => boolean | Promise; onAttempt?: (info: { attempt: number; elapsedMs: number; remainingMs: number; status?: number; predicateResult?: boolean; nextDelayMs?: number; }) => void; onComplete?: (info: { attempts: number; elapsedMs: number; }) => void; abortSignal?: AbortSignal; /** When true, log every 200 attempt result body (raw response) before predicate evaluation */ trace?: boolean; } interface HttpRetryPolicy { maxAttempts: number; baseDelayMs: number; maxDelayMs: number; } /** Per-call options for individual SDK method invocations. */ interface OperationOptions { /** Override retry behaviour for this call. * - Pass `false` to disable retry entirely (single attempt). * - Pass a partial policy to override specific fields (merged with global config). */ retry?: Partial | false; } type ActivatedJobResult = ActivateJobsResponses[200]['jobs'][number]; type JobErrorRequest = ThrowJobErrorData['body']; /** Enriched job type with convenience methods. */ interface EnrichedActivatedJob extends ActivatedJobResult { complete(variables?: { [k: string]: any; }, result?: JobResult): Promise; fail(body: any): Promise; error(error: JobErrorRequest): Promise; cancelWorkflow(): Promise; ignore(): Promise; /** * Extend the timeout for the job by setting a new timeout */ modifyJobTimeout: ({ newTimeoutMs }: { newTimeoutMs: number; }) => Promise; modifyRetries: ({ retries }: { retries: number; }) => Promise; log: ReturnType; /** Set true once any acknowledgement method is invoked. */ acknowledged?: boolean; } /** Unique receipt symbol returned by job action methods. */ declare const JobActionReceipt: "JOB_ACTION_RECEIPT"; type JobActionReceipt = typeof JobActionReceipt; interface JobWorkerConfig { /** Zod schema for variables in the activated job */ inputSchema?: In; /** Zod schema for variables in the complete command */ outputSchema?: Out; /** Zod schema for custom headers in the activated job */ customHeadersSchema?: Headers; /** Backoff between polls - default 1ms */ pollIntervalMs?: number; jobHandler: (job: Job) => Promise | JobActionReceipt; /** Immediately start polling for work - default `true` */ autoStart?: boolean; /** Concurrency limit — default `10`. Overridden by CAMUNDA_WORKER_MAX_CONCURRENT_JOBS env var. */ maxParallelJobs?: number; /** * The request will be completed when at least one job is activated or after the requestTimeout. * If the requestTimeout = 0, the request will be completed after a default configured timeout in the broker. * To immediately complete the request when no job is activated set the requestTimeout to a negative value * */ pollTimeoutMs?: number; /** Job activation timeout in ms — default `60000`. Overridden by CAMUNDA_WORKER_TIMEOUT env var. */ jobTimeoutMs?: number; /** Zeebe job type */ jobType: string; /** Optional list of variable names to fetch during activation */ fetchVariables?: In extends z.ZodTypeAny ? Array, string>> : string[]; /** @deprecated Not used; pacing handled by long polling + client backpressure. Present only for migration compatibility. */ maxBackoffTimeMs?: number; /** Optional explicit name */ workerName?: string; /** * Maximum random delay (in seconds) before the worker starts polling. * When multiple application instances restart simultaneously, this spreads out * initial activation requests to avoid saturating the server. * `0` (the default) means no delay. */ startupJitterMaxSeconds?: number; /** * Validate any provided input, output, customheader schema * default: false **/ validateSchemas?: boolean; } type InferOrUnknown = T extends z.ZodTypeAny ? z.infer : Record; type Job = EnrichedActivatedJob & { variables: InferOrUnknown; customHeaders: InferOrUnknown; }; declare class JobWorker { private _client; private _cfg; private _maxParallelJobs; private _jobTimeoutMs; private _name; private _activeJobs; private _stopped; private _pollTimer; private _inFlightActivation; private _log; constructor(client: CamundaClient, cfg: JobWorkerConfig); get name(): string; get activeJobs(): number; get stopped(): boolean; start(): void; stop(): void; /** * Gracefully stop the worker: prevent new polls, allow any in-flight activation to finish * without cancellation, and wait for currently active jobs to drain (be acknowledged) up to waitUpToMs. * If timeout is reached, falls back to hard stop logic (cancels activation if still pending). */ stopGracefully(opts?: { waitUpToMs?: number; checkIntervalMs?: number; }): Promise<{ remainingJobs: number; timedOut: boolean; }>; private _scheduleNext; private _poll; private _handleJob; private _failValidation; private _decrementOnce; } interface PoolWorker { worker: node_worker_threads.Worker; busy: boolean; ready: boolean; /** The taskId currently being processed by this worker (if busy). */ currentTaskId?: string; } declare class ThreadPool { private _pool; private _pending; private _node; private _log; private _client; private _ready; private _terminated; private _entryPath; private _Worker; private _onThreadReady?; constructor(client: CamundaClient, size?: number); /** Resolves when all threads have been spawned and signalled ready. */ get ready(): Promise; /** Total number of threads in the pool. */ get size(): number; /** Number of threads currently processing a job. */ get busyCount(): number; /** Number of threads that are ready and idle. */ get idleCount(): number; /** Register a callback invoked whenever a thread becomes ready or idle. */ set onThreadReady(cb: (() => void) | undefined); /** Find the first ready & idle thread. */ getIdleWorker(): PoolWorker | undefined; /** * Dispatch a serialized job to a specific idle worker. * The caller is responsible for checking idleness first. */ dispatch(pw: PoolWorker, jobData: Record, handlerModule: string, callbacks: { onComplete: (completionAction?: { method: string; args: unknown[]; }) => void; onError: (err: Error) => void; }): Promise; /** Terminate all threads and reject any in-flight tasks. */ terminate(): void; /** Reject the pending task for a worker that errored/exited and reset its state. */ private _rejectWorkerTask; /** Replace a dead worker in the pool with a freshly spawned one. */ private _respawn; /** Create a single worker thread and wire up its event handlers. */ private _spawnWorker; private _init; } /** * The job object received by a threaded handler. * Same shape as EnrichedActivatedJob but without the logger (not available across threads). */ type ThreadedJob = Omit; /** * Handler function signature for threaded job workers. * * Import this type in your handler module for full intellisense on `job` and `client`: * * ```ts * import type { ThreadedJobHandler } from '@camunda8/orchestration-cluster-api'; * * const handler: ThreadedJobHandler = async (job, client) => { * // full intellisense for job.variables, job.complete(), client.publishMessage(), etc. * return job.complete({ result: 'done' }); * }; * export default handler; * ``` */ type ThreadedJobHandler = (job: ThreadedJob, client: CamundaClient) => Promise | JobActionReceipt; /** * Configuration for a threaded job worker. * Same as JobWorkerConfig but replaces `jobHandler` with `handlerModule`. */ interface ThreadedJobWorkerConfig { /** Absolute or relative path to a JS/TS module that exports a default handler function. * The function signature must be: `(job, client) => Promise` */ handlerModule: string; /** Zod schema for variables in the activated job */ inputSchema?: In; /** Zod schema for variables in the complete command */ outputSchema?: Out; /** Zod schema for custom headers in the activated job */ customHeadersSchema?: Headers; /** Backoff between polls - default 1ms */ pollIntervalMs?: number; /** Immediately start polling for work - default `true` */ autoStart?: boolean; /** Concurrency limit — default `10`. Overridden by CAMUNDA_WORKER_MAX_CONCURRENT_JOBS env var. */ maxParallelJobs?: number; /** * The request will be completed when at least one job is activated or after the requestTimeout. * If the requestTimeout = 0, the request will be completed after a default configured timeout in the broker. * To immediately complete the request when no job is activated set the requestTimeout to a negative value */ pollTimeoutMs?: number; /** Job activation timeout in ms — default `60000`. Overridden by CAMUNDA_WORKER_TIMEOUT env var. */ jobTimeoutMs?: number; /** Zeebe job type */ jobType: string; /** Optional list of variable names to fetch during activation */ fetchVariables?: In extends z.ZodTypeAny ? Array, string>> : string[]; /** Optional explicit name */ workerName?: string; /** * Maximum random delay (in seconds) before the worker starts polling. * When multiple application instances restart simultaneously, this spreads out * initial activation requests to avoid saturating the server. * `0` (the default) means no delay. */ startupJitterMaxSeconds?: number; /** * Validate any provided input, output, customheader schema * default: false **/ validateSchemas?: boolean; /** * Number of threads in the shared pool (used only when the pool is first created; * subsequent workers share the existing pool). * Default: number of CPU cores available to the process. */ threadPoolSize?: number; } /** * A job worker that runs handler logic in a shared pool of worker_threads, * keeping the main Node.js event loop free for polling and I/O. * * The thread pool is owned by CamundaClient and shared across all threaded workers. * Each thread is generic — the handler module path is sent with each job, * and threads cache loaded handlers by module path. */ declare class ThreadedJobWorker { private _client; private _pool; private _cfg; private _maxParallelJobs; private _jobTimeoutMs; private _name; private _activeJobs; private _stopped; private _pollTimer; private _inFlightActivation; private _log; private _jobQueue; constructor(client: CamundaClient, pool: ThreadPool, cfg: ThreadedJobWorkerConfig); get name(): string; get activeJobs(): number; get stopped(): boolean; /** Number of threads in the shared pool. */ get poolSize(): number; /** Number of threads currently processing a job (across all workers). */ get busyThreads(): number; /** Resolves when the shared thread pool has finished initialising. */ get ready(): Promise; start(): void; stop(): void; stopGracefully(opts?: { waitUpToMs?: number; checkIntervalMs?: number; }): Promise<{ remainingJobs: number; timedOut: boolean; }>; private _drainQueue; private _dispatchToThread; private _serializeJob; private _scheduleNext; private _poll; private _handleJob; private _failValidation; private _decrementOnce; } type _RawReturn = F extends (...a: any) => Promise ? R : never; type _DataOf = Exclude<_RawReturn extends { data: infer D; } ? D : _RawReturn, undefined>; type activateAdHocSubProcessActivitiesOptions = Parameters[0]; type activateAdHocSubProcessActivitiesBody = (NonNullable extends { body?: infer B; } ? B : never); type activateAdHocSubProcessActivitiesPathParam_adHocSubProcessInstanceKey = (NonNullable extends { path: { adHocSubProcessInstanceKey: infer P; }; } ? P : any); type activateAdHocSubProcessActivitiesInput = activateAdHocSubProcessActivitiesBody & { adHocSubProcessInstanceKey: activateAdHocSubProcessActivitiesPathParam_adHocSubProcessInstanceKey; }; type activateJobsOptions = Parameters[0]; type activateJobsBody = (NonNullable extends { body?: infer B; } ? B : never); type activateJobsInput = activateJobsBody; type assignClientToGroupOptions = Parameters[0]; type assignClientToGroupPathParam_groupId = (NonNullable extends { path: { groupId: infer P; }; } ? P : any); type assignClientToGroupPathParam_clientId = (NonNullable extends { path: { clientId: infer P; }; } ? P : any); type assignClientToGroupInput = { groupId: assignClientToGroupPathParam_groupId; clientId: assignClientToGroupPathParam_clientId; }; type assignClientToTenantOptions = Parameters[0]; type assignClientToTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type assignClientToTenantPathParam_clientId = (NonNullable extends { path: { clientId: infer P; }; } ? P : any); type assignClientToTenantInput = { tenantId: assignClientToTenantPathParam_tenantId; clientId: assignClientToTenantPathParam_clientId; }; type assignGroupToTenantOptions = Parameters[0]; type assignGroupToTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type assignGroupToTenantPathParam_groupId = (NonNullable extends { path: { groupId: infer P; }; } ? P : any); type assignGroupToTenantInput = { tenantId: assignGroupToTenantPathParam_tenantId; groupId: assignGroupToTenantPathParam_groupId; }; type assignMappingRuleToGroupOptions = Parameters[0]; type assignMappingRuleToGroupPathParam_groupId = (NonNullable extends { path: { groupId: infer P; }; } ? P : any); type assignMappingRuleToGroupPathParam_mappingRuleId = (NonNullable extends { path: { mappingRuleId: infer P; }; } ? P : any); type assignMappingRuleToGroupInput = { groupId: assignMappingRuleToGroupPathParam_groupId; mappingRuleId: assignMappingRuleToGroupPathParam_mappingRuleId; }; type assignMappingRuleToTenantOptions = Parameters[0]; type assignMappingRuleToTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type assignMappingRuleToTenantPathParam_mappingRuleId = (NonNullable extends { path: { mappingRuleId: infer P; }; } ? P : any); type assignMappingRuleToTenantInput = { tenantId: assignMappingRuleToTenantPathParam_tenantId; mappingRuleId: assignMappingRuleToTenantPathParam_mappingRuleId; }; type assignRoleToClientOptions = Parameters[0]; type assignRoleToClientPathParam_roleId = (NonNullable extends { path: { roleId: infer P; }; } ? P : any); type assignRoleToClientPathParam_clientId = (NonNullable extends { path: { clientId: infer P; }; } ? P : any); type assignRoleToClientInput = { roleId: assignRoleToClientPathParam_roleId; clientId: assignRoleToClientPathParam_clientId; }; type assignRoleToGroupOptions = Parameters[0]; type assignRoleToGroupPathParam_roleId = (NonNullable extends { path: { roleId: infer P; }; } ? P : any); type assignRoleToGroupPathParam_groupId = (NonNullable extends { path: { groupId: infer P; }; } ? P : any); type assignRoleToGroupInput = { roleId: assignRoleToGroupPathParam_roleId; groupId: assignRoleToGroupPathParam_groupId; }; type assignRoleToMappingRuleOptions = Parameters[0]; type assignRoleToMappingRulePathParam_roleId = (NonNullable extends { path: { roleId: infer P; }; } ? P : any); type assignRoleToMappingRulePathParam_mappingRuleId = (NonNullable extends { path: { mappingRuleId: infer P; }; } ? P : any); type assignRoleToMappingRuleInput = { roleId: assignRoleToMappingRulePathParam_roleId; mappingRuleId: assignRoleToMappingRulePathParam_mappingRuleId; }; type assignRoleToTenantOptions = Parameters[0]; type assignRoleToTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type assignRoleToTenantPathParam_roleId = (NonNullable extends { path: { roleId: infer P; }; } ? P : any); type assignRoleToTenantInput = { tenantId: assignRoleToTenantPathParam_tenantId; roleId: assignRoleToTenantPathParam_roleId; }; type assignRoleToUserOptions = Parameters[0]; type assignRoleToUserPathParam_roleId = (NonNullable extends { path: { roleId: infer P; }; } ? P : any); type assignRoleToUserPathParam_username = (NonNullable extends { path: { username: infer P; }; } ? P : any); type assignRoleToUserInput = { roleId: assignRoleToUserPathParam_roleId; username: assignRoleToUserPathParam_username; }; type assignUserTaskOptions = Parameters[0]; type assignUserTaskBody = (NonNullable extends { body?: infer B; } ? B : never); type assignUserTaskPathParam_userTaskKey = (NonNullable extends { path: { userTaskKey: infer P; }; } ? P : any); type assignUserTaskInput = assignUserTaskBody & { userTaskKey: assignUserTaskPathParam_userTaskKey; }; type assignUserToGroupOptions = Parameters[0]; type assignUserToGroupPathParam_groupId = (NonNullable extends { path: { groupId: infer P; }; } ? P : any); type assignUserToGroupPathParam_username = (NonNullable extends { path: { username: infer P; }; } ? P : any); type assignUserToGroupInput = { groupId: assignUserToGroupPathParam_groupId; username: assignUserToGroupPathParam_username; }; type assignUserToTenantOptions = Parameters[0]; type assignUserToTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type assignUserToTenantPathParam_username = (NonNullable extends { path: { username: infer P; }; } ? P : any); type assignUserToTenantInput = { tenantId: assignUserToTenantPathParam_tenantId; username: assignUserToTenantPathParam_username; }; type broadcastSignalOptions = Parameters[0]; type broadcastSignalBody = (NonNullable extends { body?: infer B; } ? B : never); type broadcastSignalInput = broadcastSignalBody; type cancelBatchOperationOptions = Parameters[0]; type cancelBatchOperationBody = (NonNullable extends { body?: infer B; } ? B : never); type cancelBatchOperationPathParam_batchOperationKey = (NonNullable extends { path: { batchOperationKey: infer P; }; } ? P : any); type cancelBatchOperationInput = cancelBatchOperationBody & { batchOperationKey: cancelBatchOperationPathParam_batchOperationKey; }; type cancelProcessInstanceOptions = Parameters[0]; type cancelProcessInstanceBody = (NonNullable extends { body?: infer B; } ? B : never); type cancelProcessInstancePathParam_processInstanceKey = (NonNullable extends { path: { processInstanceKey: infer P; }; } ? P : any); type cancelProcessInstanceInput = cancelProcessInstanceBody & { processInstanceKey: cancelProcessInstancePathParam_processInstanceKey; }; type cancelProcessInstancesBatchOperationOptions = Parameters[0]; type cancelProcessInstancesBatchOperationBody = (NonNullable extends { body?: infer B; } ? B : never); type cancelProcessInstancesBatchOperationInput = cancelProcessInstancesBatchOperationBody; type completeJobOptions = Parameters[0]; type completeJobBody = (NonNullable extends { body?: infer B; } ? B : never); type completeJobPathParam_jobKey = (NonNullable extends { path: { jobKey: infer P; }; } ? P : any); type completeJobInput = completeJobBody & { jobKey: completeJobPathParam_jobKey; }; type completeUserTaskOptions = Parameters[0]; type completeUserTaskBody = (NonNullable extends { body?: infer B; } ? B : never); type completeUserTaskPathParam_userTaskKey = (NonNullable extends { path: { userTaskKey: infer P; }; } ? P : any); type completeUserTaskInput = completeUserTaskBody & { userTaskKey: completeUserTaskPathParam_userTaskKey; }; type correlateMessageOptions = Parameters[0]; type correlateMessageBody = (NonNullable extends { body?: infer B; } ? B : never); type correlateMessageInput = correlateMessageBody; type createAdminUserOptions = Parameters[0]; type createAdminUserBody = (NonNullable extends { body?: infer B; } ? B : never); type createAdminUserInput = createAdminUserBody; type createAuthorizationOptions = Parameters[0]; type createAuthorizationBody = (NonNullable extends { body?: infer B; } ? B : never); type createAuthorizationInput = createAuthorizationBody; type createDeploymentOptions = Parameters[0]; type createDeploymentBody = (NonNullable extends { body?: infer B; } ? B : never); type createDeploymentInput = Omit & { resources: File[]; }; type createDocumentOptions = Parameters[0]; type createDocumentBody = (NonNullable extends { body?: infer B; } ? B : never); type createDocumentQueryParam_storeId = (NonNullable extends { query?: { storeId?: infer Q; }; } ? Q : any); type createDocumentQueryParam_documentId = (NonNullable extends { query?: { documentId?: infer Q; }; } ? Q : any); type createDocumentInput = createDocumentBody & { storeId?: createDocumentQueryParam_storeId; documentId?: createDocumentQueryParam_documentId; }; type createDocumentLinkOptions = Parameters[0]; type createDocumentLinkBody = (NonNullable extends { body?: infer B; } ? B : never); type createDocumentLinkPathParam_documentId = (NonNullable extends { path: { documentId: infer P; }; } ? P : any); type createDocumentLinkQueryParam_storeId = (NonNullable extends { query?: { storeId?: infer Q; }; } ? Q : any); type createDocumentLinkQueryParam_contentHash = (NonNullable extends { query?: { contentHash?: infer Q; }; } ? Q : any); type createDocumentLinkInput = createDocumentLinkBody & { documentId: createDocumentLinkPathParam_documentId; storeId?: createDocumentLinkQueryParam_storeId; contentHash?: createDocumentLinkQueryParam_contentHash; }; type createDocumentsOptions = Parameters[0]; type createDocumentsBody = (NonNullable extends { body?: infer B; } ? B : never); type createDocumentsQueryParam_storeId = (NonNullable extends { query?: { storeId?: infer Q; }; } ? Q : any); type createDocumentsInput = createDocumentsBody & { storeId?: createDocumentsQueryParam_storeId; }; type createElementInstanceVariablesOptions = Parameters[0]; type createElementInstanceVariablesBody = (NonNullable extends { body?: infer B; } ? B : never); type createElementInstanceVariablesPathParam_elementInstanceKey = (NonNullable extends { path: { elementInstanceKey: infer P; }; } ? P : any); type createElementInstanceVariablesInput = createElementInstanceVariablesBody & { elementInstanceKey: createElementInstanceVariablesPathParam_elementInstanceKey; }; type createGlobalClusterVariableOptions = Parameters[0]; type createGlobalClusterVariableBody = (NonNullable extends { body?: infer B; } ? B : never); type createGlobalClusterVariableInput = createGlobalClusterVariableBody; type createGlobalTaskListenerOptions = Parameters[0]; type createGlobalTaskListenerBody = (NonNullable extends { body?: infer B; } ? B : never); type createGlobalTaskListenerInput = createGlobalTaskListenerBody; type createGroupOptions = Parameters[0]; type createGroupBody = (NonNullable extends { body?: infer B; } ? B : never); type createGroupInput = createGroupBody; type createMappingRuleOptions = Parameters[0]; type createMappingRuleBody = (NonNullable extends { body?: infer B; } ? B : never); type createMappingRuleInput = createMappingRuleBody; type createProcessInstanceOptions = Parameters[0]; type createProcessInstanceBody = (NonNullable extends { body?: infer B; } ? B : never); type createProcessInstanceInput = createProcessInstanceBody; type createRoleOptions = Parameters[0]; type createRoleBody = (NonNullable extends { body?: infer B; } ? B : never); type createRoleInput = createRoleBody; type createTenantOptions = Parameters[0]; type createTenantBody = (NonNullable extends { body?: infer B; } ? B : never); type createTenantInput = createTenantBody; type createTenantClusterVariableOptions = Parameters[0]; type createTenantClusterVariableBody = (NonNullable extends { body?: infer B; } ? B : never); type createTenantClusterVariablePathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type createTenantClusterVariableInput = createTenantClusterVariableBody & { tenantId: createTenantClusterVariablePathParam_tenantId; }; type createUserOptions = Parameters[0]; type createUserBody = (NonNullable extends { body?: infer B; } ? B : never); type createUserInput = createUserBody; type deleteAuthorizationOptions = Parameters[0]; type deleteAuthorizationPathParam_authorizationKey = (NonNullable extends { path: { authorizationKey: infer P; }; } ? P : any); type deleteAuthorizationInput = { authorizationKey: deleteAuthorizationPathParam_authorizationKey; }; type deleteDecisionInstanceOptions = Parameters[0]; type deleteDecisionInstanceBody = (NonNullable extends { body?: infer B; } ? B : never); type deleteDecisionInstancePathParam_decisionEvaluationKey = (NonNullable extends { path: { decisionEvaluationKey: infer P; }; } ? P : any); type deleteDecisionInstanceInput = deleteDecisionInstanceBody & { decisionEvaluationKey: deleteDecisionInstancePathParam_decisionEvaluationKey; }; type deleteDecisionInstancesBatchOperationOptions = Parameters[0]; type deleteDecisionInstancesBatchOperationBody = (NonNullable extends { body?: infer B; } ? B : never); type deleteDecisionInstancesBatchOperationInput = deleteDecisionInstancesBatchOperationBody; type deleteDocumentOptions = Parameters[0]; type deleteDocumentPathParam_documentId = (NonNullable extends { path: { documentId: infer P; }; } ? P : any); type deleteDocumentQueryParam_storeId = (NonNullable extends { query?: { storeId?: infer Q; }; } ? Q : any); type deleteDocumentInput = { documentId: deleteDocumentPathParam_documentId; storeId?: deleteDocumentQueryParam_storeId; }; type deleteGlobalClusterVariableOptions = Parameters[0]; type deleteGlobalClusterVariablePathParam_name = (NonNullable extends { path: { name: infer P; }; } ? P : any); type deleteGlobalClusterVariableInput = { name: deleteGlobalClusterVariablePathParam_name; }; type deleteGlobalTaskListenerOptions = Parameters[0]; type deleteGlobalTaskListenerPathParam_id = (NonNullable extends { path: { id: infer P; }; } ? P : any); type deleteGlobalTaskListenerInput = { id: deleteGlobalTaskListenerPathParam_id; }; type deleteGroupOptions = Parameters[0]; type deleteGroupPathParam_groupId = (NonNullable extends { path: { groupId: infer P; }; } ? P : any); type deleteGroupInput = { groupId: deleteGroupPathParam_groupId; }; type deleteMappingRuleOptions = Parameters[0]; type deleteMappingRulePathParam_mappingRuleId = (NonNullable extends { path: { mappingRuleId: infer P; }; } ? P : any); type deleteMappingRuleInput = { mappingRuleId: deleteMappingRulePathParam_mappingRuleId; }; type deleteProcessInstanceOptions = Parameters[0]; type deleteProcessInstanceBody = (NonNullable extends { body?: infer B; } ? B : never); type deleteProcessInstancePathParam_processInstanceKey = (NonNullable extends { path: { processInstanceKey: infer P; }; } ? P : any); type deleteProcessInstanceInput = deleteProcessInstanceBody & { processInstanceKey: deleteProcessInstancePathParam_processInstanceKey; }; type deleteProcessInstancesBatchOperationOptions = Parameters[0]; type deleteProcessInstancesBatchOperationBody = (NonNullable extends { body?: infer B; } ? B : never); type deleteProcessInstancesBatchOperationInput = deleteProcessInstancesBatchOperationBody; type deleteResourceOptions = Parameters[0]; type deleteResourceBody = (NonNullable extends { body?: infer B; } ? B : never); type deleteResourcePathParam_resourceKey = (NonNullable extends { path: { resourceKey: infer P; }; } ? P : any); type deleteResourceInput = deleteResourceBody & { resourceKey: deleteResourcePathParam_resourceKey; }; type deleteRoleOptions = Parameters[0]; type deleteRolePathParam_roleId = (NonNullable extends { path: { roleId: infer P; }; } ? P : any); type deleteRoleInput = { roleId: deleteRolePathParam_roleId; }; type deleteTenantOptions = Parameters[0]; type deleteTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type deleteTenantInput = { tenantId: deleteTenantPathParam_tenantId; }; type deleteTenantClusterVariableOptions = Parameters[0]; type deleteTenantClusterVariablePathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type deleteTenantClusterVariablePathParam_name = (NonNullable extends { path: { name: infer P; }; } ? P : any); type deleteTenantClusterVariableInput = { tenantId: deleteTenantClusterVariablePathParam_tenantId; name: deleteTenantClusterVariablePathParam_name; }; type deleteUserOptions = Parameters[0]; type deleteUserPathParam_username = (NonNullable extends { path: { username: infer P; }; } ? P : any); type deleteUserInput = { username: deleteUserPathParam_username; }; type evaluateConditionalsOptions = Parameters[0]; type evaluateConditionalsBody = (NonNullable extends { body?: infer B; } ? B : never); type evaluateConditionalsInput = evaluateConditionalsBody; type evaluateDecisionOptions = Parameters[0]; type evaluateDecisionBody = (NonNullable extends { body?: infer B; } ? B : never); type evaluateDecisionInput = evaluateDecisionBody; type evaluateExpressionOptions = Parameters[0]; type evaluateExpressionBody = (NonNullable extends { body?: infer B; } ? B : never); type evaluateExpressionInput = evaluateExpressionBody; type failJobOptions = Parameters[0]; type failJobBody = (NonNullable extends { body?: infer B; } ? B : never); type failJobPathParam_jobKey = (NonNullable extends { path: { jobKey: infer P; }; } ? P : any); type failJobInput = failJobBody & { jobKey: failJobPathParam_jobKey; }; type getAuditLogOptions = Parameters[0]; type getAuditLogPathParam_auditLogKey = (NonNullable extends { path: { auditLogKey: infer P; }; } ? P : any); type getAuditLogInput = { auditLogKey: getAuditLogPathParam_auditLogKey; }; /** Management of eventual consistency **/ type getAuditLogConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getAuthenticationInput = void; type getAuthorizationOptions = Parameters[0]; type getAuthorizationPathParam_authorizationKey = (NonNullable extends { path: { authorizationKey: infer P; }; } ? P : any); type getAuthorizationInput = { authorizationKey: getAuthorizationPathParam_authorizationKey; }; /** Management of eventual consistency **/ type getAuthorizationConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getBatchOperationOptions = Parameters[0]; type getBatchOperationPathParam_batchOperationKey = (NonNullable extends { path: { batchOperationKey: infer P; }; } ? P : any); type getBatchOperationInput = { batchOperationKey: getBatchOperationPathParam_batchOperationKey; }; /** Management of eventual consistency **/ type getBatchOperationConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getDecisionDefinitionOptions = Parameters[0]; type getDecisionDefinitionPathParam_decisionDefinitionKey = (NonNullable extends { path: { decisionDefinitionKey: infer P; }; } ? P : any); type getDecisionDefinitionInput = { decisionDefinitionKey: getDecisionDefinitionPathParam_decisionDefinitionKey; }; /** Management of eventual consistency **/ type getDecisionDefinitionConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getDecisionDefinitionXmlOptions = Parameters[0]; type getDecisionDefinitionXmlPathParam_decisionDefinitionKey = (NonNullable extends { path: { decisionDefinitionKey: infer P; }; } ? P : any); type getDecisionDefinitionXmlInput = { decisionDefinitionKey: getDecisionDefinitionXmlPathParam_decisionDefinitionKey; }; /** Management of eventual consistency **/ type getDecisionDefinitionXmlConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getDecisionInstanceOptions = Parameters[0]; type getDecisionInstancePathParam_decisionEvaluationInstanceKey = (NonNullable extends { path: { decisionEvaluationInstanceKey: infer P; }; } ? P : any); type getDecisionInstanceInput = { decisionEvaluationInstanceKey: getDecisionInstancePathParam_decisionEvaluationInstanceKey; }; /** Management of eventual consistency **/ type getDecisionInstanceConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getDecisionRequirementsOptions = Parameters[0]; type getDecisionRequirementsPathParam_decisionRequirementsKey = (NonNullable extends { path: { decisionRequirementsKey: infer P; }; } ? P : any); type getDecisionRequirementsInput = { decisionRequirementsKey: getDecisionRequirementsPathParam_decisionRequirementsKey; }; /** Management of eventual consistency **/ type getDecisionRequirementsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getDecisionRequirementsXmlOptions = Parameters[0]; type getDecisionRequirementsXmlPathParam_decisionRequirementsKey = (NonNullable extends { path: { decisionRequirementsKey: infer P; }; } ? P : any); type getDecisionRequirementsXmlInput = { decisionRequirementsKey: getDecisionRequirementsXmlPathParam_decisionRequirementsKey; }; /** Management of eventual consistency **/ type getDecisionRequirementsXmlConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getDocumentOptions = Parameters[0]; type getDocumentPathParam_documentId = (NonNullable extends { path: { documentId: infer P; }; } ? P : any); type getDocumentQueryParam_storeId = (NonNullable extends { query?: { storeId?: infer Q; }; } ? Q : any); type getDocumentQueryParam_contentHash = (NonNullable extends { query?: { contentHash?: infer Q; }; } ? Q : any); type getDocumentInput = { documentId: getDocumentPathParam_documentId; storeId?: getDocumentQueryParam_storeId; contentHash?: getDocumentQueryParam_contentHash; }; type getElementInstanceOptions = Parameters[0]; type getElementInstancePathParam_elementInstanceKey = (NonNullable extends { path: { elementInstanceKey: infer P; }; } ? P : any); type getElementInstanceInput = { elementInstanceKey: getElementInstancePathParam_elementInstanceKey; }; /** Management of eventual consistency **/ type getElementInstanceConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getGlobalClusterVariableOptions = Parameters[0]; type getGlobalClusterVariablePathParam_name = (NonNullable extends { path: { name: infer P; }; } ? P : any); type getGlobalClusterVariableInput = { name: getGlobalClusterVariablePathParam_name; }; /** Management of eventual consistency **/ type getGlobalClusterVariableConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getGlobalJobStatisticsOptions = Parameters[0]; type getGlobalJobStatisticsQueryParam_from = (NonNullable extends { query?: { from?: infer Q; }; } ? Q : any); type getGlobalJobStatisticsQueryParam_to = (NonNullable extends { query?: { to?: infer Q; }; } ? Q : any); type getGlobalJobStatisticsQueryParam_jobType = (NonNullable extends { query?: { jobType?: infer Q; }; } ? Q : any); type getGlobalJobStatisticsInput = { from: getGlobalJobStatisticsQueryParam_from; to: getGlobalJobStatisticsQueryParam_to; jobType?: getGlobalJobStatisticsQueryParam_jobType; }; /** Management of eventual consistency **/ type getGlobalJobStatisticsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getGlobalTaskListenerOptions = Parameters[0]; type getGlobalTaskListenerPathParam_id = (NonNullable extends { path: { id: infer P; }; } ? P : any); type getGlobalTaskListenerInput = { id: getGlobalTaskListenerPathParam_id; }; /** Management of eventual consistency **/ type getGlobalTaskListenerConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getGroupOptions = Parameters[0]; type getGroupPathParam_groupId = (NonNullable extends { path: { groupId: infer P; }; } ? P : any); type getGroupInput = { groupId: getGroupPathParam_groupId; }; /** Management of eventual consistency **/ type getGroupConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getIncidentOptions = Parameters[0]; type getIncidentPathParam_incidentKey = (NonNullable extends { path: { incidentKey: infer P; }; } ? P : any); type getIncidentInput = { incidentKey: getIncidentPathParam_incidentKey; }; /** Management of eventual consistency **/ type getIncidentConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getJobErrorStatisticsOptions = Parameters[0]; type getJobErrorStatisticsBody = (NonNullable extends { body?: infer B; } ? B : never); type getJobErrorStatisticsInput = getJobErrorStatisticsBody; /** Management of eventual consistency **/ type getJobErrorStatisticsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getJobTimeSeriesStatisticsOptions = Parameters[0]; type getJobTimeSeriesStatisticsBody = (NonNullable extends { body?: infer B; } ? B : never); type getJobTimeSeriesStatisticsInput = getJobTimeSeriesStatisticsBody; /** Management of eventual consistency **/ type getJobTimeSeriesStatisticsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getJobTypeStatisticsOptions = Parameters[0]; type getJobTypeStatisticsBody = (NonNullable extends { body?: infer B; } ? B : never); type getJobTypeStatisticsInput = getJobTypeStatisticsBody; /** Management of eventual consistency **/ type getJobTypeStatisticsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getJobWorkerStatisticsOptions = Parameters[0]; type getJobWorkerStatisticsBody = (NonNullable extends { body?: infer B; } ? B : never); type getJobWorkerStatisticsInput = getJobWorkerStatisticsBody; /** Management of eventual consistency **/ type getJobWorkerStatisticsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getLicenseInput = void; type getMappingRuleOptions = Parameters[0]; type getMappingRulePathParam_mappingRuleId = (NonNullable extends { path: { mappingRuleId: infer P; }; } ? P : any); type getMappingRuleInput = { mappingRuleId: getMappingRulePathParam_mappingRuleId; }; /** Management of eventual consistency **/ type getMappingRuleConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getProcessDefinitionOptions = Parameters[0]; type getProcessDefinitionPathParam_processDefinitionKey = (NonNullable extends { path: { processDefinitionKey: infer P; }; } ? P : any); type getProcessDefinitionInput = { processDefinitionKey: getProcessDefinitionPathParam_processDefinitionKey; }; /** Management of eventual consistency **/ type getProcessDefinitionConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getProcessDefinitionInstanceStatisticsOptions = Parameters[0]; type getProcessDefinitionInstanceStatisticsBody = (NonNullable extends { body?: infer B; } ? B : never); type getProcessDefinitionInstanceStatisticsInput = getProcessDefinitionInstanceStatisticsBody; /** Management of eventual consistency **/ type getProcessDefinitionInstanceStatisticsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getProcessDefinitionInstanceVersionStatisticsOptions = Parameters[0]; type getProcessDefinitionInstanceVersionStatisticsBody = (NonNullable extends { body?: infer B; } ? B : never); type getProcessDefinitionInstanceVersionStatisticsInput = getProcessDefinitionInstanceVersionStatisticsBody; /** Management of eventual consistency **/ type getProcessDefinitionInstanceVersionStatisticsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getProcessDefinitionMessageSubscriptionStatisticsOptions = Parameters[0]; type getProcessDefinitionMessageSubscriptionStatisticsBody = (NonNullable extends { body?: infer B; } ? B : never); type getProcessDefinitionMessageSubscriptionStatisticsInput = getProcessDefinitionMessageSubscriptionStatisticsBody; /** Management of eventual consistency **/ type getProcessDefinitionMessageSubscriptionStatisticsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getProcessDefinitionStatisticsOptions = Parameters[0]; type getProcessDefinitionStatisticsBody = (NonNullable extends { body?: infer B; } ? B : never); type getProcessDefinitionStatisticsPathParam_processDefinitionKey = (NonNullable extends { path: { processDefinitionKey: infer P; }; } ? P : any); type getProcessDefinitionStatisticsInput = getProcessDefinitionStatisticsBody & { processDefinitionKey: getProcessDefinitionStatisticsPathParam_processDefinitionKey; }; /** Management of eventual consistency **/ type getProcessDefinitionStatisticsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getProcessDefinitionXmlOptions = Parameters[0]; type getProcessDefinitionXmlPathParam_processDefinitionKey = (NonNullable extends { path: { processDefinitionKey: infer P; }; } ? P : any); type getProcessDefinitionXmlInput = { processDefinitionKey: getProcessDefinitionXmlPathParam_processDefinitionKey; }; /** Management of eventual consistency **/ type getProcessDefinitionXmlConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getProcessInstanceOptions = Parameters[0]; type getProcessInstancePathParam_processInstanceKey = (NonNullable extends { path: { processInstanceKey: infer P; }; } ? P : any); type getProcessInstanceInput = { processInstanceKey: getProcessInstancePathParam_processInstanceKey; }; /** Management of eventual consistency **/ type getProcessInstanceConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getProcessInstanceCallHierarchyOptions = Parameters[0]; type getProcessInstanceCallHierarchyPathParam_processInstanceKey = (NonNullable extends { path: { processInstanceKey: infer P; }; } ? P : any); type getProcessInstanceCallHierarchyInput = { processInstanceKey: getProcessInstanceCallHierarchyPathParam_processInstanceKey; }; /** Management of eventual consistency **/ type getProcessInstanceCallHierarchyConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getProcessInstanceSequenceFlowsOptions = Parameters[0]; type getProcessInstanceSequenceFlowsPathParam_processInstanceKey = (NonNullable extends { path: { processInstanceKey: infer P; }; } ? P : any); type getProcessInstanceSequenceFlowsInput = { processInstanceKey: getProcessInstanceSequenceFlowsPathParam_processInstanceKey; }; /** Management of eventual consistency **/ type getProcessInstanceSequenceFlowsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getProcessInstanceStatisticsOptions = Parameters[0]; type getProcessInstanceStatisticsPathParam_processInstanceKey = (NonNullable extends { path: { processInstanceKey: infer P; }; } ? P : any); type getProcessInstanceStatisticsInput = { processInstanceKey: getProcessInstanceStatisticsPathParam_processInstanceKey; }; /** Management of eventual consistency **/ type getProcessInstanceStatisticsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getProcessInstanceStatisticsByDefinitionOptions = Parameters[0]; type getProcessInstanceStatisticsByDefinitionBody = (NonNullable extends { body?: infer B; } ? B : never); type getProcessInstanceStatisticsByDefinitionInput = getProcessInstanceStatisticsByDefinitionBody; /** Management of eventual consistency **/ type getProcessInstanceStatisticsByDefinitionConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getProcessInstanceStatisticsByErrorOptions = Parameters[0]; type getProcessInstanceStatisticsByErrorBody = (NonNullable extends { body?: infer B; } ? B : never); type getProcessInstanceStatisticsByErrorInput = getProcessInstanceStatisticsByErrorBody; /** Management of eventual consistency **/ type getProcessInstanceStatisticsByErrorConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getResourceOptions = Parameters[0]; type getResourcePathParam_resourceKey = (NonNullable extends { path: { resourceKey: infer P; }; } ? P : any); type getResourceInput = { resourceKey: getResourcePathParam_resourceKey; }; type getResourceContentOptions = Parameters[0]; type getResourceContentPathParam_resourceKey = (NonNullable extends { path: { resourceKey: infer P; }; } ? P : any); type getResourceContentInput = { resourceKey: getResourceContentPathParam_resourceKey; }; type getRoleOptions = Parameters[0]; type getRolePathParam_roleId = (NonNullable extends { path: { roleId: infer P; }; } ? P : any); type getRoleInput = { roleId: getRolePathParam_roleId; }; /** Management of eventual consistency **/ type getRoleConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getStartProcessFormOptions = Parameters[0]; type getStartProcessFormPathParam_processDefinitionKey = (NonNullable extends { path: { processDefinitionKey: infer P; }; } ? P : any); type getStartProcessFormInput = { processDefinitionKey: getStartProcessFormPathParam_processDefinitionKey; }; /** Management of eventual consistency **/ type getStartProcessFormConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getStatusInput = void; type getSystemConfigurationInput = void; type getTenantOptions = Parameters[0]; type getTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type getTenantInput = { tenantId: getTenantPathParam_tenantId; }; /** Management of eventual consistency **/ type getTenantConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getTenantClusterVariableOptions = Parameters[0]; type getTenantClusterVariablePathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type getTenantClusterVariablePathParam_name = (NonNullable extends { path: { name: infer P; }; } ? P : any); type getTenantClusterVariableInput = { tenantId: getTenantClusterVariablePathParam_tenantId; name: getTenantClusterVariablePathParam_name; }; /** Management of eventual consistency **/ type getTenantClusterVariableConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getTopologyInput = void; type getUsageMetricsOptions = Parameters[0]; type getUsageMetricsQueryParam_startTime = (NonNullable extends { query?: { startTime?: infer Q; }; } ? Q : any); type getUsageMetricsQueryParam_endTime = (NonNullable extends { query?: { endTime?: infer Q; }; } ? Q : any); type getUsageMetricsQueryParam_tenantId = (NonNullable extends { query?: { tenantId?: infer Q; }; } ? Q : any); type getUsageMetricsQueryParam_withTenants = (NonNullable extends { query?: { withTenants?: infer Q; }; } ? Q : any); type getUsageMetricsInput = { startTime: getUsageMetricsQueryParam_startTime; endTime: getUsageMetricsQueryParam_endTime; tenantId?: getUsageMetricsQueryParam_tenantId; withTenants?: getUsageMetricsQueryParam_withTenants; }; /** Management of eventual consistency **/ type getUsageMetricsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getUserOptions = Parameters[0]; type getUserPathParam_username = (NonNullable extends { path: { username: infer P; }; } ? P : any); type getUserInput = { username: getUserPathParam_username; }; /** Management of eventual consistency **/ type getUserConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getUserTaskOptions = Parameters[0]; type getUserTaskPathParam_userTaskKey = (NonNullable extends { path: { userTaskKey: infer P; }; } ? P : any); type getUserTaskInput = { userTaskKey: getUserTaskPathParam_userTaskKey; }; /** Management of eventual consistency **/ type getUserTaskConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getUserTaskFormOptions = Parameters[0]; type getUserTaskFormPathParam_userTaskKey = (NonNullable extends { path: { userTaskKey: infer P; }; } ? P : any); type getUserTaskFormInput = { userTaskKey: getUserTaskFormPathParam_userTaskKey; }; /** Management of eventual consistency **/ type getUserTaskFormConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type getVariableOptions = Parameters[0]; type getVariablePathParam_variableKey = (NonNullable extends { path: { variableKey: infer P; }; } ? P : any); type getVariableInput = { variableKey: getVariablePathParam_variableKey; }; /** Management of eventual consistency **/ type getVariableConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type migrateProcessInstanceOptions = Parameters[0]; type migrateProcessInstanceBody = (NonNullable extends { body?: infer B; } ? B : never); type migrateProcessInstancePathParam_processInstanceKey = (NonNullable extends { path: { processInstanceKey: infer P; }; } ? P : any); type migrateProcessInstanceInput = migrateProcessInstanceBody & { processInstanceKey: migrateProcessInstancePathParam_processInstanceKey; }; type migrateProcessInstancesBatchOperationOptions = Parameters[0]; type migrateProcessInstancesBatchOperationBody = (NonNullable extends { body?: infer B; } ? B : never); type migrateProcessInstancesBatchOperationInput = migrateProcessInstancesBatchOperationBody; type modifyProcessInstanceOptions = Parameters[0]; type modifyProcessInstanceBody = (NonNullable extends { body?: infer B; } ? B : never); type modifyProcessInstancePathParam_processInstanceKey = (NonNullable extends { path: { processInstanceKey: infer P; }; } ? P : any); type modifyProcessInstanceInput = modifyProcessInstanceBody & { processInstanceKey: modifyProcessInstancePathParam_processInstanceKey; }; type modifyProcessInstancesBatchOperationOptions = Parameters[0]; type modifyProcessInstancesBatchOperationBody = (NonNullable extends { body?: infer B; } ? B : never); type modifyProcessInstancesBatchOperationInput = modifyProcessInstancesBatchOperationBody; type pinClockOptions = Parameters[0]; type pinClockBody = (NonNullable extends { body?: infer B; } ? B : never); type pinClockInput = pinClockBody; type publishMessageOptions = Parameters[0]; type publishMessageBody = (NonNullable extends { body?: infer B; } ? B : never); type publishMessageInput = publishMessageBody; type resetClockInput = void; type resolveIncidentOptions = Parameters[0]; type resolveIncidentBody = (NonNullable extends { body?: infer B; } ? B : never); type resolveIncidentPathParam_incidentKey = (NonNullable extends { path: { incidentKey: infer P; }; } ? P : any); type resolveIncidentInput = resolveIncidentBody & { incidentKey: resolveIncidentPathParam_incidentKey; }; type resolveIncidentsBatchOperationOptions = Parameters[0]; type resolveIncidentsBatchOperationBody = (NonNullable extends { body?: infer B; } ? B : never); type resolveIncidentsBatchOperationInput = resolveIncidentsBatchOperationBody; type resolveProcessInstanceIncidentsOptions = Parameters[0]; type resolveProcessInstanceIncidentsPathParam_processInstanceKey = (NonNullable extends { path: { processInstanceKey: infer P; }; } ? P : any); type resolveProcessInstanceIncidentsInput = { processInstanceKey: resolveProcessInstanceIncidentsPathParam_processInstanceKey; }; type resumeBatchOperationOptions = Parameters[0]; type resumeBatchOperationBody = (NonNullable extends { body?: infer B; } ? B : never); type resumeBatchOperationPathParam_batchOperationKey = (NonNullable extends { path: { batchOperationKey: infer P; }; } ? P : any); type resumeBatchOperationInput = resumeBatchOperationBody & { batchOperationKey: resumeBatchOperationPathParam_batchOperationKey; }; type searchAuditLogsOptions = Parameters[0]; type searchAuditLogsBody = (NonNullable extends { body?: infer B; } ? B : never); type searchAuditLogsInput = searchAuditLogsBody; /** Management of eventual consistency **/ type searchAuditLogsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchAuthorizationsOptions = Parameters[0]; type searchAuthorizationsBody = (NonNullable extends { body?: infer B; } ? B : never); type searchAuthorizationsInput = searchAuthorizationsBody; /** Management of eventual consistency **/ type searchAuthorizationsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchBatchOperationItemsOptions = Parameters[0]; type searchBatchOperationItemsBody = (NonNullable extends { body?: infer B; } ? B : never); type searchBatchOperationItemsInput = searchBatchOperationItemsBody; /** Management of eventual consistency **/ type searchBatchOperationItemsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchBatchOperationsOptions = Parameters[0]; type searchBatchOperationsBody = (NonNullable extends { body?: infer B; } ? B : never); type searchBatchOperationsInput = searchBatchOperationsBody; /** Management of eventual consistency **/ type searchBatchOperationsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchClientsForGroupOptions = Parameters[0]; type searchClientsForGroupBody = (NonNullable extends { body?: infer B; } ? B : never); type searchClientsForGroupPathParam_groupId = (NonNullable extends { path: { groupId: infer P; }; } ? P : any); type searchClientsForGroupInput = searchClientsForGroupBody & { groupId: searchClientsForGroupPathParam_groupId; }; /** Management of eventual consistency **/ type searchClientsForGroupConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchClientsForRoleOptions = Parameters[0]; type searchClientsForRoleBody = (NonNullable extends { body?: infer B; } ? B : never); type searchClientsForRolePathParam_roleId = (NonNullable extends { path: { roleId: infer P; }; } ? P : any); type searchClientsForRoleInput = searchClientsForRoleBody & { roleId: searchClientsForRolePathParam_roleId; }; /** Management of eventual consistency **/ type searchClientsForRoleConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchClientsForTenantOptions = Parameters[0]; type searchClientsForTenantBody = (NonNullable extends { body?: infer B; } ? B : never); type searchClientsForTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type searchClientsForTenantInput = searchClientsForTenantBody & { tenantId: searchClientsForTenantPathParam_tenantId; }; /** Management of eventual consistency **/ type searchClientsForTenantConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchClusterVariablesOptions = Parameters[0]; type searchClusterVariablesBody = (NonNullable extends { body?: infer B; } ? B : never); type searchClusterVariablesQueryParam_truncateValues = (NonNullable extends { query?: { truncateValues?: infer Q; }; } ? Q : any); type searchClusterVariablesInput = searchClusterVariablesBody & { truncateValues?: searchClusterVariablesQueryParam_truncateValues; }; /** Management of eventual consistency **/ type searchClusterVariablesConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchCorrelatedMessageSubscriptionsOptions = Parameters[0]; type searchCorrelatedMessageSubscriptionsBody = (NonNullable extends { body?: infer B; } ? B : never); type searchCorrelatedMessageSubscriptionsInput = searchCorrelatedMessageSubscriptionsBody; /** Management of eventual consistency **/ type searchCorrelatedMessageSubscriptionsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchDecisionDefinitionsOptions = Parameters[0]; type searchDecisionDefinitionsBody = (NonNullable extends { body?: infer B; } ? B : never); type searchDecisionDefinitionsInput = searchDecisionDefinitionsBody; /** Management of eventual consistency **/ type searchDecisionDefinitionsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchDecisionInstancesOptions = Parameters[0]; type searchDecisionInstancesBody = (NonNullable extends { body?: infer B; } ? B : never); type searchDecisionInstancesInput = searchDecisionInstancesBody; /** Management of eventual consistency **/ type searchDecisionInstancesConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchDecisionRequirementsOptions = Parameters[0]; type searchDecisionRequirementsBody = (NonNullable extends { body?: infer B; } ? B : never); type searchDecisionRequirementsInput = searchDecisionRequirementsBody; /** Management of eventual consistency **/ type searchDecisionRequirementsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchElementInstanceIncidentsOptions = Parameters[0]; type searchElementInstanceIncidentsBody = (NonNullable extends { body?: infer B; } ? B : never); type searchElementInstanceIncidentsPathParam_elementInstanceKey = (NonNullable extends { path: { elementInstanceKey: infer P; }; } ? P : any); type searchElementInstanceIncidentsInput = searchElementInstanceIncidentsBody & { elementInstanceKey: searchElementInstanceIncidentsPathParam_elementInstanceKey; }; /** Management of eventual consistency **/ type searchElementInstanceIncidentsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchElementInstancesOptions = Parameters[0]; type searchElementInstancesBody = (NonNullable extends { body?: infer B; } ? B : never); type searchElementInstancesInput = searchElementInstancesBody; /** Management of eventual consistency **/ type searchElementInstancesConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchGlobalTaskListenersOptions = Parameters[0]; type searchGlobalTaskListenersBody = (NonNullable extends { body?: infer B; } ? B : never); type searchGlobalTaskListenersInput = searchGlobalTaskListenersBody; /** Management of eventual consistency **/ type searchGlobalTaskListenersConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchGroupIdsForTenantOptions = Parameters[0]; type searchGroupIdsForTenantBody = (NonNullable extends { body?: infer B; } ? B : never); type searchGroupIdsForTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type searchGroupIdsForTenantInput = searchGroupIdsForTenantBody & { tenantId: searchGroupIdsForTenantPathParam_tenantId; }; /** Management of eventual consistency **/ type searchGroupIdsForTenantConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchGroupsOptions = Parameters[0]; type searchGroupsBody = (NonNullable extends { body?: infer B; } ? B : never); type searchGroupsInput = searchGroupsBody; /** Management of eventual consistency **/ type searchGroupsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchGroupsForRoleOptions = Parameters[0]; type searchGroupsForRoleBody = (NonNullable extends { body?: infer B; } ? B : never); type searchGroupsForRolePathParam_roleId = (NonNullable extends { path: { roleId: infer P; }; } ? P : any); type searchGroupsForRoleInput = searchGroupsForRoleBody & { roleId: searchGroupsForRolePathParam_roleId; }; /** Management of eventual consistency **/ type searchGroupsForRoleConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchIncidentsOptions = Parameters[0]; type searchIncidentsBody = (NonNullable extends { body?: infer B; } ? B : never); type searchIncidentsInput = searchIncidentsBody; /** Management of eventual consistency **/ type searchIncidentsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchJobsOptions = Parameters[0]; type searchJobsBody = (NonNullable extends { body?: infer B; } ? B : never); type searchJobsInput = searchJobsBody; /** Management of eventual consistency **/ type searchJobsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchMappingRuleOptions = Parameters[0]; type searchMappingRuleBody = (NonNullable extends { body?: infer B; } ? B : never); type searchMappingRuleInput = searchMappingRuleBody; /** Management of eventual consistency **/ type searchMappingRuleConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchMappingRulesForGroupOptions = Parameters[0]; type searchMappingRulesForGroupBody = (NonNullable extends { body?: infer B; } ? B : never); type searchMappingRulesForGroupPathParam_groupId = (NonNullable extends { path: { groupId: infer P; }; } ? P : any); type searchMappingRulesForGroupInput = searchMappingRulesForGroupBody & { groupId: searchMappingRulesForGroupPathParam_groupId; }; /** Management of eventual consistency **/ type searchMappingRulesForGroupConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchMappingRulesForRoleOptions = Parameters[0]; type searchMappingRulesForRoleBody = (NonNullable extends { body?: infer B; } ? B : never); type searchMappingRulesForRolePathParam_roleId = (NonNullable extends { path: { roleId: infer P; }; } ? P : any); type searchMappingRulesForRoleInput = searchMappingRulesForRoleBody & { roleId: searchMappingRulesForRolePathParam_roleId; }; /** Management of eventual consistency **/ type searchMappingRulesForRoleConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchMappingRulesForTenantOptions = Parameters[0]; type searchMappingRulesForTenantBody = (NonNullable extends { body?: infer B; } ? B : never); type searchMappingRulesForTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type searchMappingRulesForTenantInput = searchMappingRulesForTenantBody & { tenantId: searchMappingRulesForTenantPathParam_tenantId; }; /** Management of eventual consistency **/ type searchMappingRulesForTenantConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchMessageSubscriptionsOptions = Parameters[0]; type searchMessageSubscriptionsBody = (NonNullable extends { body?: infer B; } ? B : never); type searchMessageSubscriptionsInput = searchMessageSubscriptionsBody; /** Management of eventual consistency **/ type searchMessageSubscriptionsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchProcessDefinitionsOptions = Parameters[0]; type searchProcessDefinitionsBody = (NonNullable extends { body?: infer B; } ? B : never); type searchProcessDefinitionsInput = searchProcessDefinitionsBody; /** Management of eventual consistency **/ type searchProcessDefinitionsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchProcessInstanceIncidentsOptions = Parameters[0]; type searchProcessInstanceIncidentsBody = (NonNullable extends { body?: infer B; } ? B : never); type searchProcessInstanceIncidentsPathParam_processInstanceKey = (NonNullable extends { path: { processInstanceKey: infer P; }; } ? P : any); type searchProcessInstanceIncidentsInput = searchProcessInstanceIncidentsBody & { processInstanceKey: searchProcessInstanceIncidentsPathParam_processInstanceKey; }; /** Management of eventual consistency **/ type searchProcessInstanceIncidentsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchProcessInstancesOptions = Parameters[0]; type searchProcessInstancesBody = (NonNullable extends { body?: infer B; } ? B : never); type searchProcessInstancesInput = searchProcessInstancesBody; /** Management of eventual consistency **/ type searchProcessInstancesConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchRolesOptions = Parameters[0]; type searchRolesBody = (NonNullable extends { body?: infer B; } ? B : never); type searchRolesInput = searchRolesBody; /** Management of eventual consistency **/ type searchRolesConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchRolesForGroupOptions = Parameters[0]; type searchRolesForGroupBody = (NonNullable extends { body?: infer B; } ? B : never); type searchRolesForGroupPathParam_groupId = (NonNullable extends { path: { groupId: infer P; }; } ? P : any); type searchRolesForGroupInput = searchRolesForGroupBody & { groupId: searchRolesForGroupPathParam_groupId; }; /** Management of eventual consistency **/ type searchRolesForGroupConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchRolesForTenantOptions = Parameters[0]; type searchRolesForTenantBody = (NonNullable extends { body?: infer B; } ? B : never); type searchRolesForTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type searchRolesForTenantInput = searchRolesForTenantBody & { tenantId: searchRolesForTenantPathParam_tenantId; }; /** Management of eventual consistency **/ type searchRolesForTenantConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchTenantsOptions = Parameters[0]; type searchTenantsBody = (NonNullable extends { body?: infer B; } ? B : never); type searchTenantsInput = searchTenantsBody; /** Management of eventual consistency **/ type searchTenantsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchUsersOptions = Parameters[0]; type searchUsersBody = (NonNullable extends { body?: infer B; } ? B : never); type searchUsersInput = searchUsersBody; /** Management of eventual consistency **/ type searchUsersConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchUsersForGroupOptions = Parameters[0]; type searchUsersForGroupBody = (NonNullable extends { body?: infer B; } ? B : never); type searchUsersForGroupPathParam_groupId = (NonNullable extends { path: { groupId: infer P; }; } ? P : any); type searchUsersForGroupInput = searchUsersForGroupBody & { groupId: searchUsersForGroupPathParam_groupId; }; /** Management of eventual consistency **/ type searchUsersForGroupConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchUsersForRoleOptions = Parameters[0]; type searchUsersForRoleBody = (NonNullable extends { body?: infer B; } ? B : never); type searchUsersForRolePathParam_roleId = (NonNullable extends { path: { roleId: infer P; }; } ? P : any); type searchUsersForRoleInput = searchUsersForRoleBody & { roleId: searchUsersForRolePathParam_roleId; }; /** Management of eventual consistency **/ type searchUsersForRoleConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchUsersForTenantOptions = Parameters[0]; type searchUsersForTenantBody = (NonNullable extends { body?: infer B; } ? B : never); type searchUsersForTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type searchUsersForTenantInput = searchUsersForTenantBody & { tenantId: searchUsersForTenantPathParam_tenantId; }; /** Management of eventual consistency **/ type searchUsersForTenantConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchUserTaskAuditLogsOptions = Parameters[0]; type searchUserTaskAuditLogsBody = (NonNullable extends { body?: infer B; } ? B : never); type searchUserTaskAuditLogsPathParam_userTaskKey = (NonNullable extends { path: { userTaskKey: infer P; }; } ? P : any); type searchUserTaskAuditLogsInput = searchUserTaskAuditLogsBody & { userTaskKey: searchUserTaskAuditLogsPathParam_userTaskKey; }; /** Management of eventual consistency **/ type searchUserTaskAuditLogsConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchUserTaskEffectiveVariablesOptions = Parameters[0]; type searchUserTaskEffectiveVariablesBody = (NonNullable extends { body?: infer B; } ? B : never); type searchUserTaskEffectiveVariablesPathParam_userTaskKey = (NonNullable extends { path: { userTaskKey: infer P; }; } ? P : any); type searchUserTaskEffectiveVariablesQueryParam_truncateValues = (NonNullable extends { query?: { truncateValues?: infer Q; }; } ? Q : any); type searchUserTaskEffectiveVariablesInput = searchUserTaskEffectiveVariablesBody & { userTaskKey: searchUserTaskEffectiveVariablesPathParam_userTaskKey; truncateValues?: searchUserTaskEffectiveVariablesQueryParam_truncateValues; }; /** Management of eventual consistency **/ type searchUserTaskEffectiveVariablesConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchUserTasksOptions = Parameters[0]; type searchUserTasksBody = (NonNullable extends { body?: infer B; } ? B : never); type searchUserTasksInput = searchUserTasksBody; /** Management of eventual consistency **/ type searchUserTasksConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchUserTaskVariablesOptions = Parameters[0]; type searchUserTaskVariablesBody = (NonNullable extends { body?: infer B; } ? B : never); type searchUserTaskVariablesPathParam_userTaskKey = (NonNullable extends { path: { userTaskKey: infer P; }; } ? P : any); type searchUserTaskVariablesQueryParam_truncateValues = (NonNullable extends { query?: { truncateValues?: infer Q; }; } ? Q : any); type searchUserTaskVariablesInput = searchUserTaskVariablesBody & { userTaskKey: searchUserTaskVariablesPathParam_userTaskKey; truncateValues?: searchUserTaskVariablesQueryParam_truncateValues; }; /** Management of eventual consistency **/ type searchUserTaskVariablesConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type searchVariablesOptions = Parameters[0]; type searchVariablesBody = (NonNullable extends { body?: infer B; } ? B : never); type searchVariablesQueryParam_truncateValues = (NonNullable extends { query?: { truncateValues?: infer Q; }; } ? Q : any); type searchVariablesInput = searchVariablesBody & { truncateValues?: searchVariablesQueryParam_truncateValues; }; /** Management of eventual consistency **/ type searchVariablesConsistency = { /** Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. */ consistency: ConsistencyOptions<_DataOf>; }; type suspendBatchOperationOptions = Parameters[0]; type suspendBatchOperationBody = (NonNullable extends { body?: infer B; } ? B : never); type suspendBatchOperationPathParam_batchOperationKey = (NonNullable extends { path: { batchOperationKey: infer P; }; } ? P : any); type suspendBatchOperationInput = suspendBatchOperationBody & { batchOperationKey: suspendBatchOperationPathParam_batchOperationKey; }; type throwJobErrorOptions = Parameters[0]; type throwJobErrorBody = (NonNullable extends { body?: infer B; } ? B : never); type throwJobErrorPathParam_jobKey = (NonNullable extends { path: { jobKey: infer P; }; } ? P : any); type throwJobErrorInput = throwJobErrorBody & { jobKey: throwJobErrorPathParam_jobKey; }; type unassignClientFromGroupOptions = Parameters[0]; type unassignClientFromGroupPathParam_groupId = (NonNullable extends { path: { groupId: infer P; }; } ? P : any); type unassignClientFromGroupPathParam_clientId = (NonNullable extends { path: { clientId: infer P; }; } ? P : any); type unassignClientFromGroupInput = { groupId: unassignClientFromGroupPathParam_groupId; clientId: unassignClientFromGroupPathParam_clientId; }; type unassignClientFromTenantOptions = Parameters[0]; type unassignClientFromTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type unassignClientFromTenantPathParam_clientId = (NonNullable extends { path: { clientId: infer P; }; } ? P : any); type unassignClientFromTenantInput = { tenantId: unassignClientFromTenantPathParam_tenantId; clientId: unassignClientFromTenantPathParam_clientId; }; type unassignGroupFromTenantOptions = Parameters[0]; type unassignGroupFromTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type unassignGroupFromTenantPathParam_groupId = (NonNullable extends { path: { groupId: infer P; }; } ? P : any); type unassignGroupFromTenantInput = { tenantId: unassignGroupFromTenantPathParam_tenantId; groupId: unassignGroupFromTenantPathParam_groupId; }; type unassignMappingRuleFromGroupOptions = Parameters[0]; type unassignMappingRuleFromGroupPathParam_groupId = (NonNullable extends { path: { groupId: infer P; }; } ? P : any); type unassignMappingRuleFromGroupPathParam_mappingRuleId = (NonNullable extends { path: { mappingRuleId: infer P; }; } ? P : any); type unassignMappingRuleFromGroupInput = { groupId: unassignMappingRuleFromGroupPathParam_groupId; mappingRuleId: unassignMappingRuleFromGroupPathParam_mappingRuleId; }; type unassignMappingRuleFromTenantOptions = Parameters[0]; type unassignMappingRuleFromTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type unassignMappingRuleFromTenantPathParam_mappingRuleId = (NonNullable extends { path: { mappingRuleId: infer P; }; } ? P : any); type unassignMappingRuleFromTenantInput = { tenantId: unassignMappingRuleFromTenantPathParam_tenantId; mappingRuleId: unassignMappingRuleFromTenantPathParam_mappingRuleId; }; type unassignRoleFromClientOptions = Parameters[0]; type unassignRoleFromClientPathParam_roleId = (NonNullable extends { path: { roleId: infer P; }; } ? P : any); type unassignRoleFromClientPathParam_clientId = (NonNullable extends { path: { clientId: infer P; }; } ? P : any); type unassignRoleFromClientInput = { roleId: unassignRoleFromClientPathParam_roleId; clientId: unassignRoleFromClientPathParam_clientId; }; type unassignRoleFromGroupOptions = Parameters[0]; type unassignRoleFromGroupPathParam_roleId = (NonNullable extends { path: { roleId: infer P; }; } ? P : any); type unassignRoleFromGroupPathParam_groupId = (NonNullable extends { path: { groupId: infer P; }; } ? P : any); type unassignRoleFromGroupInput = { roleId: unassignRoleFromGroupPathParam_roleId; groupId: unassignRoleFromGroupPathParam_groupId; }; type unassignRoleFromMappingRuleOptions = Parameters[0]; type unassignRoleFromMappingRulePathParam_roleId = (NonNullable extends { path: { roleId: infer P; }; } ? P : any); type unassignRoleFromMappingRulePathParam_mappingRuleId = (NonNullable extends { path: { mappingRuleId: infer P; }; } ? P : any); type unassignRoleFromMappingRuleInput = { roleId: unassignRoleFromMappingRulePathParam_roleId; mappingRuleId: unassignRoleFromMappingRulePathParam_mappingRuleId; }; type unassignRoleFromTenantOptions = Parameters[0]; type unassignRoleFromTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type unassignRoleFromTenantPathParam_roleId = (NonNullable extends { path: { roleId: infer P; }; } ? P : any); type unassignRoleFromTenantInput = { tenantId: unassignRoleFromTenantPathParam_tenantId; roleId: unassignRoleFromTenantPathParam_roleId; }; type unassignRoleFromUserOptions = Parameters[0]; type unassignRoleFromUserPathParam_roleId = (NonNullable extends { path: { roleId: infer P; }; } ? P : any); type unassignRoleFromUserPathParam_username = (NonNullable extends { path: { username: infer P; }; } ? P : any); type unassignRoleFromUserInput = { roleId: unassignRoleFromUserPathParam_roleId; username: unassignRoleFromUserPathParam_username; }; type unassignUserFromGroupOptions = Parameters[0]; type unassignUserFromGroupPathParam_groupId = (NonNullable extends { path: { groupId: infer P; }; } ? P : any); type unassignUserFromGroupPathParam_username = (NonNullable extends { path: { username: infer P; }; } ? P : any); type unassignUserFromGroupInput = { groupId: unassignUserFromGroupPathParam_groupId; username: unassignUserFromGroupPathParam_username; }; type unassignUserFromTenantOptions = Parameters[0]; type unassignUserFromTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type unassignUserFromTenantPathParam_username = (NonNullable extends { path: { username: infer P; }; } ? P : any); type unassignUserFromTenantInput = { tenantId: unassignUserFromTenantPathParam_tenantId; username: unassignUserFromTenantPathParam_username; }; type unassignUserTaskOptions = Parameters[0]; type unassignUserTaskPathParam_userTaskKey = (NonNullable extends { path: { userTaskKey: infer P; }; } ? P : any); type unassignUserTaskInput = { userTaskKey: unassignUserTaskPathParam_userTaskKey; }; type updateAuthorizationOptions = Parameters[0]; type updateAuthorizationBody = (NonNullable extends { body?: infer B; } ? B : never); type updateAuthorizationPathParam_authorizationKey = (NonNullable extends { path: { authorizationKey: infer P; }; } ? P : any); type updateAuthorizationInput = updateAuthorizationBody & { authorizationKey: updateAuthorizationPathParam_authorizationKey; }; type updateGlobalClusterVariableOptions = Parameters[0]; type updateGlobalClusterVariableBody = (NonNullable extends { body?: infer B; } ? B : never); type updateGlobalClusterVariablePathParam_name = (NonNullable extends { path: { name: infer P; }; } ? P : any); type updateGlobalClusterVariableInput = updateGlobalClusterVariableBody & { name: updateGlobalClusterVariablePathParam_name; }; type updateGlobalTaskListenerOptions = Parameters[0]; type updateGlobalTaskListenerBody = (NonNullable extends { body?: infer B; } ? B : never); type updateGlobalTaskListenerPathParam_id = (NonNullable extends { path: { id: infer P; }; } ? P : any); type updateGlobalTaskListenerInput = updateGlobalTaskListenerBody & { id: updateGlobalTaskListenerPathParam_id; }; type updateGroupOptions = Parameters[0]; type updateGroupBody = (NonNullable extends { body?: infer B; } ? B : never); type updateGroupPathParam_groupId = (NonNullable extends { path: { groupId: infer P; }; } ? P : any); type updateGroupInput = updateGroupBody & { groupId: updateGroupPathParam_groupId; }; type updateJobOptions = Parameters[0]; type updateJobBody = (NonNullable extends { body?: infer B; } ? B : never); type updateJobPathParam_jobKey = (NonNullable extends { path: { jobKey: infer P; }; } ? P : any); type updateJobInput = updateJobBody & { jobKey: updateJobPathParam_jobKey; }; type updateMappingRuleOptions = Parameters[0]; type updateMappingRuleBody = (NonNullable extends { body?: infer B; } ? B : never); type updateMappingRulePathParam_mappingRuleId = (NonNullable extends { path: { mappingRuleId: infer P; }; } ? P : any); type updateMappingRuleInput = updateMappingRuleBody & { mappingRuleId: updateMappingRulePathParam_mappingRuleId; }; type updateRoleOptions = Parameters[0]; type updateRoleBody = (NonNullable extends { body?: infer B; } ? B : never); type updateRolePathParam_roleId = (NonNullable extends { path: { roleId: infer P; }; } ? P : any); type updateRoleInput = updateRoleBody & { roleId: updateRolePathParam_roleId; }; type updateTenantOptions = Parameters[0]; type updateTenantBody = (NonNullable extends { body?: infer B; } ? B : never); type updateTenantPathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type updateTenantInput = updateTenantBody & { tenantId: updateTenantPathParam_tenantId; }; type updateTenantClusterVariableOptions = Parameters[0]; type updateTenantClusterVariableBody = (NonNullable extends { body?: infer B; } ? B : never); type updateTenantClusterVariablePathParam_tenantId = (NonNullable extends { path: { tenantId: infer P; }; } ? P : any); type updateTenantClusterVariablePathParam_name = (NonNullable extends { path: { name: infer P; }; } ? P : any); type updateTenantClusterVariableInput = updateTenantClusterVariableBody & { tenantId: updateTenantClusterVariablePathParam_tenantId; name: updateTenantClusterVariablePathParam_name; }; type updateUserOptions = Parameters[0]; type updateUserBody = (NonNullable extends { body?: infer B; } ? B : never); type updateUserPathParam_username = (NonNullable extends { path: { username: infer P; }; } ? P : any); type updateUserInput = updateUserBody & { username: updateUserPathParam_username; }; type updateUserTaskOptions = Parameters[0]; type updateUserTaskBody = (NonNullable extends { body?: infer B; } ? B : never); type updateUserTaskPathParam_userTaskKey = (NonNullable extends { path: { userTaskKey: infer P; }; } ? P : any); type updateUserTaskInput = updateUserTaskBody & { userTaskKey: updateUserTaskPathParam_userTaskKey; }; /** Extended deployment result with typed buckets for direct access to deployed artifacts. */ interface ExtendedDeploymentResult extends _DataOf { processes: Array["deployments"][number]["processDefinition"]>>; decisions: Array["deployments"][number]["decisionDefinition"]>>; decisionRequirements: Array["deployments"][number]["decisionRequirements"]>>; forms: Array["deployments"][number]["form"]>>; resources: Array["deployments"][number]["resource"]>>; } declare class CancelError extends Error { constructor(); } interface CancelablePromise extends Promise { cancel(): void; } interface CamundaOptions { config?: EnvOverrides; fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise; env?: Record; log?: { level?: LogLevel; transport?: LogTransport; }; telemetry?: { hooks?: TelemetryHooks; correlation?: boolean; mirrorToLog?: boolean; }; throwOnError?: boolean; supportLogger?: SupportLogger; } declare function createCamundaClient(options?: CamundaOptions): CamundaClient; declare class CamundaClient { private _client; private _config; private _auth; private _baseFetch?; private _fetch?; private _validation; private _log; private _bp; /** Registered job workers created via createJobWorker (lifecycle managed by user). */ private _workers; /** Shared thread pool for all threaded job workers (lazy-initialised on first use). */ private _threadPool; /** Support logger (Node-only; no-op in browser). */ private _supportLogger; private readonly _errorMode; private _overrides; constructor(opts?: CamundaOptions); get config(): Readonly; /** * Read-only snapshot of current hydrated configuration (do not mutate directly). * Use configure(...) to apply changes. */ getConfig(): Readonly; configure(next: CamundaOptions): void; getAuthHeaders(): Promise>; forceAuthRefresh(): Promise; clearAuthCache(opts?: { disk?: boolean; memory?: boolean; }): void; onAuthHeaders(h: (headers: Record) => Record | Promise>): void; /** @internal ValidationManager is internal; tests may reach via (client as any)._validation */ /** Access a scoped logger (internal & future user emission). */ logger(scope?: string): Logger; /** Internal accessor (read-only) for eventual consistency error mode. */ getErrorMode(): 'throw' | 'result'; /** Internal accessor for support logger (no public API commitment yet). */ _getSupportLogger(): SupportLogger; /** * Emit the standard support log preamble & redacted configuration to the current support logger. * Safe to call multiple times; subsequent calls are ignored (idempotent). * Useful when a custom supportLogger was injected and you still want the canonical header & config dump. */ emitSupportLogPreamble(): void; withCorrelation(id: string, fn: () => Promise | T): Promise; private _isVoidResponse; private _schemasPromise; private _loadSchemas; /** Internal invocation helper to apply global backpressure gating + retry + normalization */ _invokeWithRetry(op: () => Promise, opts: { opId: string; exempt?: boolean; classify?: (e: any) => { retryable: boolean; reason: string; }; retryOverride?: Partial | false; }): Promise; /** Shared evaluation for raw transport responses (throwOnError:false) */ private _evaluateResponse; /** Public accessor for current backpressure adaptive limiter state (stable) */ getBackpressureState(): { severity: BackpressureSeverity; consecutive: number; permitsMax: number | null; permitsCurrent: number; waiters: number; backoffMs: number; } | { severity: string; permitsMax: null; permitsCurrent: number; consecutive: number; waiters: number; }; /** Return a read-only snapshot of currently registered job workers. */ getWorkers(): any[]; /** Stop all registered job workers (best-effort) and terminate the shared thread pool. */ stopAllWorkers(): void; /** Get or lazily create the shared thread pool for threaded job workers. */ private _getOrCreateThreadPool; /** * Activate activities within an ad-hoc sub-process * * Activates selected activities within an ad-hoc sub-process identified by element ID. * The provided element IDs must exist within the ad-hoc sub-process instance identified by the * provided adHocSubProcessInstanceKey. * * * @example Activate ad-hoc sub-process activities * ```ts * async function activateAdHocSubProcessActivitiesExample( * adHocSubProcessInstanceKey: ElementInstanceKey, * elementId: ElementId * ) { * const camunda = createCamundaClient(); * * await camunda.activateAdHocSubProcessActivities({ * adHocSubProcessInstanceKey, * elements: [{ elementId }], * }); * } * ``` * @operationId activateAdHocSubProcessActivities * @tags Ad-hoc sub-process */ activateAdHocSubProcessActivities(input: activateAdHocSubProcessActivitiesInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Activate jobs * * Iterate through all known partitions and activate jobs up to the requested maximum. * * * @example Activate and process jobs * ```ts * async function activateJobsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.activateJobs({ * type: 'payment-processing', * timeout: 30000, * maxJobsToActivate: 5, * }); * * for (const job of result.jobs) { * console.log(`Job ${job.jobKey}: ${job.type}`); * * // Each enriched job has helper methods * await job.complete({ paymentId: 'PAY-123' }); * } * } * ``` * @operationId activateJobs * @tags Job */ activateJobs(input: activateJobsInput, options?: OperationOptions): CancelablePromise<{ jobs: EnrichedActivatedJob[]; }>; /** * Assign a client to a group * * Assigns a client to a group, making it a member of the group. * Members of the group inherit the group authorizations, roles, and tenant assignments. * * * @example Assign a client to a group * ```ts * async function assignClientToGroupExample() { * const camunda = createCamundaClient(); * * await camunda.assignClientToGroup({ * groupId: 'engineering-team', * clientId: 'my-service-account', * }); * } * ``` * @operationId assignClientToGroup * @tags Group */ assignClientToGroup(input: assignClientToGroupInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Assign a client to a tenant * * Assign the client to the specified tenant. * The client can then access tenant data and perform authorized actions. * * * @example Assign a client to a tenant * ```ts * async function assignClientToTenantExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * await camunda.assignClientToTenant({ * tenantId, * clientId: 'my-service-account', * }); * } * ``` * @operationId assignClientToTenant * @tags Tenant */ assignClientToTenant(input: assignClientToTenantInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Assign a group to a tenant * * Assigns a group to a specified tenant. * Group members (users, clients) can then access tenant data and perform authorized actions. * * * @example Assign a group to a tenant * ```ts * async function assignGroupToTenantExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * await camunda.assignGroupToTenant({ * tenantId, * groupId: 'engineering-team', * }); * } * ``` * @operationId assignGroupToTenant * @tags Tenant */ assignGroupToTenant(input: assignGroupToTenantInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Assign a mapping rule to a group * * Assigns a mapping rule to a group. * * @example Assign a mapping rule to a group * ```ts * async function assignMappingRuleToGroupExample() { * const camunda = createCamundaClient(); * * await camunda.assignMappingRuleToGroup({ * groupId: 'engineering-team', * mappingRuleId: 'rule-123', * }); * } * ``` * @operationId assignMappingRuleToGroup * @tags Group */ assignMappingRuleToGroup(input: assignMappingRuleToGroupInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Assign a mapping rule to a tenant * * Assign a single mapping rule to a specified tenant. * * @example Assign a mapping rule to a tenant * ```ts * async function assignMappingRuleToTenantExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * await camunda.assignMappingRuleToTenant({ * tenantId, * mappingRuleId: 'rule-123', * }); * } * ``` * @operationId assignMappingRuleToTenant * @tags Tenant */ assignMappingRuleToTenant(input: assignMappingRuleToTenantInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Assign a role to a client * * Assigns the specified role to the client. The client will inherit the authorizations associated with this role. * * @example Assign a role to a client * ```ts * async function assignRoleToClientExample() { * const camunda = createCamundaClient(); * * await camunda.assignRoleToClient({ * roleId: 'process-admin', * clientId: 'my-service-account', * }); * } * ``` * @operationId assignRoleToClient * @tags Role */ assignRoleToClient(input: assignRoleToClientInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Assign a role to a group * * Assigns the specified role to the group. Every member of the group (user or client) will inherit the authorizations associated with this role. * * @example Assign a role to a group * ```ts * async function assignRoleToGroupExample() { * const camunda = createCamundaClient(); * * await camunda.assignRoleToGroup({ * roleId: 'process-admin', * groupId: 'engineering-team', * }); * } * ``` * @operationId assignRoleToGroup * @tags Role */ assignRoleToGroup(input: assignRoleToGroupInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Assign a role to a mapping rule * * Assigns a role to a mapping rule. * * @example Assign a role to a mapping rule * ```ts * async function assignRoleToMappingRuleExample() { * const camunda = createCamundaClient(); * * await camunda.assignRoleToMappingRule({ * roleId: 'process-admin', * mappingRuleId: 'rule-123', * }); * } * ``` * @operationId assignRoleToMappingRule * @tags Role */ assignRoleToMappingRule(input: assignRoleToMappingRuleInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Assign a role to a tenant * * Assigns a role to a specified tenant. * 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. * * * @example Assign a role to a tenant * ```ts * async function assignRoleToTenantExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * await camunda.assignRoleToTenant({ * tenantId, * roleId: 'process-admin', * }); * } * ``` * @operationId assignRoleToTenant * @tags Tenant */ assignRoleToTenant(input: assignRoleToTenantInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Assign a role to a user * * Assigns the specified role to the user. The user will inherit the authorizations associated with this role. * * @example Assign a role to a user * ```ts * async function assignRoleToUserExample(username: Username) { * const camunda = createCamundaClient(); * * await camunda.assignRoleToUser({ * roleId: 'process-admin', * username, * }); * } * ``` * @operationId assignRoleToUser * @tags Role */ assignRoleToUser(input: assignRoleToUserInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Assign user task * * Assigns a user task with the given key to the given assignee. Assignment waits for blocking task listeners on this lifecycle transition. If listener processing is delayed beyond the request timeout, this endpoint can return 504. Other gateway timeout causes are also possible. Retry with backoff and inspect listener worker availability and logs when this repeats. * * * @example Assign a user task * ```ts * async function assignUserTaskExample(userTaskKey: UserTaskKey) { * const camunda = createCamundaClient(); * * await camunda.assignUserTask({ * userTaskKey, * assignee: 'alice', * allowOverride: true, * }); * } * ``` * @operationId assignUserTask * @tags User task */ assignUserTask(input: assignUserTaskInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Assign a user to a group * * Assigns a user to a group, making the user a member of the group. * Group members inherit the group authorizations, roles, and tenant assignments. * * * @example Assign a user to a group * ```ts * async function assignUserToGroupExample(username: Username) { * const camunda = createCamundaClient(); * * await camunda.assignUserToGroup({ * groupId: 'engineering-team', * username, * }); * } * ``` * @operationId assignUserToGroup * @tags Group */ assignUserToGroup(input: assignUserToGroupInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Assign a user to a tenant * * Assign a single user to a specified tenant. The user can then access tenant data and perform authorized actions. * * @example Assign a user to a tenant * ```ts * async function assignUserToTenantExample(tenantId: TenantId, username: Username) { * const camunda = createCamundaClient(); * * await camunda.assignUserToTenant({ * tenantId, * username, * }); * } * ``` * @operationId assignUserToTenant * @tags Tenant */ assignUserToTenant(input: assignUserToTenantInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Broadcast signal * * Broadcasts a signal. * * @example Broadcast a signal * ```ts * async function broadcastSignalExample() { * const camunda = createCamundaClient(); * * const result = await camunda.broadcastSignal({ * signalName: 'system-shutdown', * variables: { * reason: 'Scheduled maintenance', * }, * }); * * console.log(`Signal broadcast key: ${result.signalKey}`); * } * ``` * @operationId broadcastSignal * @tags Signal */ broadcastSignal(input: broadcastSignalInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Cancel Batch operation * * Cancels a running batch operation. * This is done asynchronously, the progress can be tracked using the batch operation status endpoint (/batch-operations/{batchOperationKey}). * * * @example Cancel a batch operation * ```ts * async function cancelBatchOperationExample(batchOperationKey: BatchOperationKey) { * const camunda = createCamundaClient(); * * await camunda.cancelBatchOperation({ batchOperationKey }); * } * ``` * @operationId cancelBatchOperation * @tags Batch operation */ cancelBatchOperation(input: cancelBatchOperationInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Cancel process instance * * 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. Cancellation can wait on listener-related processing; when that processing does not complete in time, this endpoint can return 504. Other gateway timeout causes are also possible. Retry with backoff and inspect listener worker availability and logs when this repeats. * * * @example Cancel a process instance * ```ts * async function cancelProcessInstanceExample(processDefinitionId: ProcessDefinitionId) { * const camunda = createCamundaClient(); * * // Create a process instance and get its key from the response * const created = await camunda.createProcessInstance({ * processDefinitionId, * }); * * // Cancel the process instance using the key from the creation response * await camunda.cancelProcessInstance({ * processInstanceKey: created.processInstanceKey, * }); * } * ``` * @operationId cancelProcessInstance * @tags Process instance */ cancelProcessInstance(input: cancelProcessInstanceInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Cancel process instances (batch) * * Cancels multiple running process instances. * Since only ACTIVE root instances can be cancelled, any given filters for state and * parentProcessInstanceKey are ignored and overridden during this batch operation. * This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}). * * * @example Cancel process instances in batch * ```ts * async function cancelProcessInstancesBatchOperationExample( * processDefinitionKey: ProcessDefinitionKey * ) { * const camunda = createCamundaClient(); * * const result = await camunda.cancelProcessInstancesBatchOperation({ * filter: { * processDefinitionKey, * }, * }); * * console.log(`Batch operation key: ${result.batchOperationKey}`); * } * ``` * @operationId cancelProcessInstancesBatchOperation * @tags Process instance */ cancelProcessInstancesBatchOperation(input: cancelProcessInstancesBatchOperationInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Complete job * * Complete a job with the given payload, which allows completing the associated service task. * * * @example Complete a job * ```ts * async function completeJobExample(jobKey: JobKey) { * const camunda = createCamundaClient(); * * await camunda.completeJob({ * jobKey, * variables: { * paymentId: 'PAY-123', * status: 'completed', * }, * }); * } * ``` * @operationId completeJob * @tags Job */ completeJob(input: completeJobInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Complete user task * * Completes a user task with the given key. Completion waits for blocking task listeners on this lifecycle transition. If listener processing is delayed beyond the request timeout, this endpoint can return 504. Other gateway timeout causes are also possible. Retry with backoff and inspect listener worker availability and logs when this repeats. * * * @example Complete a user task * ```ts * async function completeUserTaskExample(userTaskKey: UserTaskKey) { * const camunda = createCamundaClient(); * * await camunda.completeUserTask({ * userTaskKey, * variables: { * approved: true, * comment: 'Looks good', * }, * }); * } * ``` * @operationId completeUserTask * @tags User task */ completeUserTask(input: completeUserTaskInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Correlate message * * Publishes a message and correlates it to a subscription. * If correlation is successful it will return the first process instance key the message correlated with. * The message is not buffered. * Use the publish message endpoint to send messages that can be buffered. * * * @example Correlate a message * ```ts * async function correlateMessageExample() { * const camunda = createCamundaClient(); * * const result = await camunda.correlateMessage({ * name: 'order-payment-received', * correlationKey: 'ORD-12345', * variables: { * paymentId: 'PAY-123', * amount: 99.95, * }, * }); * * console.log(`Message correlated to: ${result.processInstanceKey}`); * } * ``` * @operationId correlateMessage * @tags Message */ correlateMessage(input: correlateMessageInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Create admin user * * 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. * * @example Create an admin user * ```ts * async function createAdminUserExample(username: Username) { * const camunda = createCamundaClient(); * * const result = await camunda.createAdminUser({ * username, * name: 'Admin User', * email: 'admin@example.com', * password: 'admin-password-123', * }); * * console.log(`Created admin user: ${result.username}`); * } * ``` * @operationId createAdminUser * @tags Setup */ createAdminUser(input: createAdminUserInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Create authorization * * Create the authorization. * * @example Create an authorization * ```ts * async function createAuthorizationExample() { * const camunda = createCamundaClient(); * * const result = await camunda.createAuthorization({ * ownerId: 'user-123', * ownerType: 'USER', * resourceId: 'order-process', * resourceType: 'PROCESS_DEFINITION', * permissionTypes: ['CREATE_PROCESS_INSTANCE', 'READ_PROCESS_INSTANCE'], * }); * * console.log(`Authorization key: ${result.authorizationKey}`); * } * ``` * @operationId createAuthorization * @tags Authorization */ createAuthorization(input: createAuthorizationInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Deploy resources * * Deploys one or more resources (e.g. processes, decision models, or forms). * This is an atomic call, i.e. either all resources are deployed or none of them are. * * * @example Deploy resources from files * ```ts * async function deployResourcesFromFilesExample() { * const camunda = createCamundaClient(); * * // Node.js only: deploy directly from file paths * const result = await camunda.deployResourcesFromFiles(['./process.bpmn', './decision.dmn']); * * console.log(`Deployment key: ${result.deploymentKey}`); * } * ``` * @operationId createDeployment * @tags Resource * @returns Enriched deployment result with typed arrays (processes, decisions, decisionRequirements, forms, resources). */ createDeployment(input: createDeploymentInput, options?: OperationOptions): CancelablePromise; /** * Upload document * * Upload a document to the Camunda 8 cluster. * * Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production) * * * @example Upload a document * ```ts * async function createDocumentExample() { * const camunda = createCamundaClient(); * * const file = new Blob(['Hello, world!'], { type: 'text/plain' }); * * const result = await camunda.createDocument({ * file, * metadata: { fileName: 'hello.txt' }, * }); * * console.log(`Document ID: ${result.documentId}`); * } * ``` * @operationId createDocument * @tags Document */ createDocument(input: createDocumentInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Create document link * * Create a link to a document in the Camunda 8 cluster. * * Note that this is currently supported for document stores of type: AWS, GCP * * * @example Create a document link * ```ts * async function createDocumentLinkExample(documentId: DocumentId) { * const camunda = createCamundaClient(); * * const link = await camunda.createDocumentLink({ * documentId, * timeToLive: 3600000, * }); * * console.log(`Document link: ${link.url}`); * } * ``` * @operationId createDocumentLink * @tags Document */ createDocumentLink(input: createDocumentLinkInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Upload multiple documents * * Upload multiple documents to the Camunda 8 cluster. * * The caller must provide a file name for each document, which will be used in case of a multi-status response * to identify which documents failed to upload. The file name can be provided in the `Content-Disposition` header * of the file part or in the `fileName` field of the metadata. You can add a parallel array of metadata objects. These * are matched with the files based on index, and must have the same length as the files array. * To pass homogenous metadata for all files, spread the metadata over the metadata array. * A filename value provided explicitly via the metadata array in the request overrides the `Content-Disposition` header * of the file part. * * In case of a multi-status response, the response body will contain a list of `DocumentBatchProblemDetail` objects, * each of which contains the file name of the document that failed to upload and the reason for the failure. * The client can choose to retry the whole batch or individual documents based on the response. * * Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production) * * * @example Upload multiple documents * ```ts * async function createDocumentsExample() { * const camunda = createCamundaClient(); * * const file1 = new Blob(['File one'], { type: 'text/plain' }); * const file2 = new Blob(['File two'], { type: 'text/plain' }); * * const result = await camunda.createDocuments({ * files: [file1, file2], * metadataList: [{ fileName: 'one.txt' }, { fileName: 'two.txt' }], * }); * * for (const doc of result.createdDocuments ?? []) { * console.log(`Created: ${doc.documentId}`); * } * } * ``` * @operationId createDocuments * @tags Document */ createDocuments(input: createDocumentsInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Update element instance variables * * Updates all the variables of a particular scope (for example, process instance, element instance) with the given variable data. * Specify the element instance in the `elementInstanceKey` parameter. * Variable updates can be delayed by listener-related processing; if processing exceeds the * request timeout, this endpoint can return 504. Other gateway timeout causes are also * possible. Retry with backoff and inspect listener worker availability and logs when this * repeats. * * * @example Create element instance variables * ```ts * async function createElementInstanceVariablesExample(elementInstanceKey: ElementInstanceKey) { * const camunda = createCamundaClient(); * * await camunda.createElementInstanceVariables({ * elementInstanceKey, * variables: { orderId: 'ORD-12345', status: 'processing' }, * }); * } * ``` * @operationId createElementInstanceVariables * @tags Element instance */ createElementInstanceVariables(input: createElementInstanceVariablesInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Create a global-scoped cluster variable * * Create a global-scoped cluster variable. * * @example Create a global cluster variable * ```ts * async function createGlobalClusterVariableExample() { * const camunda = createCamundaClient(); * * const result = await camunda.createGlobalClusterVariable({ * name: 'feature-flags', * value: { darkMode: true }, * }); * * console.log(`Created: ${result.name}`); * } * ``` * @operationId createGlobalClusterVariable * @tags Cluster Variable */ createGlobalClusterVariable(input: createGlobalClusterVariableInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Create global user task listener * * Create a new global user task listener. * * @example Create a global task listener * ```ts * async function createGlobalTaskListenerExample(id: GlobalListenerId) { * const camunda = createCamundaClient(); * * const result = await camunda.createGlobalTaskListener({ * id, * eventTypes: ['completing'], * type: 'audit-log-listener', * }); * * console.log(`Created listener: ${result.id}`); * } * ``` * @operationId createGlobalTaskListener * @tags Global listener */ createGlobalTaskListener(input: createGlobalTaskListenerInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Create group * * Create a new group. * * @example Create a group * ```ts * async function createGroupExample() { * const camunda = createCamundaClient(); * * const result = await camunda.createGroup({ * groupId: 'engineering-team', * name: 'Engineering Team', * }); * * console.log(`Created group: ${result.groupId}`); * } * ``` * @operationId createGroup * @tags Group */ createGroup(input: createGroupInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Create mapping rule * * Create a new mapping rule * * * @example Create a mapping rule * ```ts * async function createMappingRuleExample() { * const camunda = createCamundaClient(); * * const result = await camunda.createMappingRule({ * mappingRuleId: 'ldap-group-mapping', * name: 'LDAP Group Mapping', * claimName: 'groups', * claimValue: 'engineering', * }); * * console.log(`Created mapping rule: ${result.mappingRuleId}`); * } * ``` * @operationId createMappingRule * @tags Mapping rule */ createMappingRule(input: createMappingRuleInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Create process instance * * Creates and starts an instance of the specified process. * The process definition to use to create the instance can be specified either using its unique key * (as returned by Deploy resources), or using the BPMN process id and a version. * * Waits for the completion of the process instance before returning a result * when awaitCompletion is enabled. * * * @example By ID * ```ts * async function createProcessInstanceByIdExample(processDefinitionId: ProcessDefinitionId) { * const camunda = createCamundaClient(); * * const result = await camunda.createProcessInstance({ * processDefinitionId, * variables: { * orderId: 'ORD-12345', * amount: 99.95, * }, * }); * * console.log(`Started process instance: ${result.processInstanceKey}`); * } * ``` * @example By key * ```ts * async function createProcessInstanceByKeyExample(processDefinitionKey: ProcessDefinitionKey) { * const camunda = createCamundaClient(); * * // Key from a previous API response (e.g. deployment) * const result = await camunda.createProcessInstance({ * processDefinitionKey, * variables: { * orderId: 'ORD-12345', * amount: 99.95, * }, * }); * * console.log(`Started process instance: ${result.processInstanceKey}`); * } * ``` * @operationId createProcessInstance * @tags Process instance */ createProcessInstance(input: createProcessInstanceInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Create role * * Create a new role. * * @example Create a role * ```ts * async function createRoleExample() { * const camunda = createCamundaClient(); * * const result = await camunda.createRole({ * roleId: 'process-admin', * name: 'Process Admin', * }); * * console.log(`Created role: ${result.roleId}`); * } * ``` * @operationId createRole * @tags Role */ createRole(input: createRoleInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Create tenant * * Creates a new tenant. * * @example Create a tenant * ```ts * async function createTenantExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * const result = await camunda.createTenant({ * tenantId, * name: 'Customer Service', * }); * * console.log(`Created tenant: ${result.tenantId}`); * } * ``` * @operationId createTenant * @tags Tenant */ createTenant(input: createTenantInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Create a tenant-scoped cluster variable * * Create a new cluster variable for the given tenant. * * @example Create a tenant cluster variable * ```ts * async function createTenantClusterVariableExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * const result = await camunda.createTenantClusterVariable({ * tenantId, * name: 'config', * value: { region: 'us-east-1' }, * }); * * console.log(`Created: ${result.name}`); * } * ``` * @operationId createTenantClusterVariable * @tags Cluster Variable */ createTenantClusterVariable(input: createTenantClusterVariableInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Create user * * Create a new user. * * @example Create a user * ```ts * async function createUserExample(username: Username) { * const camunda = createCamundaClient(); * * const result = await camunda.createUser({ * username, * name: 'Alice Smith', * email: 'alice@example.com', * password: 'secure-password-123', * }); * * console.log(`Created user: ${result.username}`); * } * ``` * @operationId createUser * @tags User */ createUser(input: createUserInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Delete authorization * * Deletes the authorization with the given key. * * @example Delete an authorization * ```ts * async function deleteAuthorizationExample(authorizationKey: AuthorizationKey) { * const camunda = createCamundaClient(); * * await camunda.deleteAuthorization({ authorizationKey }); * } * ``` * @operationId deleteAuthorization * @tags Authorization */ deleteAuthorization(input: deleteAuthorizationInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Delete decision instance * * Delete all associated decision evaluations based on provided key. * * @example Delete a decision instance * ```ts * async function deleteDecisionInstanceExample(decisionEvaluationKey: DecisionEvaluationKey) { * const camunda = createCamundaClient(); * * await camunda.deleteDecisionInstance({ decisionEvaluationKey }); * } * ``` * @operationId deleteDecisionInstance * @tags Decision instance */ deleteDecisionInstance(input: deleteDecisionInstanceInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Delete decision instances (batch) * * Delete multiple decision instances. This will delete the historic data from secondary storage. * This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}). * * * @example Delete decision instances in batch * ```ts * async function deleteDecisionInstancesBatchOperationExample() { * const camunda = createCamundaClient(); * * const result = await camunda.deleteDecisionInstancesBatchOperation({ * filter: {}, * }); * * console.log(`Batch operation key: ${result.batchOperationKey}`); * } * ``` * @operationId deleteDecisionInstancesBatchOperation * @tags Decision instance */ deleteDecisionInstancesBatchOperation(input: deleteDecisionInstancesBatchOperationInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Delete document * * Delete a document from the Camunda 8 cluster. * * Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production) * * * @example Delete a document * ```ts * async function deleteDocumentExample(documentId: DocumentId) { * const camunda = createCamundaClient(); * * await camunda.deleteDocument({ documentId }); * } * ``` * @operationId deleteDocument * @tags Document */ deleteDocument(input: deleteDocumentInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Delete a global-scoped cluster variable * * Delete a global-scoped cluster variable. * * @example Delete a global cluster variable * ```ts * async function deleteGlobalClusterVariableExample() { * const camunda = createCamundaClient(); * * await camunda.deleteGlobalClusterVariable({ name: 'feature-flags' }); * } * ``` * @operationId deleteGlobalClusterVariable * @tags Cluster Variable */ deleteGlobalClusterVariable(input: deleteGlobalClusterVariableInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Delete global user task listener * * Deletes a global user task listener. * * @example Delete a global task listener * ```ts * async function deleteGlobalTaskListenerExample(id: GlobalListenerId) { * const camunda = createCamundaClient(); * * await camunda.deleteGlobalTaskListener({ * id, * }); * } * ``` * @operationId deleteGlobalTaskListener * @tags Global listener */ deleteGlobalTaskListener(input: deleteGlobalTaskListenerInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Delete group * * Deletes the group with the given ID. * * @example Delete a group * ```ts * async function deleteGroupExample() { * const camunda = createCamundaClient(); * * await camunda.deleteGroup({ groupId: 'engineering-team' }); * } * ``` * @operationId deleteGroup * @tags Group */ deleteGroup(input: deleteGroupInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Delete a mapping rule * * Deletes the mapping rule with the given ID. * * * @example Delete a mapping rule * ```ts * async function deleteMappingRuleExample() { * const camunda = createCamundaClient(); * * await camunda.deleteMappingRule({ mappingRuleId: 'ldap-group-mapping' }); * } * ``` * @operationId deleteMappingRule * @tags Mapping rule */ deleteMappingRule(input: deleteMappingRuleInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Delete process instance * * Deletes a process instance. Only instances that are completed or terminated can be deleted. * * @example Delete a process instance * ```ts * async function deleteProcessInstanceExample(processInstanceKey: ProcessInstanceKey) { * const camunda = createCamundaClient(); * * await camunda.deleteProcessInstance({ processInstanceKey }); * } * ``` * @operationId deleteProcessInstance * @tags Process instance */ deleteProcessInstance(input: deleteProcessInstanceInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Delete process instances (batch) * * Delete multiple process instances. This will delete the historic data from secondary storage. * Only process instances in a final state (COMPLETED or TERMINATED) can be deleted. * This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}). * * * @example Delete process instances in batch * ```ts * async function deleteProcessInstancesBatchOperationExample( * processDefinitionKey: ProcessDefinitionKey * ) { * const camunda = createCamundaClient(); * * const result = await camunda.deleteProcessInstancesBatchOperation({ * filter: { * processDefinitionKey, * }, * }); * * console.log(`Batch operation key: ${result.batchOperationKey}`); * } * ``` * @operationId deleteProcessInstancesBatchOperation * @tags Process instance */ deleteProcessInstancesBatchOperation(input: deleteProcessInstancesBatchOperationInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Delete resource * * Deletes a deployed resource. This can be a process definition, decision requirements * definition, or form definition deployed using the deploy resources endpoint. Specify the * resource you want to delete in the `resourceKey` parameter. * * Once a resource has been deleted it cannot be recovered. If the resource needs to be * available again, a new deployment of the resource is required. * * By default, only the resource itself is deleted from the runtime state. To also delete the * historic data associated with a resource, set the `deleteHistory` flag in the request body * to `true`. The historic data is deleted asynchronously via a batch operation. The details of * the created batch operation are included in the response. Note that history deletion is only * supported for process resources; for other resource types this flag is ignored and no history * will be deleted. * * @example Delete a resource * ```ts * async function deleteResourceExample(resourceKey: ProcessDefinitionKey) { * const camunda = createCamundaClient(); * * // Use a process definition key as a resource key for deletion * await camunda.deleteResource({ * resourceKey, * }); * } * ``` * @operationId deleteResource * @tags Resource */ deleteResource(input: deleteResourceInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Delete role * * Deletes the role with the given ID. * * @example Delete a role * ```ts * async function deleteRoleExample() { * const camunda = createCamundaClient(); * * await camunda.deleteRole({ roleId: 'process-admin' }); * } * ``` * @operationId deleteRole * @tags Role */ deleteRole(input: deleteRoleInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Delete tenant * * Deletes an existing tenant. * * @example Delete a tenant * ```ts * async function deleteTenantExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * await camunda.deleteTenant({ tenantId }); * } * ``` * @operationId deleteTenant * @tags Tenant */ deleteTenant(input: deleteTenantInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Delete a tenant-scoped cluster variable * * Delete a tenant-scoped cluster variable. * * @example Delete a tenant cluster variable * ```ts * async function deleteTenantClusterVariableExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * await camunda.deleteTenantClusterVariable({ * tenantId, * name: 'config', * }); * } * ``` * @operationId deleteTenantClusterVariable * @tags Cluster Variable */ deleteTenantClusterVariable(input: deleteTenantClusterVariableInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Delete user * * Deletes a user. * * @example Delete a user * ```ts * async function deleteUserExample(username: Username) { * const camunda = createCamundaClient(); * * await camunda.deleteUser({ username }); * } * ``` * @operationId deleteUser * @tags User */ deleteUser(input: deleteUserInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Evaluate root level conditional start events * * Evaluates root-level conditional start events for process definitions. * If the evaluation is successful, it will return the keys of all created process instances, along with their associated process definition key. * Multiple root-level conditional start events of the same process definition can trigger if their conditions evaluate to true. * * * @example Evaluate conditionals * ```ts * async function evaluateConditionalsExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * const result = await camunda.evaluateConditionals({ * variables: { orderReady: true }, * tenantId, * }); * * console.log(`Evaluated conditionals: ${JSON.stringify(result)}`); * } * ``` * @operationId evaluateConditionals * @tags Conditional */ evaluateConditionals(input: evaluateConditionalsInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Evaluate decision * * Evaluates a decision. * You specify the decision to evaluate either by using its unique key (as returned by * DeployResource), or using the decision ID. When using the decision ID, the latest deployed * version of the decision is used. * * * @example By ID * ```ts * async function evaluateDecisionByIdExample(decisionDefinitionId: DecisionDefinitionId) { * const camunda = createCamundaClient(); * * const result = await camunda.evaluateDecision({ * decisionDefinitionId, * variables: { * amount: 1000, * invoiceCategory: 'Misc', * }, * }); * * console.log(`Decision: ${result.decisionDefinitionId}`); * console.log(`Output: ${result.output}`); * } * ``` * @example By key * ```ts * async function evaluateDecisionByKeyExample(decisionDefinitionKey: DecisionDefinitionKey) { * const camunda = createCamundaClient(); * * const result = await camunda.evaluateDecision({ * decisionDefinitionKey, * variables: { * amount: 1000, * invoiceCategory: 'Misc', * }, * }); * * console.log(`Decision output: ${result.output}`); * } * ``` * @operationId evaluateDecision * @tags Decision definition */ evaluateDecision(input: evaluateDecisionInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Evaluate an expression * * Evaluates a FEEL expression and returns the result. Supports references to tenant scoped cluster variables when a tenant ID is provided. * * @example Evaluate an expression * ```ts * async function evaluateExpressionExample() { * const camunda = createCamundaClient(); * * const result = await camunda.evaluateExpression({ * expression: '= x + y', * variables: { x: 10, y: 20 }, * }); * * console.log(`Result: ${result.result}`); * } * ``` * @operationId evaluateExpression * @tags Expression */ evaluateExpression(input: evaluateExpressionInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Fail job * * Mark the job as failed. * * * @example Fail a job with retry * ```ts * async function failJobExample(jobKey: JobKey) { * const camunda = createCamundaClient(); * * await camunda.failJob({ * jobKey, * retries: 2, * errorMessage: 'Payment gateway timeout', * retryBackOff: 5000, * }); * } * ``` * @operationId failJob * @tags Job */ failJob(input: failJobInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get audit log * * Get an audit log entry by auditLogKey. * * @example Get an audit log entry * ```ts * async function getAuditLogExample(auditLogKey: AuditLogKey) { * const camunda = createCamundaClient(); * * const log = await camunda.getAuditLog({ auditLogKey }, { consistency: { waitUpToMs: 5000 } }); * * console.log(`Audit log: ${log.operationType}`); * } * ``` * @operationId getAuditLog * @tags Audit Log * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getAuditLog(input: getAuditLogInput, /** Management of eventual consistency **/ consistencyManagement: getAuditLogConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get current user * * Retrieves the current authenticated user. * * @example Get authentication info * ```ts * async function getAuthenticationExample() { * const camunda = createCamundaClient(); * * const user = await camunda.getAuthentication(); * * console.log(`Authenticated as: ${user.username}`); * } * ``` * @operationId getAuthentication * @tags Authentication */ getAuthentication(options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get authorization * * Get authorization by the given key. * * @example Get an authorization * ```ts * async function getAuthorizationExample(authorizationKey: AuthorizationKey) { * const camunda = createCamundaClient(); * * const authorization = await camunda.getAuthorization( * { authorizationKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`Owner: ${authorization.ownerId} (${authorization.ownerType})`); * } * ``` * @operationId getAuthorization * @tags Authorization * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getAuthorization(input: getAuthorizationInput, /** Management of eventual consistency **/ consistencyManagement: getAuthorizationConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get batch operation * * Get batch operation by key. * * @example Get a batch operation * ```ts * async function getBatchOperationExample(batchOperationKey: BatchOperationKey) { * const camunda = createCamundaClient(); * * const batch = await camunda.getBatchOperation( * { batchOperationKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`Batch: ${batch.batchOperationType} (${batch.state})`); * } * ``` * @operationId getBatchOperation * @tags Batch operation * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getBatchOperation(input: getBatchOperationInput, /** Management of eventual consistency **/ consistencyManagement: getBatchOperationConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get decision definition * * Returns a decision definition by key. * * @example Get a decision definition * ```ts * async function getDecisionDefinitionExample(decisionDefinitionKey: DecisionDefinitionKey) { * const camunda = createCamundaClient(); * * const definition = await camunda.getDecisionDefinition( * { decisionDefinitionKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`Decision: ${definition.decisionDefinitionId}`); * console.log(`Version: ${definition.version}`); * } * ``` * @operationId getDecisionDefinition * @tags Decision definition * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getDecisionDefinition(input: getDecisionDefinitionInput, /** Management of eventual consistency **/ consistencyManagement: getDecisionDefinitionConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get decision definition XML * * Returns decision definition as XML. * * @example Get decision definition XML * ```ts * async function getDecisionDefinitionXmlExample(decisionDefinitionKey: DecisionDefinitionKey) { * const camunda = createCamundaClient(); * * const xml = await camunda.getDecisionDefinitionXml( * { decisionDefinitionKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`XML length: ${JSON.stringify(xml).length}`); * } * ``` * @operationId getDecisionDefinitionXML * @tags Decision definition * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getDecisionDefinitionXml(input: getDecisionDefinitionXmlInput, /** Management of eventual consistency **/ consistencyManagement: getDecisionDefinitionXmlConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get decision instance * * Returns a decision instance. * * @example Get a decision instance * ```ts * async function getDecisionInstanceExample( * decisionEvaluationInstanceKey: DecisionEvaluationInstanceKey * ) { * const camunda = createCamundaClient(); * * const instance = await camunda.getDecisionInstance( * { decisionEvaluationInstanceKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`Decision: ${instance.decisionDefinitionId}`); * } * ``` * @operationId getDecisionInstance * @tags Decision instance * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getDecisionInstance(input: getDecisionInstanceInput, /** Management of eventual consistency **/ consistencyManagement: getDecisionInstanceConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get decision requirements * * Returns Decision Requirements as JSON. * * @example Get decision requirements * ```ts * async function getDecisionRequirementsExample(decisionRequirementsKey: DecisionRequirementsKey) { * const camunda = createCamundaClient(); * * const requirements = await camunda.getDecisionRequirements( * { decisionRequirementsKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`Requirements: ${requirements.decisionRequirementsId}`); * } * ``` * @operationId getDecisionRequirements * @tags Decision requirements * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getDecisionRequirements(input: getDecisionRequirementsInput, /** Management of eventual consistency **/ consistencyManagement: getDecisionRequirementsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get decision requirements XML * * Returns decision requirements as XML. * * @example Get decision requirements XML * ```ts * async function getDecisionRequirementsXmlExample(decisionRequirementsKey: DecisionRequirementsKey) { * const camunda = createCamundaClient(); * * const xml = await camunda.getDecisionRequirementsXml( * { decisionRequirementsKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`XML length: ${JSON.stringify(xml).length}`); * } * ``` * @operationId getDecisionRequirementsXML * @tags Decision requirements * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getDecisionRequirementsXml(input: getDecisionRequirementsXmlInput, /** Management of eventual consistency **/ consistencyManagement: getDecisionRequirementsXmlConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Download document * * Download a document from the Camunda 8 cluster. * * Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production) * * * @example Download a document * ```ts * async function getDocumentExample(documentId: DocumentId) { * const camunda = createCamundaClient(); * * await camunda.getDocument({ documentId }); * * console.log(`Downloaded document: ${documentId}`); * } * ``` * @operationId getDocument * @tags Document */ getDocument(input: getDocumentInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get element instance * * Returns element instance as JSON. * * @example Get an element instance * ```ts * async function getElementInstanceExample(elementInstanceKey: ElementInstanceKey) { * const camunda = createCamundaClient(); * * const element = await camunda.getElementInstance( * { elementInstanceKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`Element: ${element.elementId} (${element.type})`); * } * ``` * @operationId getElementInstance * @tags Element instance * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getElementInstance(input: getElementInstanceInput, /** Management of eventual consistency **/ consistencyManagement: getElementInstanceConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get a global-scoped cluster variable * * Get a global-scoped cluster variable. * * @example Get a global cluster variable * ```ts * async function getGlobalClusterVariableExample() { * const camunda = createCamundaClient(); * * const variable = await camunda.getGlobalClusterVariable( * { name: 'feature-flags' }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`${variable.name} = ${variable.value}`); * } * ``` * @operationId getGlobalClusterVariable * @tags Cluster Variable * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getGlobalClusterVariable(input: getGlobalClusterVariableInput, /** Management of eventual consistency **/ consistencyManagement: getGlobalClusterVariableConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Global job statistics * * Returns global aggregated counts for jobs. Filter by the creation time window (required) and optionally by jobType. * * * @example Get global job statistics * ```ts * async function getGlobalJobStatisticsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.getGlobalJobStatistics( * { * from: '2025-01-01T00:00:00Z', * to: '2025-12-31T23:59:59Z', * }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`Statistics retrieved: ${JSON.stringify(result)}`); * } * ``` * @operationId getGlobalJobStatistics * @tags Job * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getGlobalJobStatistics(input: getGlobalJobStatisticsInput, /** Management of eventual consistency **/ consistencyManagement: getGlobalJobStatisticsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get global user task listener * * Get a global user task listener by its id. * * @example Get a global task listener * ```ts * async function getGlobalTaskListenerExample(id: GlobalListenerId) { * const camunda = createCamundaClient(); * * const listener = await camunda.getGlobalTaskListener( * { id }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`Listener: ${listener.type} (${listener.eventTypes})`); * } * ``` * @operationId getGlobalTaskListener * @tags Global listener * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getGlobalTaskListener(input: getGlobalTaskListenerInput, /** Management of eventual consistency **/ consistencyManagement: getGlobalTaskListenerConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get group * * Get a group by its ID. * * @example Get a group * ```ts * async function getGroupExample() { * const camunda = createCamundaClient(); * * const group = await camunda.getGroup( * { groupId: 'engineering-team' }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`Group: ${group.name}`); * } * ``` * @operationId getGroup * @tags Group * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getGroup(input: getGroupInput, /** Management of eventual consistency **/ consistencyManagement: getGroupConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get incident * * Returns incident as JSON. * * * @example Get an incident * ```ts * async function getIncidentExample(incidentKey: IncidentKey) { * const camunda = createCamundaClient(); * * const incident = await camunda.getIncident( * { incidentKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`Type: ${incident.errorType}`); * console.log(`State: ${incident.state}`); * console.log(`Message: ${incident.errorMessage}`); * } * ``` * @operationId getIncident * @tags Incident * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getIncident(input: getIncidentInput, /** Management of eventual consistency **/ consistencyManagement: getIncidentConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get error metrics for a job type * * Returns aggregated metrics per error for the given jobType. * * * @example Get job error statistics * ```ts * async function getJobErrorStatisticsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.getJobErrorStatistics( * { * filter: { * from: '2025-01-01T00:00:00Z', * to: '2025-12-31T23:59:59Z', * jobType: 'payment-processing', * }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const stat of result.items ?? []) { * console.log(`Error: ${stat.errorMessage}, workers: ${stat.workers}`); * } * } * ``` * @operationId getJobErrorStatistics * @tags Job * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getJobErrorStatistics(input: getJobErrorStatisticsInput, /** Management of eventual consistency **/ consistencyManagement: getJobErrorStatisticsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get time-series metrics for a job type * * Returns a list of time-bucketed metrics ordered ascending by time. * The `from` and `to` fields select the time window of interest. * Each item in the response corresponds to one time bucket of the requested resolution. * * * @example Get job time series statistics * ```ts * async function getJobTimeSeriesStatisticsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.getJobTimeSeriesStatistics( * { * filter: { * from: '2025-01-01T00:00:00Z', * to: '2025-12-31T23:59:59Z', * jobType: 'payment-processing', * }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const point of result.items ?? []) { * console.log(`Time: ${point.time}, created: ${point.created.count}`); * } * } * ``` * @operationId getJobTimeSeriesStatistics * @tags Job * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getJobTimeSeriesStatistics(input: getJobTimeSeriesStatisticsInput, /** Management of eventual consistency **/ consistencyManagement: getJobTimeSeriesStatisticsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get job statistics by type * * Get statistics about jobs, grouped by job type. * * * @example Get job type statistics * ```ts * async function getJobTypeStatisticsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.getJobTypeStatistics({}, { consistency: { waitUpToMs: 5000 } }); * * for (const stat of result.items ?? []) { * console.log(`Type: ${stat.jobType}, workers: ${stat.workers}`); * } * } * ``` * @operationId getJobTypeStatistics * @tags Job * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getJobTypeStatistics(input: getJobTypeStatisticsInput, /** Management of eventual consistency **/ consistencyManagement: getJobTypeStatisticsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get job statistics by worker * * Get statistics about jobs, grouped by worker, for a given job type. * * * @example Get job worker statistics * ```ts * async function getJobWorkerStatisticsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.getJobWorkerStatistics( * { * filter: { * from: '2025-01-01T00:00:00Z', * to: '2025-12-31T23:59:59Z', * jobType: 'payment-processing', * }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const stat of result.items ?? []) { * console.log(`Worker: ${stat.worker}, completed: ${stat.completed.count}`); * } * } * ``` * @operationId getJobWorkerStatistics * @tags Job * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getJobWorkerStatistics(input: getJobWorkerStatisticsInput, /** Management of eventual consistency **/ consistencyManagement: getJobWorkerStatisticsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get license status * * Obtains the status of the current Camunda license. * * @example Get license information * ```ts * async function getLicenseExample() { * const camunda = createCamundaClient(); * * const license = await camunda.getLicense(); * * console.log(`License type: ${license.validLicense}`); * } * ``` * @operationId getLicense * @tags License */ getLicense(options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get a mapping rule * * Gets the mapping rule with the given ID. * * * @example Get a mapping rule * ```ts * async function getMappingRuleExample() { * const camunda = createCamundaClient(); * * const rule = await camunda.getMappingRule( * { mappingRuleId: 'ldap-group-mapping' }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`Rule: ${rule.name} (${rule.claimName}=${rule.claimValue})`); * } * ``` * @operationId getMappingRule * @tags Mapping rule * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getMappingRule(input: getMappingRuleInput, /** Management of eventual consistency **/ consistencyManagement: getMappingRuleConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get process definition * * Returns process definition as JSON. * * @example Get a process definition * ```ts * async function getProcessDefinitionExample(processDefinitionKey: ProcessDefinitionKey) { * const camunda = createCamundaClient(); * * const definition = await camunda.getProcessDefinition( * { processDefinitionKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`Process: ${definition.processDefinitionId} v${definition.version}`); * } * ``` * @operationId getProcessDefinition * @tags Process definition * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getProcessDefinition(input: getProcessDefinitionInput, /** Management of eventual consistency **/ consistencyManagement: getProcessDefinitionConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get process instance statistics * * Get statistics about process instances, grouped by process definition and tenant. * * * @example Get process definition instance statistics * ```ts * async function getProcessDefinitionInstanceStatisticsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.getProcessDefinitionInstanceStatistics( * {}, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const stat of result.items ?? []) { * console.log( * `Definition ${stat.processDefinitionId}: ${stat.activeInstancesWithoutIncidentCount} active` * ); * } * } * ``` * @operationId getProcessDefinitionInstanceStatistics * @tags Process definition * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getProcessDefinitionInstanceStatistics(input: getProcessDefinitionInstanceStatisticsInput, /** Management of eventual consistency **/ consistencyManagement: getProcessDefinitionInstanceStatisticsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get process instance statistics by version * * Get statistics about process instances, grouped by version for a given process definition. * The process definition ID must be provided as a required field in the request body filter. * * * @example Get version statistics * ```ts * async function getProcessDefinitionInstanceVersionStatisticsExample( * processDefinitionId: ProcessDefinitionId * ) { * const camunda = createCamundaClient(); * * const result = await camunda.getProcessDefinitionInstanceVersionStatistics( * { * filter: { * processDefinitionId, * }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const stat of result.items ?? []) { * console.log( * `Version ${stat.processDefinitionVersion}: ${stat.activeInstancesWithoutIncidentCount} active` * ); * } * } * ``` * @operationId getProcessDefinitionInstanceVersionStatistics * @tags Process definition * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getProcessDefinitionInstanceVersionStatistics(input: getProcessDefinitionInstanceVersionStatisticsInput, /** Management of eventual consistency **/ consistencyManagement: getProcessDefinitionInstanceVersionStatisticsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get message subscription statistics * * Get message subscription statistics, grouped by process definition. * * * @example Get message subscription statistics * ```ts * async function getProcessDefinitionMessageSubscriptionStatisticsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.getProcessDefinitionMessageSubscriptionStatistics( * {}, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const stat of result.items ?? []) { * console.log( * `Definition ${stat.processDefinitionId}: ${stat.activeSubscriptions} subscriptions` * ); * } * } * ``` * @operationId getProcessDefinitionMessageSubscriptionStatistics * @tags Process definition * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getProcessDefinitionMessageSubscriptionStatistics(input: getProcessDefinitionMessageSubscriptionStatisticsInput, /** Management of eventual consistency **/ consistencyManagement: getProcessDefinitionMessageSubscriptionStatisticsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get process definition statistics * * Get statistics about elements in currently running process instances by process definition key and search filter. * * @example Get process definition element statistics * ```ts * async function getProcessDefinitionStatisticsExample(processDefinitionKey: ProcessDefinitionKey) { * const camunda = createCamundaClient(); * * const result = await camunda.getProcessDefinitionStatistics( * { processDefinitionKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const stat of result.items ?? []) { * console.log(`Element ${stat.elementId}: active=${stat.active}`); * } * } * ``` * @operationId getProcessDefinitionStatistics * @tags Process definition * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getProcessDefinitionStatistics(input: getProcessDefinitionStatisticsInput, /** Management of eventual consistency **/ consistencyManagement: getProcessDefinitionStatisticsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get process definition XML * * Returns process definition as XML. * * @example Get process definition XML * ```ts * async function getProcessDefinitionXmlExample(processDefinitionKey: ProcessDefinitionKey) { * const camunda = createCamundaClient(); * * const xml = await camunda.getProcessDefinitionXml( * { processDefinitionKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`XML length: ${JSON.stringify(xml).length}`); * } * ``` * @operationId getProcessDefinitionXML * @tags Process definition * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getProcessDefinitionXml(input: getProcessDefinitionXmlInput, /** Management of eventual consistency **/ consistencyManagement: getProcessDefinitionXmlConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get process instance * * Get the process instance by the process instance key. * * @example Get a process instance * ```ts * async function getProcessInstanceExample(processInstanceKey: ProcessInstanceKey) { * const camunda = createCamundaClient(); * * const instance = await camunda.getProcessInstance( * { processInstanceKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`State: ${instance.state}`); * console.log(`Process: ${instance.processDefinitionId}`); * } * ``` * @operationId getProcessInstance * @tags Process instance * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getProcessInstance(input: getProcessInstanceInput, /** Management of eventual consistency **/ consistencyManagement: getProcessInstanceConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get call hierarchy * * Returns the call hierarchy for a given process instance, showing its ancestry up to the root instance. * * @example Get process instance call hierarchy * ```ts * async function getProcessInstanceCallHierarchyExample(processInstanceKey: ProcessInstanceKey) { * const camunda = createCamundaClient(); * * const result = await camunda.getProcessInstanceCallHierarchy( * { processInstanceKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`Call hierarchy entries: ${result.length}`); * } * ``` * @operationId getProcessInstanceCallHierarchy * @tags Process instance * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getProcessInstanceCallHierarchy(input: getProcessInstanceCallHierarchyInput, /** Management of eventual consistency **/ consistencyManagement: getProcessInstanceCallHierarchyConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get sequence flows * * Get sequence flows taken by the process instance. * * @example Get process instance sequence flows * ```ts * async function getProcessInstanceSequenceFlowsExample(processInstanceKey: ProcessInstanceKey) { * const camunda = createCamundaClient(); * * const result = await camunda.getProcessInstanceSequenceFlows( * { processInstanceKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const flow of result.items ?? []) { * console.log(`Sequence flow: ${flow.sequenceFlowId}`); * } * } * ``` * @operationId getProcessInstanceSequenceFlows * @tags Process instance * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getProcessInstanceSequenceFlows(input: getProcessInstanceSequenceFlowsInput, /** Management of eventual consistency **/ consistencyManagement: getProcessInstanceSequenceFlowsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get element instance statistics * * Get statistics about elements by the process instance key. * * @example Get process instance statistics * ```ts * async function getProcessInstanceStatisticsExample(processInstanceKey: ProcessInstanceKey) { * const camunda = createCamundaClient(); * * const result = await camunda.getProcessInstanceStatistics( * { processInstanceKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const stat of result.items ?? []) { * console.log(`Element ${stat.elementId}: active=${stat.active}`); * } * } * ``` * @operationId getProcessInstanceStatistics * @tags Process instance * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getProcessInstanceStatistics(input: getProcessInstanceStatisticsInput, /** Management of eventual consistency **/ consistencyManagement: getProcessInstanceStatisticsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get process instance statistics by definition * * Returns statistics for active process instances with incidents, grouped by process * definition. The result set is scoped to a specific incident error hash code, which must be * provided as a filter in the request body. * * * @example Get instance statistics by definition * ```ts * async function getProcessInstanceStatisticsByDefinitionExample() { * const camunda = createCamundaClient(); * * const result = await camunda.getProcessInstanceStatisticsByDefinition( * { * filter: { * errorHashCode: 12345, * }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const stat of result.items ?? []) { * console.log( * `Definition ${stat.processDefinitionId}: ${stat.activeInstancesWithErrorCount} incidents` * ); * } * } * ``` * @operationId getProcessInstanceStatisticsByDefinition * @tags Incident * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getProcessInstanceStatisticsByDefinition(input: getProcessInstanceStatisticsByDefinitionInput, /** Management of eventual consistency **/ consistencyManagement: getProcessInstanceStatisticsByDefinitionConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get process instance statistics by error * * Returns statistics for active process instances that currently have active incidents, * grouped by incident error hash code. * * * @example Get instance statistics by error * ```ts * async function getProcessInstanceStatisticsByErrorExample() { * const camunda = createCamundaClient(); * * const result = await camunda.getProcessInstanceStatisticsByError( * {}, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const stat of result.items ?? []) { * console.log(`Error: ${stat.errorMessage}, count: ${stat.activeInstancesWithErrorCount}`); * } * } * ``` * @operationId getProcessInstanceStatisticsByError * @tags Incident * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getProcessInstanceStatisticsByError(input: getProcessInstanceStatisticsByErrorInput, /** Management of eventual consistency **/ consistencyManagement: getProcessInstanceStatisticsByErrorConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get resource * * Returns a deployed resource. * :::info * Currently, this endpoint only supports RPA resources. * ::: * * * @example Get a resource * ```ts * async function getResourceExample(resourceKey: ProcessDefinitionKey) { * const camunda = createCamundaClient(); * * const resource = await camunda.getResource({ * resourceKey, * }); * * console.log(`Resource: ${resource.resourceName} (${resource.resourceId})`); * } * ``` * @operationId getResource * @tags Resource */ getResource(input: getResourceInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get resource content * * Returns the content of a deployed resource. * :::info * Currently, this endpoint only supports RPA resources. * ::: * * * @example Get resource content * ```ts * async function getResourceContentExample(resourceKey: ProcessDefinitionKey) { * const camunda = createCamundaClient(); * * const content = await camunda.getResourceContent({ * resourceKey, * }); * * console.log(`Content retrieved (type: ${typeof content})`); * } * ``` * @operationId getResourceContent * @tags Resource */ getResourceContent(input: getResourceContentInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get role * * Get a role by its ID. * * @example Get a role * ```ts * async function getRoleExample() { * const camunda = createCamundaClient(); * * const role = await camunda.getRole( * { roleId: 'process-admin' }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`Role: ${role.name}`); * } * ``` * @operationId getRole * @tags Role * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getRole(input: getRoleInput, /** Management of eventual consistency **/ consistencyManagement: getRoleConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get process start form * * Get the start form of a process. * Note that this endpoint will only return linked forms. This endpoint does not support embedded forms. * * * @example Get start process form * ```ts * async function getStartProcessFormExample(processDefinitionKey: ProcessDefinitionKey) { * const camunda = createCamundaClient(); * * const form = await camunda.getStartProcessForm( * { processDefinitionKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * if (form) { * console.log(`Form key: ${form.formKey}`); * } * } * ``` * @operationId getStartProcessForm * @tags Process definition * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getStartProcessForm(input: getStartProcessFormInput, /** Management of eventual consistency **/ consistencyManagement: getStartProcessFormConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get cluster status * * Checks the health status of the cluster by verifying if there's at least one partition with a healthy leader. * * @example Check cluster status * ```ts * async function getStatusExample() { * const camunda = createCamundaClient(); * * await camunda.getStatus(); * * console.log('Cluster is healthy'); * } * ``` * @operationId getStatus * @tags Cluster */ getStatus(options?: OperationOptions): CancelablePromise<_DataOf>; /** * System configuration (alpha) * * Returns the current system configuration. The response is an envelope * that groups settings by feature area. * * This endpoint is an alpha feature and may be subject to change * in future releases. * * * @example Get system configuration * ```ts * async function getSystemConfigurationExample() { * const camunda = createCamundaClient(); * * const config = await camunda.getSystemConfiguration(); * * console.log(`Configuration loaded: ${JSON.stringify(config)}`); * } * ``` * @operationId getSystemConfiguration * @tags System */ getSystemConfiguration(options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get tenant * * Retrieves a single tenant by tenant ID. * * @example Get a tenant * ```ts * async function getTenantExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * const tenant = await camunda.getTenant({ tenantId }, { consistency: { waitUpToMs: 5000 } }); * * console.log(`Tenant: ${tenant.name}`); * } * ``` * @operationId getTenant * @tags Tenant * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getTenant(input: getTenantInput, /** Management of eventual consistency **/ consistencyManagement: getTenantConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get a tenant-scoped cluster variable * * Get a tenant-scoped cluster variable. * * @example Get a tenant cluster variable * ```ts * async function getTenantClusterVariableExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * const variable = await camunda.getTenantClusterVariable( * { * tenantId, * name: 'config', * }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`${variable.name} = ${variable.value}`); * } * ``` * @operationId getTenantClusterVariable * @tags Cluster Variable * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getTenantClusterVariable(input: getTenantClusterVariableInput, /** Management of eventual consistency **/ consistencyManagement: getTenantClusterVariableConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get cluster topology * * Obtains the current topology of the cluster the gateway is part of. * * @example Get cluster topology * ```ts * async function getTopologyExample() { * const camunda = createCamundaClient(); * * const topology = await camunda.getTopology(); * * console.log(`Cluster size: ${topology.clusterSize}`); * console.log(`Partitions: ${topology.partitionsCount}`); * for (const broker of topology.brokers ?? []) { * console.log(` Broker ${broker.nodeId}: ${broker.host}:${broker.port}`); * } * } * ``` * @operationId getTopology * @tags Cluster */ getTopology(options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get usage metrics * * Retrieve the usage metrics based on given criteria. * * @example Get usage metrics * ```ts * async function getUsageMetricsExample() { * const camunda = createCamundaClient(); * * const metrics = await camunda.getUsageMetrics( * { * startTime: '2025-01-01T00:00:00Z', * endTime: '2025-12-31T23:59:59Z', * }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`Usage metrics retrieved: ${JSON.stringify(metrics)}`); * } * ``` * @operationId getUsageMetrics * @tags System * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getUsageMetrics(input: getUsageMetricsInput, /** Management of eventual consistency **/ consistencyManagement: getUsageMetricsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get user * * Get a user by its username. * * @example Get a user * ```ts * async function getUserExample(username: Username) { * const camunda = createCamundaClient(); * * const user = await camunda.getUser({ username }, { consistency: { waitUpToMs: 5000 } }); * * console.log(`User: ${user.name} (${user.email})`); * } * ``` * @operationId getUser * @tags User * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getUser(input: getUserInput, /** Management of eventual consistency **/ consistencyManagement: getUserConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get user task * * Get the user task by the user task key. * * @example Get a user task * ```ts * async function getUserTaskExample(userTaskKey: UserTaskKey) { * const camunda = createCamundaClient(); * * const task = await camunda.getUserTask({ userTaskKey }, { consistency: { waitUpToMs: 5000 } }); * * console.log(`Task: ${task.name} (${task.state})`); * } * ``` * @operationId getUserTask * @tags User task * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getUserTask(input: getUserTaskInput, /** Management of eventual consistency **/ consistencyManagement: getUserTaskConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get user task form * * Get the form of a user task. * Note that this endpoint will only return linked forms. This endpoint does not support embedded forms. * * * @example Get a user task form * ```ts * async function getUserTaskFormExample(userTaskKey: UserTaskKey) { * const camunda = createCamundaClient(); * * const form = await camunda.getUserTaskForm( * { userTaskKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * if (form) { * console.log(`Form key: ${form.formKey}`); * } * } * ``` * @operationId getUserTaskForm * @tags User task * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getUserTaskForm(input: getUserTaskFormInput, /** Management of eventual consistency **/ consistencyManagement: getUserTaskFormConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Get variable * * Get a variable by its key. * * This endpoint returns both process-level and local (element-scoped) variables. * The variable's scopeKey indicates whether it's a process-level variable or scoped to a * specific element instance. * * @example Get a variable * ```ts * async function getVariableExample(variableKey: VariableKey) { * const camunda = createCamundaClient(); * * const variable = await camunda.getVariable( * { variableKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * console.log(`${variable.name} = ${variable.value}`); * } * ``` * @operationId getVariable * @tags Variable * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ getVariable(input: getVariableInput, /** Management of eventual consistency **/ consistencyManagement: getVariableConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Migrate process instance * * Migrates a process instance to a new process definition. * This request can contain multiple mapping instructions to define mapping between the active * process instance's elements and target process definition elements. * * Use this to upgrade a process instance to a new version of a process or to * a different process definition, e.g. to keep your running instances up-to-date with the * latest process improvements. * * * @example Migrate a process instance * ```ts * async function migrateProcessInstanceExample( * processInstanceKey: ProcessInstanceKey, * targetProcessDefinitionKey: ProcessDefinitionKey, * sourceElementId: ElementId, * targetElementId: ElementId * ) { * const camunda = createCamundaClient(); * * await camunda.migrateProcessInstance({ * processInstanceKey, * targetProcessDefinitionKey, * mappingInstructions: [ * { * sourceElementId, * targetElementId, * }, * ], * }); * } * ``` * @operationId migrateProcessInstance * @tags Process instance */ migrateProcessInstance(input: migrateProcessInstanceInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Migrate process instances (batch) * * Migrate multiple process instances. * Since only process instances with ACTIVE state can be migrated, any given * filters for state are ignored and overridden during this batch operation. * This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}). * * * @example Migrate process instances in batch * ```ts * async function migrateProcessInstancesBatchOperationExample( * processDefinitionKey: ProcessDefinitionKey, * targetProcessDefinitionKey: ProcessDefinitionKey, * sourceElementId: ElementId, * targetElementId: ElementId * ) { * const camunda = createCamundaClient(); * * const result = await camunda.migrateProcessInstancesBatchOperation({ * filter: { * processDefinitionKey, * }, * migrationPlan: { * targetProcessDefinitionKey, * mappingInstructions: [ * { * sourceElementId, * targetElementId, * }, * ], * }, * }); * * console.log(`Batch operation key: ${result.batchOperationKey}`); * } * ``` * @operationId migrateProcessInstancesBatchOperation * @tags Process instance */ migrateProcessInstancesBatchOperation(input: migrateProcessInstancesBatchOperationInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Modify process instance * * Modifies a running process instance. * This request can contain multiple instructions to activate an element of the process or * to terminate an active instance of an element. * * Use this to repair a process instance that is stuck on an element or took an unintended path. * For example, because an external system is not available or doesn't respond as expected. * * * @example Modify a process instance * ```ts * async function modifyProcessInstanceExample( * processInstanceKey: ProcessInstanceKey, * elementId: ElementId, * elementInstanceKey: ElementInstanceKey * ) { * const camunda = createCamundaClient(); * * await camunda.modifyProcessInstance({ * processInstanceKey, * activateInstructions: [{ elementId }], * terminateInstructions: [{ elementInstanceKey }], * }); * } * ``` * @operationId modifyProcessInstance * @tags Process instance */ modifyProcessInstance(input: modifyProcessInstanceInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Modify process instances (batch) * * Modify multiple process instances. * Since only process instances with ACTIVE state can be modified, any given * filters for state are ignored and overridden during this batch operation. * In contrast to single modification operation, it is not possible to add variable instructions or modify by element key. * It is only possible to use the element id of the source and target. * This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}). * * * @example Modify process instances in batch * ```ts * async function modifyProcessInstancesBatchOperationExample( * processDefinitionKey: ProcessDefinitionKey, * sourceElementId: ElementId, * targetElementId: ElementId * ) { * const camunda = createCamundaClient(); * * const result = await camunda.modifyProcessInstancesBatchOperation({ * filter: { * processDefinitionKey, * }, * moveInstructions: [ * { * sourceElementId, * targetElementId, * }, * ], * }); * * console.log(`Batch operation key: ${result.batchOperationKey}`); * } * ``` * @operationId modifyProcessInstancesBatchOperation * @tags Process instance */ modifyProcessInstancesBatchOperation(input: modifyProcessInstancesBatchOperationInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Pin internal clock (alpha) * * Set a precise, static time for the Zeebe engine's internal clock. * When the clock is pinned, it remains at the specified time and does not advance. * To change the time, the clock must be pinned again with a new timestamp. * * This endpoint is an alpha feature and may be subject to change * in future releases. * * * @example Pin the cluster clock * ```ts * async function pinClockExample() { * const camunda = createCamundaClient(); * * await camunda.pinClock({ * timestamp: 1735689599000, * }); * * console.log('Clock pinned'); * } * ``` * @operationId pinClock * @tags Clock */ pinClock(input: pinClockInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Publish message * * Publishes a single message. * Messages are published to specific partitions computed from their correlation keys. * Messages can be buffered. * The endpoint does not wait for a correlation result. * Use the message correlation endpoint for such use cases. * * * @example Publish a message * ```ts * async function publishMessageExample() { * const camunda = createCamundaClient(); * * await camunda.publishMessage({ * name: 'order-payment-received', * correlationKey: 'ORD-12345', * timeToLive: 60000, * variables: { * paymentId: 'PAY-123', * }, * }); * } * ``` * @operationId publishMessage * @tags Message */ publishMessage(input: publishMessageInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Reset internal clock (alpha) * * Resets the Zeebe engine's internal clock to the current system time, enabling it to tick in real-time. * This operation is useful for returning the clock to * normal behavior after it has been pinned to a specific time. * * This endpoint is an alpha feature and may be subject to change * in future releases. * * * @example Reset the cluster clock * ```ts * async function resetClockExample() { * const camunda = createCamundaClient(); * * await camunda.resetClock(); * * console.log('Clock reset'); * } * ``` * @operationId resetClock * @tags Clock */ resetClock(options?: OperationOptions): CancelablePromise<_DataOf>; /** * Resolve incident * * Marks the incident as resolved; most likely a call to Update job will be necessary * to reset the job's retries, followed by this call. * * * @example Resolve an incident * ```ts * async function resolveIncidentExample(incidentKey: IncidentKey) { * const camunda = createCamundaClient(); * * await camunda.resolveIncident({ incidentKey }); * } * ``` * @operationId resolveIncident * @tags Incident */ resolveIncident(input: resolveIncidentInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Resolve related incidents (batch) * * Resolves multiple instances of process instances. * Since only process instances with ACTIVE state can have unresolved incidents, any given * filters for state are ignored and overridden during this batch operation. * This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}). * * * @example Resolve incidents in batch * ```ts * async function resolveIncidentsBatchOperationExample(processDefinitionKey: ProcessDefinitionKey) { * const camunda = createCamundaClient(); * * const result = await camunda.resolveIncidentsBatchOperation({ * filter: { * processDefinitionKey, * }, * }); * * console.log(`Batch operation key: ${result.batchOperationKey}`); * } * ``` * @operationId resolveIncidentsBatchOperation * @tags Process instance */ resolveIncidentsBatchOperation(input: resolveIncidentsBatchOperationInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Resolve related incidents * * Creates a batch operation to resolve multiple incidents of a process instance. * * @example Resolve process instance incidents * ```ts * async function resolveProcessInstanceIncidentsExample(processInstanceKey: ProcessInstanceKey) { * const camunda = createCamundaClient(); * * const result = await camunda.resolveProcessInstanceIncidents({ processInstanceKey }); * * console.log(`Batch operation key: ${result.batchOperationKey}`); * } * ``` * @operationId resolveProcessInstanceIncidents * @tags Process instance */ resolveProcessInstanceIncidents(input: resolveProcessInstanceIncidentsInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Resume Batch operation * * Resumes a suspended batch operation. * This is done asynchronously, the progress can be tracked using the batch operation status endpoint (/batch-operations/{batchOperationKey}). * * * @example Resume a batch operation * ```ts * async function resumeBatchOperationExample(batchOperationKey: BatchOperationKey) { * const camunda = createCamundaClient(); * * await camunda.resumeBatchOperation({ batchOperationKey }); * } * ``` * @operationId resumeBatchOperation * @tags Batch operation */ resumeBatchOperation(input: resumeBatchOperationInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search audit logs * * Search for audit logs based on given criteria. * * @example Search audit logs * ```ts * async function searchAuditLogsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchAuditLogs( * { * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const log of result.items ?? []) { * console.log(`${log.auditLogKey}: ${log.operationType}`); * } * } * ``` * @operationId searchAuditLogs * @tags Audit Log * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchAuditLogs(input: searchAuditLogsInput, /** Management of eventual consistency **/ consistencyManagement: searchAuditLogsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search authorizations * * Search for authorizations based on given criteria. * * @example Search authorizations * ```ts * async function searchAuthorizationsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchAuthorizations( * { * filter: { ownerType: 'USER' }, * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const auth of result.items ?? []) { * console.log(`${auth.authorizationKey}: ${auth.ownerId} - ${auth.resourceType}`); * } * } * ``` * @operationId searchAuthorizations * @tags Authorization * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchAuthorizations(input: searchAuthorizationsInput, /** Management of eventual consistency **/ consistencyManagement: searchAuthorizationsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search batch operation items * * Search for batch operation items based on given criteria. * * @example Search batch operation items * ```ts * async function searchBatchOperationItemsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchBatchOperationItems( * { * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const item of result.items ?? []) { * console.log(`Item: ${item.itemKey} (${item.state})`); * } * } * ``` * @operationId searchBatchOperationItems * @tags Batch operation * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchBatchOperationItems(input: searchBatchOperationItemsInput, /** Management of eventual consistency **/ consistencyManagement: searchBatchOperationItemsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search batch operations * * Search for batch operations based on given criteria. * * @example Search batch operations * ```ts * async function searchBatchOperationsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchBatchOperations( * { * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const batch of result.items ?? []) { * console.log(`${batch.batchOperationKey}: ${batch.batchOperationType} (${batch.state})`); * } * } * ``` * @operationId searchBatchOperations * @tags Batch operation * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchBatchOperations(input: searchBatchOperationsInput, /** Management of eventual consistency **/ consistencyManagement: searchBatchOperationsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search group clients * * Search clients assigned to a group. * * @example Search clients in a group * ```ts * async function searchClientsForGroupExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchClientsForGroup( * { groupId: 'engineering-team' }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const client of result.items ?? []) { * console.log(`Client: ${client.clientId}`); * } * } * ``` * @operationId searchClientsForGroup * @tags Group * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchClientsForGroup(input: searchClientsForGroupInput, /** Management of eventual consistency **/ consistencyManagement: searchClientsForGroupConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search role clients * * Search clients with assigned role. * * @example Search clients for a role * ```ts * async function searchClientsForRoleExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchClientsForRole( * { roleId: 'process-admin' }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const client of result.items ?? []) { * console.log(`Client: ${client.clientId}`); * } * } * ``` * @operationId searchClientsForRole * @tags Role * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchClientsForRole(input: searchClientsForRoleInput, /** Management of eventual consistency **/ consistencyManagement: searchClientsForRoleConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search clients for tenant * * Retrieves a filtered and sorted list of clients for a specified tenant. * * @example Search clients for a tenant * ```ts * async function searchClientsForTenantExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * const result = await camunda.searchClientsForTenant( * { tenantId }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const client of result.items ?? []) { * console.log(`Client: ${client.clientId}`); * } * } * ``` * @operationId searchClientsForTenant * @tags Tenant * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchClientsForTenant(input: searchClientsForTenantInput, /** Management of eventual consistency **/ consistencyManagement: searchClientsForTenantConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search for cluster variables based on given criteria. By default, long variable values in the response are truncated. * * @example Search cluster variables * ```ts * async function searchClusterVariablesExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchClusterVariables( * { * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const variable of result.items ?? []) { * console.log(`${variable.name} = ${variable.value}`); * } * } * ``` * @operationId searchClusterVariables * @tags Cluster Variable * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchClusterVariables(input: searchClusterVariablesInput, /** Management of eventual consistency **/ consistencyManagement: searchClusterVariablesConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search correlated message subscriptions * * Search correlated message subscriptions based on given criteria. * * @example Search correlated message subscriptions * ```ts * async function searchCorrelatedMessageSubscriptionsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchCorrelatedMessageSubscriptions( * { * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const sub of result.items ?? []) { * console.log(`Correlated subscription: ${sub.messageName}`); * } * } * ``` * @operationId searchCorrelatedMessageSubscriptions * @tags Message subscription * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchCorrelatedMessageSubscriptions(input: searchCorrelatedMessageSubscriptionsInput, /** Management of eventual consistency **/ consistencyManagement: searchCorrelatedMessageSubscriptionsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search decision definitions * * Search for decision definitions based on given criteria. * * @example Search decision definitions * ```ts * async function searchDecisionDefinitionsExample(decisionDefinitionId: DecisionDefinitionId) { * const camunda = createCamundaClient(); * * const result = await camunda.searchDecisionDefinitions( * { * filter: { decisionDefinitionId }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const definition of result.items ?? []) { * console.log(`${definition.decisionDefinitionId} v${definition.version}`); * } * } * ``` * @operationId searchDecisionDefinitions * @tags Decision definition * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchDecisionDefinitions(input: searchDecisionDefinitionsInput, /** Management of eventual consistency **/ consistencyManagement: searchDecisionDefinitionsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search decision instances * * Search for decision instances based on given criteria. * * @example Search decision instances * ```ts * async function searchDecisionInstancesExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchDecisionInstances( * { * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const instance of result.items ?? []) { * console.log(`${instance.decisionEvaluationKey}: ${instance.decisionDefinitionId}`); * } * } * ``` * @operationId searchDecisionInstances * @tags Decision instance * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchDecisionInstances(input: searchDecisionInstancesInput, /** Management of eventual consistency **/ consistencyManagement: searchDecisionInstancesConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search decision requirements * * Search for decision requirements based on given criteria. * * @example Search decision requirements * ```ts * async function searchDecisionRequirementsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchDecisionRequirements( * { * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const req of result.items ?? []) { * console.log(`${req.decisionRequirementsKey}: ${req.decisionRequirementsId}`); * } * } * ``` * @operationId searchDecisionRequirements * @tags Decision requirements * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchDecisionRequirements(input: searchDecisionRequirementsInput, /** Management of eventual consistency **/ consistencyManagement: searchDecisionRequirementsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search for incidents of a specific element instance * * Search for incidents caused by the specified element instance, including incidents of any child instances created from this element instance. * * Although the `elementInstanceKey` is provided as a path parameter to indicate the root element instance, * you may also include an `elementInstanceKey` within the filter object to narrow results to specific * child element instances. This is useful, for example, if you want to isolate incidents associated with * nested or subordinate elements within the given element instance while excluding incidents directly tied * to the root element itself. * * * @example Search element instance incidents * ```ts * async function searchElementInstanceIncidentsExample(elementInstanceKey: ElementInstanceKey) { * const camunda = createCamundaClient(); * * const result = await camunda.searchElementInstanceIncidents( * { elementInstanceKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const incident of result.items ?? []) { * console.log(`Incident: ${incident.errorType}`); * } * } * ``` * @operationId searchElementInstanceIncidents * @tags Element instance * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchElementInstanceIncidents(input: searchElementInstanceIncidentsInput, /** Management of eventual consistency **/ consistencyManagement: searchElementInstanceIncidentsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search element instances * * Search for element instances based on given criteria. * * @example Search element instances * ```ts * async function searchElementInstancesExample(processInstanceKey: ProcessInstanceKey) { * const camunda = createCamundaClient(); * * const result = await camunda.searchElementInstances( * { * filter: { * processInstanceKey, * }, * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const element of result.items ?? []) { * console.log(`${element.elementId}: ${element.type} (${element.state})`); * } * } * ``` * @operationId searchElementInstances * @tags Element instance * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchElementInstances(input: searchElementInstancesInput, /** Management of eventual consistency **/ consistencyManagement: searchElementInstancesConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search global user task listeners * * Search for global user task listeners based on given criteria. * * @example Search global task listeners * ```ts * async function searchGlobalTaskListenersExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchGlobalTaskListeners( * { * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const listener of result.items ?? []) { * console.log(`${listener.id}: ${listener.type} (${listener.eventTypes})`); * } * } * ``` * @operationId searchGlobalTaskListeners * @tags Global listener * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchGlobalTaskListeners(input: searchGlobalTaskListenersInput, /** Management of eventual consistency **/ consistencyManagement: searchGlobalTaskListenersConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search groups for tenant * * Retrieves a filtered and sorted list of groups for a specified tenant. * * @example Search groups for a tenant * ```ts * async function searchGroupIdsForTenantExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * const result = await camunda.searchGroupIdsForTenant( * { tenantId }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const group of result.items ?? []) { * console.log(`Group: ${group.groupId}`); * } * } * ``` * @operationId searchGroupIdsForTenant * @tags Tenant * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchGroupIdsForTenant(input: searchGroupIdsForTenantInput, /** Management of eventual consistency **/ consistencyManagement: searchGroupIdsForTenantConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search groups * * Search for groups based on given criteria. * * @example Search groups * ```ts * async function searchGroupsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchGroups( * { * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const group of result.items ?? []) { * console.log(`${group.groupId}: ${group.name}`); * } * } * ``` * @operationId searchGroups * @tags Group * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchGroups(input: searchGroupsInput, /** Management of eventual consistency **/ consistencyManagement: searchGroupsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search role groups * * Search groups with assigned role. * * @example Search groups for a role * ```ts * async function searchGroupsForRoleExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchGroupsForRole( * { roleId: 'process-admin' }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const group of result.items ?? []) { * console.log(`Group: ${group.groupId}`); * } * } * ``` * @operationId searchGroupsForRole * @tags Role * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchGroupsForRole(input: searchGroupsForRoleInput, /** Management of eventual consistency **/ consistencyManagement: searchGroupsForRoleConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search incidents * * Search for incidents based on given criteria. * * * @example Search incidents * ```ts * async function searchIncidentsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchIncidents( * { * filter: { state: 'ACTIVE' }, * sort: [{ field: 'creationTime', order: 'DESC' }], * page: { limit: 20 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const incident of result.items ?? []) { * console.log(`${incident.incidentKey}: ${incident.errorType} — ${incident.errorMessage}`); * } * console.log(`Total active incidents: ${result.page.totalItems}`); * } * ``` * @operationId searchIncidents * @tags Incident * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchIncidents(input: searchIncidentsInput, /** Management of eventual consistency **/ consistencyManagement: searchIncidentsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search jobs * * Search for jobs based on given criteria. * * @example Search jobs * ```ts * async function searchJobsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchJobs( * { * filter: { type: 'payment-processing', state: 'CREATED' }, * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const job of result.items ?? []) { * console.log(`Job ${job.jobKey}: ${job.type} (${job.state})`); * } * } * ``` * @operationId searchJobs * @tags Job * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchJobs(input: searchJobsInput, /** Management of eventual consistency **/ consistencyManagement: searchJobsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search mapping rules * * Search for mapping rules based on given criteria. * * * @example Search mapping rules * ```ts * async function searchMappingRulesExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchMappingRule( * { * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const rule of result.items ?? []) { * console.log(`${rule.mappingRuleId}: ${rule.name}`); * } * } * ``` * @operationId searchMappingRule * @tags Mapping rule * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchMappingRule(input: searchMappingRuleInput, /** Management of eventual consistency **/ consistencyManagement: searchMappingRuleConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search group mapping rules * * Search mapping rules assigned to a group. * * @example Search mapping rules for a group * ```ts * async function searchMappingRulesForGroupExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchMappingRulesForGroup( * { groupId: 'engineering-team' }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const rule of result.items ?? []) { * console.log(`Mapping rule: ${rule.name}`); * } * } * ``` * @operationId searchMappingRulesForGroup * @tags Group * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchMappingRulesForGroup(input: searchMappingRulesForGroupInput, /** Management of eventual consistency **/ consistencyManagement: searchMappingRulesForGroupConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search role mapping rules * * Search mapping rules with assigned role. * * @example Search mapping rules for a role * ```ts * async function searchMappingRulesForRoleExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchMappingRulesForRole( * { roleId: 'process-admin' }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const rule of result.items ?? []) { * console.log(`Mapping rule: ${rule.name}`); * } * } * ``` * @operationId searchMappingRulesForRole * @tags Role * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchMappingRulesForRole(input: searchMappingRulesForRoleInput, /** Management of eventual consistency **/ consistencyManagement: searchMappingRulesForRoleConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search mapping rules for tenant * * Retrieves a filtered and sorted list of MappingRules for a specified tenant. * * @example Search mapping rules for a tenant * ```ts * async function searchMappingRulesForTenantExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * const result = await camunda.searchMappingRulesForTenant( * { tenantId }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const rule of result.items ?? []) { * console.log(`Mapping rule: ${rule.name}`); * } * } * ``` * @operationId searchMappingRulesForTenant * @tags Tenant * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchMappingRulesForTenant(input: searchMappingRulesForTenantInput, /** Management of eventual consistency **/ consistencyManagement: searchMappingRulesForTenantConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search message subscriptions * * Search for message subscriptions based on given criteria. * * @example Search message subscriptions * ```ts * async function searchMessageSubscriptionsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchMessageSubscriptions( * { * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const sub of result.items ?? []) { * console.log(`Subscription: ${sub.messageName}`); * } * } * ``` * @operationId searchMessageSubscriptions * @tags Message subscription * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchMessageSubscriptions(input: searchMessageSubscriptionsInput, /** Management of eventual consistency **/ consistencyManagement: searchMessageSubscriptionsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search process definitions * * Search for process definitions based on given criteria. * * @example Search process definitions * ```ts * async function searchProcessDefinitionsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchProcessDefinitions( * { * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const def of result.items ?? []) { * console.log(`${def.processDefinitionKey}: ${def.processDefinitionId} v${def.version}`); * } * } * ``` * @operationId searchProcessDefinitions * @tags Process definition * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchProcessDefinitions(input: searchProcessDefinitionsInput, /** Management of eventual consistency **/ consistencyManagement: searchProcessDefinitionsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search related incidents * * Search for incidents caused by the process instance or any of its called process or decision instances. * * Although the `processInstanceKey` is provided as a path parameter to indicate the root process instance, * you may also include a `processInstanceKey` within the filter object to narrow results to specific * child process instances. This is useful, for example, if you want to isolate incidents associated with * subprocesses or called processes under the root instance while excluding incidents directly tied to the root. * * * @example Search process instance incidents * ```ts * async function searchProcessInstanceIncidentsExample(processInstanceKey: ProcessInstanceKey) { * const camunda = createCamundaClient(); * * const result = await camunda.searchProcessInstanceIncidents( * { * processInstanceKey, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const incident of result.items ?? []) { * console.log(`Incident: ${incident.errorType} - ${incident.errorMessage}`); * } * } * ``` * @operationId searchProcessInstanceIncidents * @tags Process instance * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchProcessInstanceIncidents(input: searchProcessInstanceIncidentsInput, /** Management of eventual consistency **/ consistencyManagement: searchProcessInstanceIncidentsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search process instances * * Search for process instances based on given criteria. * * @example Search process instances * ```ts * async function searchProcessInstancesExample(processDefinitionId: ProcessDefinitionId) { * const camunda = createCamundaClient(); * * const result = await camunda.searchProcessInstances( * { * filter: { processDefinitionId }, * sort: [{ field: 'startDate', order: 'DESC' }], * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const instance of result.items ?? []) { * console.log(`${instance.processInstanceKey}: ${instance.state}`); * } * console.log(`Total: ${result.page.totalItems}`); * } * ``` * @operationId searchProcessInstances * @tags Process instance * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchProcessInstances(input: searchProcessInstancesInput, /** Management of eventual consistency **/ consistencyManagement: searchProcessInstancesConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search roles * * Search for roles based on given criteria. * * @example Search roles * ```ts * async function searchRolesExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchRoles( * { * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const role of result.items ?? []) { * console.log(`${role.roleId}: ${role.name}`); * } * } * ``` * @operationId searchRoles * @tags Role * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchRoles(input: searchRolesInput, /** Management of eventual consistency **/ consistencyManagement: searchRolesConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search group roles * * Search roles assigned to a group. * * @example Search roles for a group * ```ts * async function searchRolesForGroupExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchRolesForGroup( * { groupId: 'engineering-team' }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const role of result.items ?? []) { * console.log(`Role: ${role.name}`); * } * } * ``` * @operationId searchRolesForGroup * @tags Group * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchRolesForGroup(input: searchRolesForGroupInput, /** Management of eventual consistency **/ consistencyManagement: searchRolesForGroupConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search roles for tenant * * Retrieves a filtered and sorted list of roles for a specified tenant. * * @example Search roles for a tenant * ```ts * async function searchRolesForTenantExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * const result = await camunda.searchRolesForTenant( * { tenantId }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const role of result.items ?? []) { * console.log(`Role: ${role.name}`); * } * } * ``` * @operationId searchRolesForTenant * @tags Tenant * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchRolesForTenant(input: searchRolesForTenantInput, /** Management of eventual consistency **/ consistencyManagement: searchRolesForTenantConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search tenants * * Retrieves a filtered and sorted list of tenants. * * @example Search tenants * ```ts * async function searchTenantsExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchTenants( * { * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const tenant of result.items ?? []) { * console.log(`${tenant.tenantId}: ${tenant.name}`); * } * } * ``` * @operationId searchTenants * @tags Tenant * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchTenants(input: searchTenantsInput, /** Management of eventual consistency **/ consistencyManagement: searchTenantsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search users * * Search for users based on given criteria. * * @example Search users * ```ts * async function searchUsersExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchUsers( * { * filter: {}, * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const user of result.items ?? []) { * console.log(`${user.username}: ${user.name}`); * } * } * ``` * @operationId searchUsers * @tags User * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchUsers(input: searchUsersInput, /** Management of eventual consistency **/ consistencyManagement: searchUsersConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search group users * * Search users assigned to a group. * * @example Search users in a group * ```ts * async function searchUsersForGroupExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchUsersForGroup( * { groupId: 'engineering-team' }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const user of result.items ?? []) { * console.log(`Member: ${user.username}`); * } * } * ``` * @operationId searchUsersForGroup * @tags Group * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchUsersForGroup(input: searchUsersForGroupInput, /** Management of eventual consistency **/ consistencyManagement: searchUsersForGroupConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search role users * * Search users with assigned role. * * @example Search users for a role * ```ts * async function searchUsersForRoleExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchUsersForRole( * { roleId: 'process-admin' }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const user of result.items ?? []) { * console.log(`User: ${user.username}`); * } * } * ``` * @operationId searchUsersForRole * @tags Role * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchUsersForRole(input: searchUsersForRoleInput, /** Management of eventual consistency **/ consistencyManagement: searchUsersForRoleConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search users for tenant * * Retrieves a filtered and sorted list of users for a specified tenant. * * @example Search users for a tenant * ```ts * async function searchUsersForTenantExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * const result = await camunda.searchUsersForTenant( * { tenantId }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const user of result.items ?? []) { * console.log(`Tenant member: ${user.username}`); * } * } * ``` * @operationId searchUsersForTenant * @tags Tenant * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchUsersForTenant(input: searchUsersForTenantInput, /** Management of eventual consistency **/ consistencyManagement: searchUsersForTenantConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search user task audit logs * * Search for user task audit logs based on given criteria. * * @example Search user task audit logs * ```ts * async function searchUserTaskAuditLogsExample(userTaskKey: UserTaskKey) { * const camunda = createCamundaClient(); * * const result = await camunda.searchUserTaskAuditLogs( * { userTaskKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const log of result.items ?? []) { * console.log(`Audit: ${log.operationType} at ${log.timestamp}`); * } * } * ``` * @operationId searchUserTaskAuditLogs * @tags User task * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchUserTaskAuditLogs(input: searchUserTaskAuditLogsInput, /** Management of eventual consistency **/ consistencyManagement: searchUserTaskAuditLogsConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search user task effective variables * * Search for the effective variables of a user task. This endpoint returns deduplicated * variables where each variable name appears at most once. When the same variable name exists * at multiple scope levels in the scope hierarchy, the value from the innermost scope (closest * to the user task) takes precedence. This is useful for retrieving the actual runtime state * of variables as seen by the user task. By default, long variable values in the response are * truncated. * * * @example Search user task effective variables * ```ts * async function searchUserTaskEffectiveVariablesExample(userTaskKey: UserTaskKey) { * const camunda = createCamundaClient(); * * const result = await camunda.searchUserTaskEffectiveVariables( * { userTaskKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const variable of result.items ?? []) { * console.log(`${variable.name} = ${variable.value}`); * } * } * ``` * @operationId searchUserTaskEffectiveVariables * @tags User task * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchUserTaskEffectiveVariables(input: searchUserTaskEffectiveVariablesInput, /** Management of eventual consistency **/ consistencyManagement: searchUserTaskEffectiveVariablesConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search user tasks * * Search for user tasks based on given criteria. * * @example Search user tasks * ```ts * async function searchUserTasksExample() { * const camunda = createCamundaClient(); * * const result = await camunda.searchUserTasks( * { * filter: { assignee: 'alice', state: 'CREATED' }, * sort: [{ field: 'creationDate', order: 'DESC' }], * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const task of result.items ?? []) { * console.log(`${task.userTaskKey}: ${task.name} (${task.state})`); * } * } * ``` * @operationId searchUserTasks * @tags User task * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchUserTasks(input: searchUserTasksInput, /** Management of eventual consistency **/ consistencyManagement: searchUserTasksConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search user task variables * * Search for user task variables based on given criteria. This endpoint returns all variable * documents visible from the user task's scope, including variables from parent scopes in the * scope hierarchy. If the same variable name exists at multiple scope levels, each scope's * variable is returned as a separate result. Use the * `/user-tasks/{userTaskKey}/effective-variables/search` endpoint to get deduplicated variables * where the innermost scope takes precedence. By default, long variable values in the response * are truncated. * * * @example Search user task variables * ```ts * async function searchUserTaskVariablesExample(userTaskKey: UserTaskKey) { * const camunda = createCamundaClient(); * * const result = await camunda.searchUserTaskVariables( * { userTaskKey }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const variable of result.items ?? []) { * console.log(`${variable.name} = ${variable.value}`); * } * } * ``` * @operationId searchUserTaskVariables * @tags User task * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchUserTaskVariables(input: searchUserTaskVariablesInput, /** Management of eventual consistency **/ consistencyManagement: searchUserTaskVariablesConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Search variables * * Search for variables based on given criteria. * * This endpoint returns variables that exist directly at the specified scopes - it does not * include variables from parent scopes that would be visible through the scope hierarchy. * * Variables can be process-level (scoped to the process instance) or local (scoped to specific * BPMN elements like tasks, subprocesses, etc.). * * By default, long variable values in the response are truncated. * * @example Search variables * ```ts * async function searchVariablesExample(processInstanceKey: ProcessInstanceKey) { * const camunda = createCamundaClient(); * * const result = await camunda.searchVariables( * { * filter: { * processInstanceKey, * }, * page: { limit: 10 }, * }, * { consistency: { waitUpToMs: 5000 } } * ); * * for (const variable of result.items ?? []) { * console.log(`${variable.name} = ${variable.value}`); * } * } * ``` * @operationId searchVariables * @tags Variable * @consistency eventual - this endpoint is backed by data that is eventually consistent with the system state. */ searchVariables(input: searchVariablesInput, /** Management of eventual consistency **/ consistencyManagement: searchVariablesConsistency, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Suspend Batch operation * * Suspends a running batch operation. * This is done asynchronously, the progress can be tracked using the batch operation status endpoint (/batch-operations/{batchOperationKey}). * * * @example Suspend a batch operation * ```ts * async function suspendBatchOperationExample(batchOperationKey: BatchOperationKey) { * const camunda = createCamundaClient(); * * await camunda.suspendBatchOperation({ batchOperationKey }); * } * ``` * @operationId suspendBatchOperation * @tags Batch operation */ suspendBatchOperation(input: suspendBatchOperationInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Throw error for job * * Reports a business error (i.e. non-technical) that occurs while processing a job. * * * @example Throw a job error * ```ts * async function throwJobErrorExample(jobKey: JobKey) { * const camunda = createCamundaClient(); * * await camunda.throwJobError({ * jobKey, * errorCode: 'PAYMENT_FAILED', * errorMessage: 'Payment provider returned error', * }); * } * ``` * @operationId throwJobError * @tags Job */ throwJobError(input: throwJobErrorInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Unassign a client from a group * * Unassigns a client from a group. * The client is removed as a group member, with associated authorizations, roles, and tenant assignments no longer applied. * * * @example Unassign a client from a group * ```ts * async function unassignClientFromGroupExample() { * const camunda = createCamundaClient(); * * await camunda.unassignClientFromGroup({ * groupId: 'engineering-team', * clientId: 'my-service-account', * }); * } * ``` * @operationId unassignClientFromGroup * @tags Group */ unassignClientFromGroup(input: unassignClientFromGroupInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Unassign a client from a tenant * * Unassigns the client from the specified tenant. * The client can no longer access tenant data. * * * @example Unassign a client from a tenant * ```ts * async function unassignClientFromTenantExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * await camunda.unassignClientFromTenant({ * tenantId, * clientId: 'my-service-account', * }); * } * ``` * @operationId unassignClientFromTenant * @tags Tenant */ unassignClientFromTenant(input: unassignClientFromTenantInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Unassign a group from a tenant * * Unassigns a group from a specified tenant. * Members of the group (users, clients) will no longer have access to the tenant's data - except they are assigned directly to the tenant. * * * @example Unassign a group from a tenant * ```ts * async function unassignGroupFromTenantExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * await camunda.unassignGroupFromTenant({ * tenantId, * groupId: 'engineering-team', * }); * } * ``` * @operationId unassignGroupFromTenant * @tags Tenant */ unassignGroupFromTenant(input: unassignGroupFromTenantInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Unassign a mapping rule from a group * * Unassigns a mapping rule from a group. * * @example Unassign a mapping rule from a group * ```ts * async function unassignMappingRuleFromGroupExample() { * const camunda = createCamundaClient(); * * await camunda.unassignMappingRuleFromGroup({ * groupId: 'engineering-team', * mappingRuleId: 'rule-123', * }); * } * ``` * @operationId unassignMappingRuleFromGroup * @tags Group */ unassignMappingRuleFromGroup(input: unassignMappingRuleFromGroupInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Unassign a mapping rule from a tenant * * Unassigns a single mapping rule from a specified tenant without deleting the rule. * * @example Unassign a mapping rule from a tenant * ```ts * async function unassignMappingRuleFromTenantExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * await camunda.unassignMappingRuleFromTenant({ * tenantId, * mappingRuleId: 'rule-123', * }); * } * ``` * @operationId unassignMappingRuleFromTenant * @tags Tenant */ unassignMappingRuleFromTenant(input: unassignMappingRuleFromTenantInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Unassign a role from a client * * Unassigns the specified role from the client. The client will no longer inherit the authorizations associated with this role. * * @example Unassign a role from a client * ```ts * async function unassignRoleFromClientExample() { * const camunda = createCamundaClient(); * * await camunda.unassignRoleFromClient({ * roleId: 'process-admin', * clientId: 'my-service-account', * }); * } * ``` * @operationId unassignRoleFromClient * @tags Role */ unassignRoleFromClient(input: unassignRoleFromClientInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Unassign a role from a group * * Unassigns the specified role from the group. All group members (user or client) no longer inherit the authorizations associated with this role. * * @example Unassign a role from a group * ```ts * async function unassignRoleFromGroupExample() { * const camunda = createCamundaClient(); * * await camunda.unassignRoleFromGroup({ * roleId: 'process-admin', * groupId: 'engineering-team', * }); * } * ``` * @operationId unassignRoleFromGroup * @tags Role */ unassignRoleFromGroup(input: unassignRoleFromGroupInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Unassign a role from a mapping rule * * Unassigns a role from a mapping rule. * * @example Unassign a role from a mapping rule * ```ts * async function unassignRoleFromMappingRuleExample() { * const camunda = createCamundaClient(); * * await camunda.unassignRoleFromMappingRule({ * roleId: 'process-admin', * mappingRuleId: 'rule-123', * }); * } * ``` * @operationId unassignRoleFromMappingRule * @tags Role */ unassignRoleFromMappingRule(input: unassignRoleFromMappingRuleInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Unassign a role from a tenant * * Unassigns a role from a specified tenant. * Users, Clients or Groups, that have the role assigned, will no longer have access to the * tenant's data - unless they are assigned directly to the tenant. * * * @example Unassign a role from a tenant * ```ts * async function unassignRoleFromTenantExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * await camunda.unassignRoleFromTenant({ * tenantId, * roleId: 'process-admin', * }); * } * ``` * @operationId unassignRoleFromTenant * @tags Tenant */ unassignRoleFromTenant(input: unassignRoleFromTenantInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Unassign a role from a user * * Unassigns a role from a user. The user will no longer inherit the authorizations associated with this role. * * @example Unassign a role from a user * ```ts * async function unassignRoleFromUserExample(username: Username) { * const camunda = createCamundaClient(); * * await camunda.unassignRoleFromUser({ * roleId: 'process-admin', * username, * }); * } * ``` * @operationId unassignRoleFromUser * @tags Role */ unassignRoleFromUser(input: unassignRoleFromUserInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Unassign a user from a group * * Unassigns a user from a group. * The user is removed as a group member, with associated authorizations, roles, and tenant assignments no longer applied. * * * @example Unassign a user from a group * ```ts * async function unassignUserFromGroupExample(username: Username) { * const camunda = createCamundaClient(); * * await camunda.unassignUserFromGroup({ * groupId: 'engineering-team', * username, * }); * } * ``` * @operationId unassignUserFromGroup * @tags Group */ unassignUserFromGroup(input: unassignUserFromGroupInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Unassign a user from a tenant * * Unassigns the user from the specified tenant. * The user can no longer access tenant data. * * * @example Unassign a user from a tenant * ```ts * async function unassignUserFromTenantExample(tenantId: TenantId, username: Username) { * const camunda = createCamundaClient(); * * await camunda.unassignUserFromTenant({ * tenantId, * username, * }); * } * ``` * @operationId unassignUserFromTenant * @tags Tenant */ unassignUserFromTenant(input: unassignUserFromTenantInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Unassign user task * * Removes the assignee of a task with the given key. Unassignment waits for blocking task listeners on this lifecycle transition. If listener processing is delayed beyond the request timeout, this endpoint can return 504. Other gateway timeout causes are also possible. Retry with backoff and inspect listener worker availability and logs when this repeats. * * * @example Unassign a user task * ```ts * async function unassignUserTaskExample(userTaskKey: UserTaskKey) { * const camunda = createCamundaClient(); * * await camunda.unassignUserTask({ userTaskKey }); * } * ``` * @operationId unassignUserTask * @tags User task */ unassignUserTask(input: unassignUserTaskInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Update authorization * * Update the authorization with the given key. * * @example Update an authorization * ```ts * async function updateAuthorizationExample(authorizationKey: AuthorizationKey) { * const camunda = createCamundaClient(); * * await camunda.updateAuthorization({ * authorizationKey, * ownerId: 'user-123', * ownerType: 'USER', * resourceId: 'order-process', * resourceType: 'PROCESS_DEFINITION', * permissionTypes: [ * 'CREATE_PROCESS_INSTANCE', * 'READ_PROCESS_INSTANCE', * 'DELETE_PROCESS_INSTANCE', * ], * }); * } * ``` * @operationId updateAuthorization * @tags Authorization */ updateAuthorization(input: updateAuthorizationInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Update a global-scoped cluster variable * * Updates the value of an existing global cluster variable. * The variable must exist, otherwise a 404 error is returned. * * * @example Update a global cluster variable * ```ts * async function updateGlobalClusterVariableExample() { * const camunda = createCamundaClient(); * * await camunda.updateGlobalClusterVariable({ * name: 'feature-flags', * value: { darkMode: false }, * }); * } * ``` * @operationId updateGlobalClusterVariable * @tags Cluster Variable */ updateGlobalClusterVariable(input: updateGlobalClusterVariableInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Update global user task listener * * Updates a global user task listener. * * @example Update a global task listener * ```ts * async function updateGlobalTaskListenerExample(id: GlobalListenerId) { * const camunda = createCamundaClient(); * * await camunda.updateGlobalTaskListener({ * id, * eventTypes: ['completing'], * type: 'updated-audit-listener', * }); * } * ``` * @operationId updateGlobalTaskListener * @tags Global listener */ updateGlobalTaskListener(input: updateGlobalTaskListenerInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Update group * * Update a group with the given ID. * * @example Update a group * ```ts * async function updateGroupExample() { * const camunda = createCamundaClient(); * * await camunda.updateGroup({ * groupId: 'engineering-team', * name: 'Engineering Team', * }); * } * ``` * @operationId updateGroup * @tags Group */ updateGroup(input: updateGroupInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Update job * * Update a job with the given key. * * @example Update a job * ```ts * async function updateJobExample(jobKey: JobKey) { * const camunda = createCamundaClient(); * * await camunda.updateJob({ * jobKey, * changeset: { retries: 5, timeout: 60000 }, * }); * } * ``` * @operationId updateJob * @tags Job */ updateJob(input: updateJobInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Update mapping rule * * Update a mapping rule. * * * @example Update a mapping rule * ```ts * async function updateMappingRuleExample() { * const camunda = createCamundaClient(); * * await camunda.updateMappingRule({ * mappingRuleId: 'ldap-group-mapping', * name: 'LDAP Group Mapping', * claimName: 'groups', * claimValue: 'engineering-team', * }); * } * ``` * @operationId updateMappingRule * @tags Mapping rule */ updateMappingRule(input: updateMappingRuleInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Update role * * Update a role with the given ID. * * @example Update a role * ```ts * async function updateRoleExample() { * const camunda = createCamundaClient(); * * await camunda.updateRole({ * roleId: 'process-admin', * name: 'Process Administrator', * }); * } * ``` * @operationId updateRole * @tags Role */ updateRole(input: updateRoleInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Update tenant * * Updates an existing tenant. * * @example Update a tenant * ```ts * async function updateTenantExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * await camunda.updateTenant({ * tenantId, * name: 'Customer Service Team', * }); * } * ``` * @operationId updateTenant * @tags Tenant */ updateTenant(input: updateTenantInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Update a tenant-scoped cluster variable * * Updates the value of an existing tenant-scoped cluster variable. * The variable must exist, otherwise a 404 error is returned. * * * @example Update a tenant cluster variable * ```ts * async function updateTenantClusterVariableExample(tenantId: TenantId) { * const camunda = createCamundaClient(); * * await camunda.updateTenantClusterVariable({ * tenantId, * name: 'config', * value: { region: 'eu-west-1' }, * }); * } * ``` * @operationId updateTenantClusterVariable * @tags Cluster Variable */ updateTenantClusterVariable(input: updateTenantClusterVariableInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Update user * * Updates a user. * * @example Update a user * ```ts * async function updateUserExample(username: Username) { * const camunda = createCamundaClient(); * * await camunda.updateUser({ * username, * name: 'Alice Jones', * email: 'alice.jones@example.com', * }); * } * ``` * @operationId updateUser * @tags User */ updateUser(input: updateUserInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Update user task * * Update a user task with the given key. Updates wait for blocking task listeners on this lifecycle transition. If listener processing is delayed beyond the request timeout, this endpoint can return 504. Other gateway timeout causes are also possible. Retry with backoff and inspect listener worker availability and logs when this repeats. * * * @example Update a user task * ```ts * async function updateUserTaskExample(userTaskKey: UserTaskKey) { * const camunda = createCamundaClient(); * * await camunda.updateUserTask({ * userTaskKey, * changeset: { * candidateUsers: ['alice', 'bob'], * dueDate: '2025-12-31T23:59:59Z', * priority: 80, * }, * }); * } * ``` * @operationId updateUserTask * @tags User task */ updateUserTask(input: updateUserTaskInput, options?: OperationOptions): CancelablePromise<_DataOf>; /** * Create a job worker that activates and processes jobs of the given type. * * Worker configuration fields inherit global defaults resolved via the * unified configuration (environment variables or equivalent `CAMUNDA_WORKER_*` * keys provided via `CamundaOptions.config`) when not explicitly set on the * config object. * @param cfg Worker configuration * @example Create a job worker * ```ts * async function createJobWorkerExample() { * const camunda = createCamundaClient(); * * const _worker = camunda.createJobWorker({ * jobType: 'payment-processing', * jobTimeoutMs: 30000, * maxParallelJobs: 5, * jobHandler: async (job): Promise => { * console.log(`Processing job ${job.jobKey}`); * return job.complete({ processed: true }); * }, * }); * * // Workers run continuously until closed * // worker.close(); * } * ``` * @example Job worker with error handling * ```ts * async function jobWorkerWithErrorHandlingExample() { * const camunda = createCamundaClient(); * * const worker = camunda.createJobWorker({ * jobType: 'email-sending', * jobTimeoutMs: 60000, * maxParallelJobs: 10, * pollIntervalMs: 300, * jobHandler: async (job): Promise => { * try { * console.log(`Sending email for job ${job.jobKey}`); * return job.complete({ sent: true }); * } catch (err) { * return job.fail({ * errorMessage: String(err), * retries: (job.retries ?? 1) - 1, * }); * } * }, * }); * * void worker; * } * ``` */ createJobWorker(cfg: JobWorkerConfig): JobWorker; /** * Create a threaded job worker that runs handler logic in a pool of worker threads. * The handler must be a separate module file that exports a default function with * signature `(job, client) => Promise`. * * This keeps the main event loop free for polling and I/O, dramatically improving * throughput for CPU-bound job handlers. * * Worker configuration fields inherit global defaults resolved via the * unified configuration (environment variables or equivalent `CAMUNDA_WORKER_*` * keys provided via `CamundaOptions.config`) when not explicitly set on the * config object. * * @param cfg Threaded worker configuration * @example Create a threaded job worker * ```ts * const worker = client.createThreadedJobWorker({ * jobType: 'cpu-heavy-task', * handlerModule: './my-handler.js', * maxParallelJobs: 32, * jobTimeoutMs: 30000, * }) * ``` */ createThreadedJobWorker(cfg: ThreadedJobWorkerConfig): ThreadedJobWorker; /** * Node-only convenience: deploy resources from local filesystem paths. * @param resourceFilenames Absolute or relative file paths to BPMN/DMN/form/resource files. * @param options Optional: tenantId. * @returns ExtendedDeploymentResult */ deployResourcesFromFiles(resourceFilenames: string[], options?: { tenantId?: string; }): CancelablePromise; } interface HttpSdkError extends Error { status: number; operationId?: string; retries?: { attempt: number; max: number; }; cause?: unknown; type?: string; title?: string; detail?: string; instance?: string; name: 'HttpSdkError'; } interface ValidationSdkError extends Error { side: 'request' | 'response'; operationId: string; issues?: unknown; name: 'ValidationSdkError'; } interface AuthSdkError extends Error { status?: number; cause?: unknown; name: 'AuthSdkError'; } interface NetworkSdkError extends Error { cause?: unknown; name: 'NetworkSdkError'; } interface CancelSdkError extends Error { operationId?: string; name: 'CancelSdkError'; } type SdkError = HttpSdkError | ValidationSdkError | AuthSdkError | NetworkSdkError | CancelSdkError; declare function isSdkError(e: unknown): e is SdkError; declare class CamundaValidationError extends Error { side: 'request' | 'response'; operationId?: string; summary: string; issues: string[]; constructor(params: { side: 'request' | 'response'; operationId?: string; message: string; summary: string; issues: string[]; }); } declare class EventualConsistencyTimeoutError extends Error { code: string; attempts: number; elapsedMs: number; lastStatus?: number; lastResponseSnippet?: string; operationId?: string; constructor(params: { attempts: number; elapsedMs: number; lastStatus?: number; lastResponse?: any; operationId?: string; message?: string; }); } type Left = { _tag: 'Left'; left: E; }; type Right = { _tag: 'Right'; right: A; }; type Either = Left | Right; type TaskEither = () => Promise>; declare const isLeft: (e: Either) => e is Left; declare const isRight: (e: Either) => e is Right; type HttpError = { name?: string; status?: number; body?: any; message?: string; } & Record; type DomainError = CamundaValidationError | EventualConsistencyTimeoutError | HttpError | Error; type DomainErrorTag = 'validation' | 'timeout' | 'http' | 'generic'; declare function classifyDomainError(err: DomainError): DomainErrorTag; declare function foldDomainError(handlers: { validation: (e: CamundaValidationError) => A; timeout: (e: EventualConsistencyTimeoutError) => A; http: (e: HttpError) => A; generic: (e: Error) => A; }): (err: DomainError) => A; type FnKeys = { [K in keyof C]: C[K] extends (...a: any) => any ? K : never; }[keyof C]; type Fpify = { [K in FnKeys]: C[K] extends (...a: infer A) => infer R ? (...a: A) => TaskEither> : never; } & { inner: C; } & { [K in Exclude>]: C[K]; }; type CamundaFpClient = Fpify; /** * * @experimental This feature under development and is not guaranteed to be fully tested or stable. * @description Camunda FP Client - a Task-Either compatible client. See the README and [this test](https://github.com/camunda/orchestration-cluster-api-js/blob/main/tests-integration/fp.test.ts) for example usage. */ declare function createCamundaFpClient(options?: CamundaOptions): CamundaFpClient; declare function retryTE(task: TaskEither, opts: { max: number; baseDelayMs?: number; shouldRetry?: (e: E, attempt: number) => boolean | Promise; }): TaskEither; declare function withTimeoutTE(task: TaskEither, ms: number, onTimeout?: () => E): TaskEither; declare function eventuallyTE(thunk: () => Promise, predicate: (a: A) => boolean | Promise, opts: { intervalMs?: number; waitUpToMs: number; }): TaskEither; export { type createAdminUserInput as $, type AuthStrategy as A, type SearchUserTaskAuditLogsData as A0, type SearchUserTaskAuditLogsErrors as A1, type SearchUserTaskAuditLogsError as A2, type SearchUserTaskAuditLogsResponses as A3, type SearchUserTaskAuditLogsResponse as A4, type CompleteUserTaskData as A5, type CompleteUserTaskErrors as A6, type CompleteUserTaskError as A7, type CompleteUserTaskResponses as A8, type CompleteUserTaskResponse as A9, classifyDomainError as AA, type DomainError as AB, type DomainErrorTag as AC, eventuallyTE as AD, type FnKeys as AE, type Fpify as AF, foldDomainError as AG, type HttpError as AH, type Left as AI, type Right as AJ, retryTE as AK, type TaskEither as AL, withTimeoutTE as AM, type SearchUserTaskEffectiveVariablesData as Aa, type SearchUserTaskEffectiveVariablesErrors as Ab, type SearchUserTaskEffectiveVariablesError as Ac, type SearchUserTaskEffectiveVariablesResponses as Ad, type SearchUserTaskEffectiveVariablesResponse as Ae, type GetUserTaskFormData as Af, type GetUserTaskFormErrors as Ag, type GetUserTaskFormError as Ah, type GetUserTaskFormResponses as Ai, type GetUserTaskFormResponse as Aj, type SearchUserTaskVariablesData as Ak, type SearchUserTaskVariablesErrors as Al, type SearchUserTaskVariablesError as Am, type SearchUserTaskVariablesResponses as An, type SearchUserTaskVariablesResponse as Ao, type SearchVariablesData as Ap, type SearchVariablesErrors as Aq, type SearchVariablesError as Ar, type SearchVariablesResponses as As, type SearchVariablesResponse as At, type GetVariableData as Au, type GetVariableErrors as Av, type GetVariableError as Aw, type GetVariableResponses as Ax, type GetVariableResponse as Ay, assertConstraint as Az, type BackpressureSeverity as B, CamundaClient as C, type assignMappingRuleToGroupInput as D, type Either as E, type assignMappingRuleToTenantInput as F, type assignRoleToClientInput as G, type HttpRetryPolicy as H, type assignRoleToGroupInput as I, type Job as J, type assignRoleToMappingRuleInput as K, type assignRoleToTenantInput as L, type assignRoleToUserInput as M, type assignUserTaskInput as N, type OperationOptions as O, type assignUserToGroupInput as P, type assignUserToTenantInput as Q, type broadcastSignalInput as R, type SdkError as S, type TelemetryHooks as T, type cancelBatchOperationInput as U, type ValidationMode as V, type cancelProcessInstanceInput as W, type cancelProcessInstancesBatchOperationInput as X, type completeJobInput as Y, type completeUserTaskInput as Z, type correlateMessageInput as _, type CamundaOptions as a, type getIncidentConsistency as a$, type createAuthorizationInput as a0, type createDeploymentInput as a1, type createDocumentInput as a2, type createDocumentLinkInput as a3, type createDocumentsInput as a4, type createElementInstanceVariablesInput as a5, type createGlobalClusterVariableInput as a6, type createGlobalTaskListenerInput as a7, type createGroupInput as a8, type createMappingRuleInput as a9, type getAuthenticationInput as aA, type getAuthorizationInput as aB, type getAuthorizationConsistency as aC, type getBatchOperationInput as aD, type getBatchOperationConsistency as aE, type getDecisionDefinitionInput as aF, type getDecisionDefinitionConsistency as aG, type getDecisionDefinitionXmlInput as aH, type getDecisionDefinitionXmlConsistency as aI, type getDecisionInstanceInput as aJ, type getDecisionInstanceConsistency as aK, type getDecisionRequirementsInput as aL, type getDecisionRequirementsConsistency as aM, type getDecisionRequirementsXmlInput as aN, type getDecisionRequirementsXmlConsistency as aO, type getDocumentInput as aP, type getElementInstanceInput as aQ, type getElementInstanceConsistency as aR, type getGlobalClusterVariableInput as aS, type getGlobalClusterVariableConsistency as aT, type getGlobalJobStatisticsInput as aU, type getGlobalJobStatisticsConsistency as aV, type getGlobalTaskListenerInput as aW, type getGlobalTaskListenerConsistency as aX, type getGroupInput as aY, type getGroupConsistency as aZ, type getIncidentInput as a_, type createProcessInstanceInput as aa, type createRoleInput as ab, type createTenantInput as ac, type createTenantClusterVariableInput as ad, type createUserInput as ae, type deleteAuthorizationInput as af, type deleteDecisionInstanceInput as ag, type deleteDecisionInstancesBatchOperationInput as ah, type deleteDocumentInput as ai, type deleteGlobalClusterVariableInput as aj, type deleteGlobalTaskListenerInput as ak, type deleteGroupInput as al, type deleteMappingRuleInput as am, type deleteProcessInstanceInput as an, type deleteProcessInstancesBatchOperationInput as ao, type deleteResourceInput as ap, type deleteRoleInput as aq, type deleteTenantInput as ar, type deleteTenantClusterVariableInput as as, type deleteUserInput as at, type evaluateConditionalsInput as au, type evaluateDecisionInput as av, type evaluateExpressionInput as aw, type failJobInput as ax, type getAuditLogInput as ay, type getAuditLogConsistency as az, type CancelablePromise as b, type publishMessageInput as b$, type getJobErrorStatisticsInput as b0, type getJobErrorStatisticsConsistency as b1, type getJobTimeSeriesStatisticsInput as b2, type getJobTimeSeriesStatisticsConsistency as b3, type getJobTypeStatisticsInput as b4, type getJobTypeStatisticsConsistency as b5, type getJobWorkerStatisticsInput as b6, type getJobWorkerStatisticsConsistency as b7, type getLicenseInput as b8, type getMappingRuleInput as b9, type getResourceContentInput as bA, type getRoleInput as bB, type getRoleConsistency as bC, type getStartProcessFormInput as bD, type getStartProcessFormConsistency as bE, type getStatusInput as bF, type getSystemConfigurationInput as bG, type getTenantInput as bH, type getTenantConsistency as bI, type getTenantClusterVariableInput as bJ, type getTenantClusterVariableConsistency as bK, type getTopologyInput as bL, type getUsageMetricsInput as bM, type getUsageMetricsConsistency as bN, type getUserInput as bO, type getUserConsistency as bP, type getUserTaskInput as bQ, type getUserTaskConsistency as bR, type getUserTaskFormInput as bS, type getUserTaskFormConsistency as bT, type getVariableInput as bU, type getVariableConsistency as bV, type migrateProcessInstanceInput as bW, type migrateProcessInstancesBatchOperationInput as bX, type modifyProcessInstanceInput as bY, type modifyProcessInstancesBatchOperationInput as bZ, type pinClockInput as b_, type getMappingRuleConsistency as ba, type getProcessDefinitionInput as bb, type getProcessDefinitionConsistency as bc, type getProcessDefinitionInstanceStatisticsInput as bd, type getProcessDefinitionInstanceStatisticsConsistency as be, type getProcessDefinitionInstanceVersionStatisticsInput as bf, type getProcessDefinitionInstanceVersionStatisticsConsistency as bg, type getProcessDefinitionMessageSubscriptionStatisticsInput as bh, type getProcessDefinitionMessageSubscriptionStatisticsConsistency as bi, type getProcessDefinitionStatisticsInput as bj, type getProcessDefinitionStatisticsConsistency as bk, type getProcessDefinitionXmlInput as bl, type getProcessDefinitionXmlConsistency as bm, type getProcessInstanceInput as bn, type getProcessInstanceConsistency as bo, type getProcessInstanceCallHierarchyInput as bp, type getProcessInstanceCallHierarchyConsistency as bq, type getProcessInstanceSequenceFlowsInput as br, type getProcessInstanceSequenceFlowsConsistency as bs, type getProcessInstanceStatisticsInput as bt, type getProcessInstanceStatisticsConsistency as bu, type getProcessInstanceStatisticsByDefinitionInput as bv, type getProcessInstanceStatisticsByDefinitionConsistency as bw, type getProcessInstanceStatisticsByErrorInput as bx, type getProcessInstanceStatisticsByErrorConsistency as by, type getResourceInput as bz, createCamundaClient as c, type searchRolesForGroupInput as c$, type resetClockInput as c0, type resolveIncidentInput as c1, type resolveIncidentsBatchOperationInput as c2, type resolveProcessInstanceIncidentsInput as c3, type resumeBatchOperationInput as c4, type searchAuditLogsInput as c5, type searchAuditLogsConsistency as c6, type searchAuthorizationsInput as c7, type searchAuthorizationsConsistency as c8, type searchBatchOperationItemsInput as c9, type searchGroupIdsForTenantConsistency as cA, type searchGroupsInput as cB, type searchGroupsConsistency as cC, type searchGroupsForRoleInput as cD, type searchGroupsForRoleConsistency as cE, type searchIncidentsInput as cF, type searchIncidentsConsistency as cG, type searchJobsInput as cH, type searchJobsConsistency as cI, type searchMappingRuleInput as cJ, type searchMappingRuleConsistency as cK, type searchMappingRulesForGroupInput as cL, type searchMappingRulesForGroupConsistency as cM, type searchMappingRulesForRoleInput as cN, type searchMappingRulesForRoleConsistency as cO, type searchMappingRulesForTenantInput as cP, type searchMappingRulesForTenantConsistency as cQ, type searchMessageSubscriptionsInput as cR, type searchMessageSubscriptionsConsistency as cS, type searchProcessDefinitionsInput as cT, type searchProcessDefinitionsConsistency as cU, type searchProcessInstanceIncidentsInput as cV, type searchProcessInstanceIncidentsConsistency as cW, type searchProcessInstancesInput as cX, type searchProcessInstancesConsistency as cY, type searchRolesInput as cZ, type searchRolesConsistency as c_, type searchBatchOperationItemsConsistency as ca, type searchBatchOperationsInput as cb, type searchBatchOperationsConsistency as cc, type searchClientsForGroupInput as cd, type searchClientsForGroupConsistency as ce, type searchClientsForRoleInput as cf, type searchClientsForRoleConsistency as cg, type searchClientsForTenantInput as ch, type searchClientsForTenantConsistency as ci, type searchClusterVariablesInput as cj, type searchClusterVariablesConsistency as ck, type searchCorrelatedMessageSubscriptionsInput as cl, type searchCorrelatedMessageSubscriptionsConsistency as cm, type searchDecisionDefinitionsInput as cn, type searchDecisionDefinitionsConsistency as co, type searchDecisionInstancesInput as cp, type searchDecisionInstancesConsistency as cq, type searchDecisionRequirementsInput as cr, type searchDecisionRequirementsConsistency as cs, type searchElementInstanceIncidentsInput as ct, type searchElementInstanceIncidentsConsistency as cu, type searchElementInstancesInput as cv, type searchElementInstancesConsistency as cw, type searchGlobalTaskListenersInput as cx, type searchGlobalTaskListenersConsistency as cy, type searchGroupIdsForTenantInput as cz, type CamundaFpClient as d, AuditLogResultEnum as d$, type searchRolesForGroupConsistency as d0, type searchRolesForTenantInput as d1, type searchRolesForTenantConsistency as d2, type searchTenantsInput as d3, type searchTenantsConsistency as d4, type searchUsersInput as d5, type searchUsersConsistency as d6, type searchUsersForGroupInput as d7, type searchUsersForGroupConsistency as d8, type searchUsersForRoleInput as d9, type unassignUserFromGroupInput as dA, type unassignUserFromTenantInput as dB, type unassignUserTaskInput as dC, type updateAuthorizationInput as dD, type updateGlobalClusterVariableInput as dE, type updateGlobalTaskListenerInput as dF, type updateGroupInput as dG, type updateJobInput as dH, type updateMappingRuleInput as dI, type updateRoleInput as dJ, type updateTenantInput as dK, type updateTenantClusterVariableInput as dL, type updateUserInput as dM, type updateUserTaskInput as dN, type ExtendedDeploymentResult as dO, CancelError as dP, type CamundaKey as dQ, type ClientOptions as dR, type AuditLogResult as dS, type AuditLogSearchQuerySortRequest as dT, type AuditLogSearchQueryRequest as dU, type AuditLogFilter as dV, type AuditLogSearchQueryResult as dW, AuditLogEntityKey as dX, AuditLogEntityTypeEnum as dY, AuditLogOperationTypeEnum as dZ, AuditLogActorTypeEnum as d_, type searchUsersForRoleConsistency as da, type searchUsersForTenantInput as db, type searchUsersForTenantConsistency as dc, type searchUserTaskAuditLogsInput as dd, type searchUserTaskAuditLogsConsistency as de, type searchUserTaskEffectiveVariablesInput as df, type searchUserTaskEffectiveVariablesConsistency as dg, type searchUserTasksInput as dh, type searchUserTasksConsistency as di, type searchUserTaskVariablesInput as dj, type searchUserTaskVariablesConsistency as dk, type searchVariablesInput as dl, type searchVariablesConsistency as dm, type suspendBatchOperationInput as dn, type throwJobErrorInput as dp, type unassignClientFromGroupInput as dq, type unassignClientFromTenantInput as dr, type unassignGroupFromTenantInput as ds, type unassignMappingRuleFromGroupInput as dt, type unassignMappingRuleFromTenantInput as du, type unassignRoleFromClientInput as dv, type unassignRoleFromGroupInput as dw, type unassignRoleFromMappingRuleInput as dx, type unassignRoleFromTenantInput as dy, type unassignRoleFromUserInput as dz, createCamundaFpClient as e, type ClusterVariableSearchQueryRequest as e$, AuditLogCategoryEnum as e0, type AuditLogEntityKeyFilterProperty as e1, type AdvancedAuditLogEntityKeyFilter as e2, type EntityTypeFilterProperty as e3, type AdvancedEntityTypeFilter as e4, type OperationTypeFilterProperty as e5, type AdvancedOperationTypeFilter as e6, type CategoryFilterProperty as e7, type AdvancedCategoryFilter as e8, type AuditLogResultFilterProperty as e9, type BatchOperationItemFilter as eA, type BatchOperationItemSearchQueryResult as eB, type BatchOperationItemResponse as eC, type DecisionInstanceDeletionBatchOperationRequest as eD, type ProcessInstanceCancellationBatchOperationRequest as eE, type ProcessInstanceIncidentResolutionBatchOperationRequest as eF, type ProcessInstanceDeletionBatchOperationRequest as eG, type ProcessInstanceMigrationBatchOperationRequest as eH, type ProcessInstanceMigrationBatchOperationPlan as eI, type ProcessInstanceModificationBatchOperationRequest as eJ, type ProcessInstanceModificationMoveBatchOperationInstruction as eK, BatchOperationItemStateEnum as eL, BatchOperationStateEnum as eM, BatchOperationTypeEnum as eN, type BatchOperationTypeFilterProperty as eO, type AdvancedBatchOperationTypeFilter as eP, type BatchOperationStateFilterProperty as eQ, type AdvancedBatchOperationStateFilter as eR, type BatchOperationItemStateFilterProperty as eS, type AdvancedBatchOperationItemStateFilter as eT, type ClockPinRequest as eU, ClusterVariableScopeEnum as eV, type CreateClusterVariableRequest as eW, type UpdateClusterVariableRequest as eX, type ClusterVariableResult as eY, type ClusterVariableSearchResult as eZ, type ClusterVariableResultBase as e_, type AdvancedResultFilter as ea, type AuditLogActorTypeFilterProperty as eb, type AdvancedActorTypeFilter as ec, type CamundaUserResult as ed, type AuthorizationIdBasedRequest as ee, type AuthorizationPropertyBasedRequest as ef, type AuthorizationRequest as eg, type AuthorizationSearchQuerySortRequest as eh, type AuthorizationSearchQuery as ei, type AuthorizationFilter as ej, type AuthorizationResult as ek, type AuthorizationSearchResult as el, type AuthorizationCreateResult as em, PermissionTypeEnum as en, ResourceTypeEnum as eo, OwnerTypeEnum as ep, AuthorizationKey as eq, type BatchOperationCreatedResult as er, type BatchOperationSearchQuerySortRequest as es, type BatchOperationSearchQuery as et, type BatchOperationFilter as eu, type BatchOperationSearchQueryResult as ev, type BatchOperationResponse as ew, type BatchOperationError as ex, type BatchOperationItemSearchQuerySortRequest as ey, type BatchOperationItemSearchQuery as ez, isRight as f, type DocumentMetadataResponse as f$, type ClusterVariableSearchQuerySortRequest as f0, type ClusterVariableSearchQueryFilterRequest as f1, type ClusterVariableScopeFilterProperty as f2, type AdvancedClusterVariableScopeFilter as f3, type ClusterVariableSearchQueryResult as f4, type TopologyResponse as f5, type BrokerInfo as f6, type Partition as f7, type ConditionalEvaluationInstruction as f8, type EvaluateConditionalResult as f9, type AdvancedDecisionInstanceStateFilter as fA, type DecisionInstanceStateFilterProperty as fB, type DecisionRequirementsSearchQuerySortRequest as fC, type DecisionRequirementsSearchQuery as fD, type DecisionRequirementsFilter as fE, type DecisionRequirementsSearchQueryResult as fF, type DecisionRequirementsResult as fG, type DeploymentResult as fH, type DeploymentMetadataResult as fI, type DeploymentProcessResult as fJ, type DeploymentDecisionResult as fK, type DeploymentDecisionRequirementsResult as fL, type DeploymentFormResult as fM, type DeploymentResourceResult as fN, type DeleteResourceRequest as fO, type DeleteResourceResponse as fP, type ResourceResult as fQ, DeploymentKey as fR, type ResourceKey as fS, type DeploymentKeyFilterProperty as fT, type AdvancedDeploymentKeyFilter as fU, type ResourceKeyFilterProperty as fV, type AdvancedResourceKeyFilter as fW, type DocumentReference as fX, type DocumentCreationFailureDetail as fY, type DocumentCreationBatchResponse as fZ, type DocumentMetadata as f_, ConditionalEvaluationKey as fa, type ProcessInstanceReference as fb, StartCursor as fc, EndCursor as fd, type DecisionDefinitionSearchQuerySortRequest as fe, type DecisionDefinitionSearchQuery as ff, type DecisionDefinitionFilter as fg, type DecisionDefinitionSearchQueryResult as fh, type DecisionDefinitionResult as fi, type DecisionEvaluationInstruction as fj, type DecisionEvaluationById as fk, type DecisionEvaluationByKey as fl, type EvaluateDecisionResult as fm, type EvaluatedDecisionResult as fn, type DecisionInstanceSearchQuerySortRequest as fo, type DecisionInstanceSearchQuery as fp, type DecisionInstanceFilter as fq, type DeleteDecisionInstanceRequest as fr, type DecisionInstanceSearchQueryResult as fs, type DecisionInstanceResult as ft, type DecisionInstanceGetQueryResult as fu, type EvaluatedDecisionInputItem as fv, type EvaluatedDecisionOutputItem as fw, type MatchedDecisionRuleItem as fx, DecisionDefinitionTypeEnum as fy, DecisionInstanceStateEnum as fz, CamundaValidationError as g, FormId as g$, type DocumentLinkRequest as g0, type DocumentLink as g1, DocumentId as g2, type ElementInstanceSearchQuerySortRequest as g3, type ElementInstanceSearchQuery as g4, type ElementInstanceFilter as g5, type ElementInstanceStateFilterProperty as g6, type AdvancedElementInstanceStateFilter as g7, type ElementInstanceSearchQueryResult as g8, type ElementInstanceResult as g9, type GlobalTaskListenerSearchQueryFilterRequest as gA, type GlobalListenerSourceFilterProperty as gB, type AdvancedGlobalListenerSourceFilter as gC, type GlobalTaskListenerEventTypeFilterProperty as gD, type AdvancedGlobalTaskListenerEventTypeFilter as gE, type GlobalTaskListenerSearchQueryResult as gF, type GroupCreateRequest as gG, type GroupCreateResult as gH, type GroupUpdateRequest as gI, type GroupUpdateResult as gJ, type GroupResult as gK, type GroupSearchQuerySortRequest as gL, type GroupSearchQueryRequest as gM, type GroupFilter as gN, type GroupSearchQueryResult as gO, type GroupUserResult as gP, type GroupUserSearchResult as gQ, type GroupUserSearchQueryRequest as gR, type GroupUserSearchQuerySortRequest as gS, type GroupClientResult as gT, type GroupClientSearchResult as gU, type GroupClientSearchQueryRequest as gV, type GroupMappingRuleSearchResult as gW, type GroupRoleSearchResult as gX, type GroupClientSearchQuerySortRequest as gY, ProcessDefinitionId as gZ, ElementId as g_, ElementInstanceStateEnum as ga, type AdHocSubProcessActivateActivitiesInstruction as gb, type AdHocSubProcessActivateActivityReference as gc, type ExpressionEvaluationRequest as gd, type ExpressionEvaluationResult as ge, type ExpressionEvaluationWarningItem as gf, type LikeFilter as gg, type BasicStringFilter as gh, type AdvancedStringFilter as gi, type BasicStringFilterProperty as gj, type StringFilterProperty as gk, type AdvancedIntegerFilter as gl, type IntegerFilterProperty as gm, type AdvancedDateTimeFilter as gn, type DateTimeFilterProperty as go, type FormResult as gp, GlobalListenerSourceEnum as gq, GlobalTaskListenerEventTypeEnum as gr, type GlobalListenerBase as gs, type GlobalTaskListenerBase as gt, type GlobalTaskListenerEventTypes as gu, type CreateGlobalTaskListenerRequest as gv, type UpdateGlobalTaskListenerRequest as gw, type GlobalTaskListenerResult as gx, type GlobalTaskListenerSearchQueryRequest as gy, type GlobalTaskListenerSearchQuerySortRequest as gz, EventualConsistencyTimeoutError as h, type JobUpdateRequest as h$, DecisionDefinitionId as h0, GlobalListenerId as h1, TenantId as h2, Username as h3, Tag as h4, type TagSet as h5, BusinessId as h6, type IncidentSearchQuery as h7, type IncidentFilter as h8, type IncidentErrorTypeFilterProperty as h9, type JobWorkerStatisticsQueryResult as hA, type JobWorkerStatisticsItem as hB, type JobTimeSeriesStatisticsQuery as hC, type JobTimeSeriesStatisticsFilter as hD, type JobTimeSeriesStatisticsQueryResult as hE, type JobTimeSeriesStatisticsItem as hF, type JobErrorStatisticsQuery as hG, type JobErrorStatisticsFilter as hH, type JobErrorStatisticsQueryResult as hI, type JobErrorStatisticsItem as hJ, type JobActivationRequest as hK, type JobActivationResult as hL, type ActivatedJobResult$1 as hM, type UserTaskProperties as hN, type JobSearchQuery as hO, type JobSearchQuerySortRequest as hP, type JobFilter as hQ, type JobSearchQueryResult as hR, type JobSearchResult as hS, type JobFailRequest as hT, type JobErrorRequest$1 as hU, type JobCompletionRequest as hV, type JobResult as hW, type JobResultUserTask as hX, type JobResultCorrections as hY, type JobResultAdHocSubProcess as hZ, type JobResultActivateElement as h_, type AdvancedIncidentErrorTypeFilter as ha, IncidentErrorTypeEnum as hb, type IncidentStateFilterProperty as hc, type AdvancedIncidentStateFilter as hd, IncidentStateEnum as he, type IncidentSearchQuerySortRequest as hf, type IncidentSearchQueryResult as hg, type IncidentResult as hh, type IncidentResolutionRequest as hi, type IncidentProcessInstanceStatisticsByErrorQuery as hj, type IncidentProcessInstanceStatisticsByErrorQueryResult as hk, type IncidentProcessInstanceStatisticsByErrorResult as hl, type IncidentProcessInstanceStatisticsByErrorQuerySortRequest as hm, type IncidentProcessInstanceStatisticsByDefinitionQuery as hn, type IncidentProcessInstanceStatisticsByDefinitionQueryResult as ho, type IncidentProcessInstanceStatisticsByDefinitionResult as hp, type IncidentProcessInstanceStatisticsByDefinitionFilter as hq, type IncidentProcessInstanceStatisticsByDefinitionQuerySortRequest as hr, type GlobalJobStatisticsQueryResult as hs, type StatusMetric as ht, type JobTypeStatisticsQuery as hu, type JobTypeStatisticsFilter as hv, type JobTypeStatisticsQueryResult as hw, type JobTypeStatisticsItem as hx, type JobWorkerStatisticsQuery as hy, type JobWorkerStatisticsFilter as hz, isLeft as i, type MappingRuleResult as i$, type JobChangeset as i0, TenantFilterEnum as i1, JobStateEnum as i2, JobKindEnum as i3, JobListenerEventTypeEnum as i4, type JobKindFilterProperty as i5, type AdvancedJobKindFilter as i6, type JobListenerEventTypeFilterProperty as i7, type AdvancedJobListenerEventTypeFilter as i8, type JobStateFilterProperty as i9, type AdvancedElementInstanceKeyFilter as iA, type JobKeyFilterProperty as iB, type AdvancedJobKeyFilter as iC, type DecisionDefinitionKeyFilterProperty as iD, type AdvancedDecisionDefinitionKeyFilter as iE, type ScopeKeyFilterProperty as iF, type AdvancedScopeKeyFilter as iG, type VariableKeyFilterProperty as iH, type AdvancedVariableKeyFilter as iI, type DecisionEvaluationInstanceKeyFilterProperty as iJ, type AdvancedDecisionEvaluationInstanceKeyFilter as iK, type AuditLogKeyFilterProperty as iL, type AdvancedAuditLogKeyFilter as iM, type FormKeyFilterProperty as iN, type AdvancedFormKeyFilter as iO, type DecisionEvaluationKeyFilterProperty as iP, type AdvancedDecisionEvaluationKeyFilter as iQ, type DecisionRequirementsKeyFilterProperty as iR, type AdvancedDecisionRequirementsKeyFilter as iS, type LicenseResponse as iT, type MappingRuleCreateUpdateRequest as iU, type MappingRuleCreateRequest as iV, type MappingRuleUpdateRequest as iW, type MappingRuleCreateUpdateResult as iX, type MappingRuleCreateResult as iY, type MappingRuleUpdateResult as iZ, type MappingRuleSearchQueryResult as i_, type AdvancedJobStateFilter as ia, type LongKey as ib, ProcessInstanceKey as ic, ProcessDefinitionKey as id, ElementInstanceKey as ie, UserTaskKey as ig, FormKey as ih, VariableKey as ii, type ScopeKey as ij, IncidentKey as ik, JobKey as il, DecisionDefinitionKey as im, DecisionEvaluationInstanceKey as io, DecisionEvaluationKey as ip, DecisionRequirementsKey as iq, DecisionInstanceKey as ir, BatchOperationKey as is, type OperationReference as it, AuditLogKey as iu, type ProcessDefinitionKeyFilterProperty as iv, type AdvancedProcessDefinitionKeyFilter as iw, type ProcessInstanceKeyFilterProperty as ix, type AdvancedProcessInstanceKeyFilter as iy, type ElementInstanceKeyFilterProperty as iz, isSdkError as j, type ProcessInstanceSequenceFlowsQueryResult as j$, type MappingRuleSearchQuerySortRequest as j0, type MappingRuleSearchQueryRequest as j1, type MappingRuleFilter as j2, type MessageCorrelationRequest as j3, type MessageCorrelationResult as j4, type MessagePublicationRequest as j5, type MessagePublicationResult as j6, type MessageSubscriptionSearchQueryResult as j7, type MessageSubscriptionResult as j8, type MessageSubscriptionSearchQuerySortRequest as j9, type ProcessDefinitionInstanceStatisticsQuery as jA, type ProcessDefinitionInstanceStatisticsQueryResult as jB, type ProcessDefinitionInstanceStatisticsResult as jC, type ProcessDefinitionInstanceStatisticsQuerySortRequest as jD, type ProcessDefinitionInstanceVersionStatisticsQuery as jE, type ProcessDefinitionInstanceVersionStatisticsFilter as jF, type ProcessDefinitionInstanceVersionStatisticsQueryResult as jG, type ProcessDefinitionInstanceVersionStatisticsResult as jH, type ProcessDefinitionInstanceVersionStatisticsQuerySortRequest as jI, type ProcessInstanceCreationInstruction as jJ, type ProcessInstanceCreationInstructionById as jK, type ProcessInstanceCreationInstructionByKey as jL, type ProcessInstanceCreationStartInstruction as jM, type ProcessInstanceCreationRuntimeInstruction as jN, type ProcessInstanceCreationTerminateInstruction as jO, type CreateProcessInstanceResult as jP, type ProcessInstanceSearchQuerySortRequest as jQ, type ProcessInstanceSearchQuery as jR, type BaseProcessInstanceFilterFields as jS, type ProcessDefinitionStatisticsFilter as jT, type ProcessInstanceFilterFields as jU, type ProcessInstanceFilter as jV, type ProcessInstanceSearchQueryResult as jW, type ProcessInstanceResult as jX, type CancelProcessInstanceRequest as jY, type DeleteProcessInstanceRequest as jZ, type ProcessInstanceCallHierarchyEntry as j_, type MessageSubscriptionSearchQuery as ja, type MessageSubscriptionFilter as jb, type CorrelatedMessageSubscriptionSearchQueryResult as jc, type CorrelatedMessageSubscriptionResult as jd, type CorrelatedMessageSubscriptionSearchQuery as je, type CorrelatedMessageSubscriptionSearchQuerySortRequest as jf, MessageSubscriptionStateEnum as jg, type CorrelatedMessageSubscriptionFilter as jh, type MessageSubscriptionStateFilterProperty as ji, type AdvancedMessageSubscriptionStateFilter as jj, type AdvancedMessageSubscriptionKeyFilter as jk, type MessageSubscriptionKeyFilterProperty as jl, MessageSubscriptionKey as jm, MessageKey as jn, type ProblemDetail as jo, type ProcessDefinitionSearchQuerySortRequest as jp, type ProcessDefinitionSearchQuery as jq, type ProcessDefinitionFilter as jr, type ProcessDefinitionSearchQueryResult as js, type ProcessDefinitionResult as jt, type ProcessDefinitionElementStatisticsQuery as ju, type ProcessDefinitionElementStatisticsQueryResult as jv, type ProcessElementStatisticsResult as jw, type ProcessDefinitionMessageSubscriptionStatisticsQuery as jx, type ProcessDefinitionMessageSubscriptionStatisticsQueryResult as jy, type ProcessDefinitionMessageSubscriptionStatisticsResult as jz, type EnrichedActivatedJob as k, type TenantResult as k$, type ProcessInstanceSequenceFlowResult as k0, type ProcessInstanceElementStatisticsQueryResult as k1, type ProcessInstanceMigrationInstruction as k2, type MigrateProcessInstanceMappingInstruction as k3, type ProcessInstanceModificationInstruction as k4, type ProcessInstanceModificationActivateInstruction as k5, type ModifyProcessInstanceVariableInstruction as k6, type ProcessInstanceModificationMoveInstruction as k7, type SourceElementInstruction as k8, type SourceElementIdInstruction as k9, type RoleClientSearchQueryRequest as kA, type RoleClientSearchQuerySortRequest as kB, type RoleGroupResult as kC, type RoleGroupSearchResult as kD, type RoleGroupSearchQueryRequest as kE, type RoleMappingRuleSearchResult as kF, type RoleGroupSearchQuerySortRequest as kG, type SearchQueryRequest as kH, type SearchQueryPageRequest as kI, type LimitPagination as kJ, type OffsetPagination as kK, type CursorForwardPagination as kL, type CursorBackwardPagination as kM, type SearchQueryResponse as kN, SortOrderEnum as kO, type SearchQueryPageResponse as kP, type SignalBroadcastRequest as kQ, type SignalBroadcastResult as kR, SignalKey as kS, type UsageMetricsResponse as kT, type UsageMetricsResponseItem as kU, type SystemConfigurationResponse as kV, type JobMetricsConfigurationResponse as kW, type TenantCreateRequest as kX, type TenantCreateResult as kY, type TenantUpdateRequest as kZ, type TenantUpdateResult as k_, type SourceElementInstanceKeyInstruction as ka, type AncestorScopeInstruction as kb, type DirectAncestorKeyInstruction as kc, type InferredAncestorKeyInstruction as kd, type UseSourceParentKeyInstruction as ke, type ProcessInstanceModificationTerminateInstruction as kf, type ProcessInstanceModificationTerminateByIdInstruction as kg, type ProcessInstanceModificationTerminateByKeyInstruction as kh, ProcessInstanceStateEnum as ki, type AdvancedProcessInstanceStateFilter as kj, type ProcessInstanceStateFilterProperty as kk, type RoleCreateRequest as kl, type RoleCreateResult as km, type RoleUpdateRequest as kn, type RoleUpdateResult as ko, type RoleResult as kp, type RoleSearchQuerySortRequest as kq, type RoleSearchQueryRequest as kr, type RoleFilter as ks, type RoleSearchQueryResult as kt, type RoleUserResult as ku, type RoleUserSearchResult as kv, type RoleUserSearchQueryRequest as kw, type RoleUserSearchQuerySortRequest as kx, type RoleClientResult as ky, type RoleClientSearchResult as kz, JobActionReceipt as l, type ClusterVariableScopeExactMatch as l$, type TenantSearchQuerySortRequest as l0, type TenantSearchQueryRequest as l1, type TenantFilter as l2, type TenantSearchQueryResult as l3, type TenantUserResult as l4, type TenantUserSearchResult as l5, type TenantUserSearchQueryRequest as l6, type TenantUserSearchQuerySortRequest as l7, type TenantClientResult as l8, type TenantClientSearchResult as l9, type UserRequest as lA, type UserCreateResult as lB, type UserUpdateRequest as lC, type UserUpdateResult as lD, type UserResult as lE, type UserSearchQuerySortRequest as lF, type UserSearchQueryRequest as lG, type UserFilter as lH, type UserSearchResult as lI, type VariableSearchQuerySortRequest as lJ, type VariableSearchQuery as lK, type VariableFilter as lL, type VariableSearchQueryResult as lM, type VariableSearchResult as lN, type VariableResult as lO, type VariableResultBase as lP, type VariableValueFilterProperty as lQ, type SetVariableRequest as lR, type AuditLogEntityKeyExactMatch as lS, type EntityTypeExactMatch as lT, type OperationTypeExactMatch as lU, type CategoryExactMatch as lV, type AuditLogResultExactMatch as lW, type AuditLogActorTypeExactMatch as lX, type BatchOperationTypeExactMatch as lY, type BatchOperationStateExactMatch as lZ, type BatchOperationItemStateExactMatch as l_, type TenantClientSearchQueryRequest as la, type TenantClientSearchQuerySortRequest as lb, type TenantGroupResult as lc, type TenantGroupSearchResult as ld, type TenantGroupSearchQueryRequest as le, type TenantRoleSearchResult as lf, type TenantMappingRuleSearchResult as lg, type TenantGroupSearchQuerySortRequest as lh, type UserTaskSearchQuerySortRequest as li, type UserTaskSearchQuery as lj, type UserTaskFilter as lk, type UserTaskSearchQueryResult as ll, type UserTaskResult as lm, type UserTaskCompletionRequest as ln, type UserTaskAssignmentRequest as lo, type UserTaskUpdateRequest as lp, type Changeset as lq, type UserTaskVariableSearchQuerySortRequest as lr, type UserTaskVariableSearchQueryRequest as ls, type UserTaskEffectiveVariableSearchQueryRequest as lt, type UserTaskAuditLogSearchQueryRequest as lu, UserTaskStateEnum as lv, type UserTaskVariableFilter as lw, type UserTaskStateFilterProperty as lx, type AdvancedUserTaskStateFilter as ly, type UserTaskAuditLogFilter as lz, JobWorker as m, type UpdateAuthorizationErrors as m$, type DecisionInstanceStateExactMatch as m0, type DeploymentKeyExactMatch as m1, type ResourceKeyExactMatch as m2, type ElementInstanceStateExactMatch as m3, type GlobalListenerSourceExactMatch as m4, type GlobalTaskListenerEventTypeExactMatch as m5, type IncidentErrorTypeExactMatch as m6, type IncidentStateExactMatch as m7, type JobKindExactMatch as m8, type JobListenerEventTypeExactMatch as m9, type GetAuditLogResponse as mA, type GetAuthenticationData as mB, type GetAuthenticationErrors as mC, type GetAuthenticationError as mD, type GetAuthenticationResponses as mE, type GetAuthenticationResponse as mF, type CreateAuthorizationData as mG, type CreateAuthorizationErrors as mH, type CreateAuthorizationError as mI, type CreateAuthorizationResponses as mJ, type CreateAuthorizationResponse as mK, type SearchAuthorizationsData as mL, type SearchAuthorizationsErrors as mM, type SearchAuthorizationsError as mN, type SearchAuthorizationsResponses as mO, type SearchAuthorizationsResponse as mP, type DeleteAuthorizationData as mQ, type DeleteAuthorizationErrors as mR, type DeleteAuthorizationError as mS, type DeleteAuthorizationResponses as mT, type DeleteAuthorizationResponse as mU, type GetAuthorizationData as mV, type GetAuthorizationErrors as mW, type GetAuthorizationError as mX, type GetAuthorizationResponses as mY, type GetAuthorizationResponse as mZ, type UpdateAuthorizationData as m_, type JobStateExactMatch as ma, type ProcessDefinitionKeyExactMatch as mb, type ProcessInstanceKeyExactMatch as mc, type ElementInstanceKeyExactMatch as md, type JobKeyExactMatch as me, type DecisionDefinitionKeyExactMatch as mf, type ScopeKeyExactMatch as mg, type VariableKeyExactMatch as mh, type DecisionEvaluationInstanceKeyExactMatch as mi, type AuditLogKeyExactMatch as mj, type FormKeyExactMatch as mk, type DecisionEvaluationKeyExactMatch as ml, type DecisionRequirementsKeyExactMatch as mm, type MessageSubscriptionStateExactMatch as mn, type MessageSubscriptionKeyExactMatch as mo, type ProcessInstanceStateExactMatch as mp, type UserTaskStateExactMatch as mq, type SearchAuditLogsData as mr, type SearchAuditLogsErrors as ms, type SearchAuditLogsError as mt, type SearchAuditLogsResponses as mu, type SearchAuditLogsResponse as mv, type GetAuditLogData as mw, type GetAuditLogErrors as mx, type GetAuditLogError as my, type GetAuditLogResponses as mz, type JobWorkerConfig as n, type SearchClusterVariablesData as n$, type UpdateAuthorizationError as n0, type UpdateAuthorizationResponses as n1, type UpdateAuthorizationResponse as n2, type SearchBatchOperationItemsData as n3, type SearchBatchOperationItemsErrors as n4, type SearchBatchOperationItemsError as n5, type SearchBatchOperationItemsResponses as n6, type SearchBatchOperationItemsResponse as n7, type SearchBatchOperationsData as n8, type SearchBatchOperationsErrors as n9, type PinClockResponses as nA, type PinClockResponse as nB, type ResetClockData as nC, type ResetClockErrors as nD, type ResetClockError as nE, type ResetClockResponses as nF, type ResetClockResponse as nG, type CreateGlobalClusterVariableData as nH, type CreateGlobalClusterVariableErrors as nI, type CreateGlobalClusterVariableError as nJ, type CreateGlobalClusterVariableResponses as nK, type CreateGlobalClusterVariableResponse as nL, type DeleteGlobalClusterVariableData as nM, type DeleteGlobalClusterVariableErrors as nN, type DeleteGlobalClusterVariableError as nO, type DeleteGlobalClusterVariableResponses as nP, type DeleteGlobalClusterVariableResponse as nQ, type GetGlobalClusterVariableData as nR, type GetGlobalClusterVariableErrors as nS, type GetGlobalClusterVariableError as nT, type GetGlobalClusterVariableResponses as nU, type GetGlobalClusterVariableResponse as nV, type UpdateGlobalClusterVariableData as nW, type UpdateGlobalClusterVariableErrors as nX, type UpdateGlobalClusterVariableError as nY, type UpdateGlobalClusterVariableResponses as nZ, type UpdateGlobalClusterVariableResponse as n_, type SearchBatchOperationsError as na, type SearchBatchOperationsResponses as nb, type SearchBatchOperationsResponse as nc, type GetBatchOperationData as nd, type GetBatchOperationErrors as ne, type GetBatchOperationError as nf, type GetBatchOperationResponses as ng, type GetBatchOperationResponse as nh, type CancelBatchOperationData as ni, type CancelBatchOperationErrors as nj, type CancelBatchOperationError as nk, type CancelBatchOperationResponses as nl, type CancelBatchOperationResponse as nm, type ResumeBatchOperationData as nn, type ResumeBatchOperationErrors as no, type ResumeBatchOperationError as np, type ResumeBatchOperationResponses as nq, type ResumeBatchOperationResponse as nr, type SuspendBatchOperationData as ns, type SuspendBatchOperationErrors as nt, type SuspendBatchOperationError as nu, type SuspendBatchOperationResponses as nv, type SuspendBatchOperationResponse as nw, type PinClockData as nx, type PinClockErrors as ny, type PinClockError as nz, type SupportLogger as o, type GetDecisionInstanceResponse as o$, type SearchClusterVariablesErrors as o0, type SearchClusterVariablesError as o1, type SearchClusterVariablesResponses as o2, type SearchClusterVariablesResponse as o3, type CreateTenantClusterVariableData as o4, type CreateTenantClusterVariableErrors as o5, type CreateTenantClusterVariableError as o6, type CreateTenantClusterVariableResponses as o7, type CreateTenantClusterVariableResponse as o8, type DeleteTenantClusterVariableData as o9, type EvaluateDecisionError as oA, type EvaluateDecisionResponses as oB, type EvaluateDecisionResponse as oC, type SearchDecisionDefinitionsData as oD, type SearchDecisionDefinitionsErrors as oE, type SearchDecisionDefinitionsError as oF, type SearchDecisionDefinitionsResponses as oG, type SearchDecisionDefinitionsResponse as oH, type GetDecisionDefinitionData as oI, type GetDecisionDefinitionErrors as oJ, type GetDecisionDefinitionError as oK, type GetDecisionDefinitionResponses as oL, type GetDecisionDefinitionResponse as oM, type GetDecisionDefinitionXmlData as oN, type GetDecisionDefinitionXmlErrors as oO, type GetDecisionDefinitionXmlError as oP, type GetDecisionDefinitionXmlResponses as oQ, type GetDecisionDefinitionXmlResponse as oR, type SearchDecisionInstancesData as oS, type SearchDecisionInstancesErrors as oT, type SearchDecisionInstancesError as oU, type SearchDecisionInstancesResponses as oV, type SearchDecisionInstancesResponse as oW, type GetDecisionInstanceData as oX, type GetDecisionInstanceErrors as oY, type GetDecisionInstanceError as oZ, type GetDecisionInstanceResponses as o_, type DeleteTenantClusterVariableErrors as oa, type DeleteTenantClusterVariableError as ob, type DeleteTenantClusterVariableResponses as oc, type DeleteTenantClusterVariableResponse as od, type GetTenantClusterVariableData as oe, type GetTenantClusterVariableErrors as of, type GetTenantClusterVariableError as og, type GetTenantClusterVariableResponses as oh, type GetTenantClusterVariableResponse as oi, type UpdateTenantClusterVariableData as oj, type UpdateTenantClusterVariableErrors as ok, type UpdateTenantClusterVariableError as ol, type UpdateTenantClusterVariableResponses as om, type UpdateTenantClusterVariableResponse as on, type EvaluateConditionalsData as oo, type EvaluateConditionalsErrors as op, type EvaluateConditionalsError as oq, type EvaluateConditionalsResponses as or, type EvaluateConditionalsResponse as os, type SearchCorrelatedMessageSubscriptionsData as ot, type SearchCorrelatedMessageSubscriptionsErrors as ou, type SearchCorrelatedMessageSubscriptionsError as ov, type SearchCorrelatedMessageSubscriptionsResponses as ow, type SearchCorrelatedMessageSubscriptionsResponse as ox, type EvaluateDecisionData as oy, type EvaluateDecisionErrors as oz, type ThreadedJob as p, type SearchElementInstancesResponses as p$, type DeleteDecisionInstanceData as p0, type DeleteDecisionInstanceErrors as p1, type DeleteDecisionInstanceError as p2, type DeleteDecisionInstanceResponses as p3, type DeleteDecisionInstanceResponse as p4, type DeleteDecisionInstancesBatchOperationData as p5, type DeleteDecisionInstancesBatchOperationErrors as p6, type DeleteDecisionInstancesBatchOperationError as p7, type DeleteDecisionInstancesBatchOperationResponses as p8, type DeleteDecisionInstancesBatchOperationResponse as p9, type CreateDocumentsErrors as pA, type CreateDocumentsError as pB, type CreateDocumentsResponses as pC, type CreateDocumentsResponse as pD, type DeleteDocumentData as pE, type DeleteDocumentErrors as pF, type DeleteDocumentError as pG, type DeleteDocumentResponses as pH, type DeleteDocumentResponse as pI, type GetDocumentData as pJ, type GetDocumentErrors as pK, type GetDocumentError as pL, type GetDocumentResponses as pM, type GetDocumentResponse as pN, type CreateDocumentLinkData as pO, type CreateDocumentLinkErrors as pP, type CreateDocumentLinkError as pQ, type CreateDocumentLinkResponses as pR, type CreateDocumentLinkResponse as pS, type ActivateAdHocSubProcessActivitiesData as pT, type ActivateAdHocSubProcessActivitiesErrors as pU, type ActivateAdHocSubProcessActivitiesError as pV, type ActivateAdHocSubProcessActivitiesResponses as pW, type ActivateAdHocSubProcessActivitiesResponse as pX, type SearchElementInstancesData as pY, type SearchElementInstancesErrors as pZ, type SearchElementInstancesError as p_, type SearchDecisionRequirementsData as pa, type SearchDecisionRequirementsErrors as pb, type SearchDecisionRequirementsError as pc, type SearchDecisionRequirementsResponses as pd, type SearchDecisionRequirementsResponse as pe, type GetDecisionRequirementsData as pf, type GetDecisionRequirementsErrors as pg, type GetDecisionRequirementsError as ph, type GetDecisionRequirementsResponses as pi, type GetDecisionRequirementsResponse as pj, type GetDecisionRequirementsXmlData as pk, type GetDecisionRequirementsXmlErrors as pl, type GetDecisionRequirementsXmlError as pm, type GetDecisionRequirementsXmlResponses as pn, type GetDecisionRequirementsXmlResponse as po, type CreateDeploymentData as pp, type CreateDeploymentErrors as pq, type CreateDeploymentError as pr, type CreateDeploymentResponses as ps, type CreateDeploymentResponse as pt, type CreateDocumentData as pu, type CreateDocumentErrors as pv, type CreateDocumentError as pw, type CreateDocumentResponses as px, type CreateDocumentResponse as py, type CreateDocumentsData as pz, type ThreadedJobHandler as q, type GetGroupError as q$, type SearchElementInstancesResponse as q0, type GetElementInstanceData as q1, type GetElementInstanceErrors as q2, type GetElementInstanceError as q3, type GetElementInstanceResponses as q4, type GetElementInstanceResponse as q5, type SearchElementInstanceIncidentsData as q6, type SearchElementInstanceIncidentsErrors as q7, type SearchElementInstanceIncidentsError as q8, type SearchElementInstanceIncidentsResponses as q9, type UpdateGlobalTaskListenerData as qA, type UpdateGlobalTaskListenerErrors as qB, type UpdateGlobalTaskListenerError as qC, type UpdateGlobalTaskListenerResponses as qD, type UpdateGlobalTaskListenerResponse as qE, type SearchGlobalTaskListenersData as qF, type SearchGlobalTaskListenersErrors as qG, type SearchGlobalTaskListenersError as qH, type SearchGlobalTaskListenersResponses as qI, type SearchGlobalTaskListenersResponse as qJ, type CreateGroupData as qK, type CreateGroupErrors as qL, type CreateGroupError as qM, type CreateGroupResponses as qN, type CreateGroupResponse as qO, type SearchGroupsData as qP, type SearchGroupsErrors as qQ, type SearchGroupsError as qR, type SearchGroupsResponses as qS, type SearchGroupsResponse as qT, type DeleteGroupData as qU, type DeleteGroupErrors as qV, type DeleteGroupError as qW, type DeleteGroupResponses as qX, type DeleteGroupResponse as qY, type GetGroupData as qZ, type GetGroupErrors as q_, type SearchElementInstanceIncidentsResponse as qa, type CreateElementInstanceVariablesData as qb, type CreateElementInstanceVariablesErrors as qc, type CreateElementInstanceVariablesError as qd, type CreateElementInstanceVariablesResponses as qe, type CreateElementInstanceVariablesResponse as qf, type EvaluateExpressionData as qg, type EvaluateExpressionErrors as qh, type EvaluateExpressionError as qi, type EvaluateExpressionResponses as qj, type EvaluateExpressionResponse as qk, type CreateGlobalTaskListenerData as ql, type CreateGlobalTaskListenerErrors as qm, type CreateGlobalTaskListenerError as qn, type CreateGlobalTaskListenerResponses as qo, type CreateGlobalTaskListenerResponse as qp, type DeleteGlobalTaskListenerData as qq, type DeleteGlobalTaskListenerErrors as qr, type DeleteGlobalTaskListenerError as qs, type DeleteGlobalTaskListenerResponses as qt, type DeleteGlobalTaskListenerResponse as qu, type GetGlobalTaskListenerData as qv, type GetGlobalTaskListenerErrors as qw, type GetGlobalTaskListenerError as qx, type GetGlobalTaskListenerResponses as qy, type GetGlobalTaskListenerResponse as qz, ThreadedJobWorker as r, type GetIncidentErrors as r$, type GetGroupResponses as r0, type GetGroupResponse as r1, type UpdateGroupData as r2, type UpdateGroupErrors as r3, type UpdateGroupError as r4, type UpdateGroupResponses as r5, type UpdateGroupResponse as r6, type SearchClientsForGroupData as r7, type SearchClientsForGroupErrors as r8, type SearchClientsForGroupError as r9, type AssignMappingRuleToGroupResponse as rA, type SearchRolesForGroupData as rB, type SearchRolesForGroupErrors as rC, type SearchRolesForGroupError as rD, type SearchRolesForGroupResponses as rE, type SearchRolesForGroupResponse as rF, type SearchUsersForGroupData as rG, type SearchUsersForGroupErrors as rH, type SearchUsersForGroupError as rI, type SearchUsersForGroupResponses as rJ, type SearchUsersForGroupResponse as rK, type UnassignUserFromGroupData as rL, type UnassignUserFromGroupErrors as rM, type UnassignUserFromGroupError as rN, type UnassignUserFromGroupResponses as rO, type UnassignUserFromGroupResponse as rP, type AssignUserToGroupData as rQ, type AssignUserToGroupErrors as rR, type AssignUserToGroupError as rS, type AssignUserToGroupResponses as rT, type AssignUserToGroupResponse as rU, type SearchIncidentsData as rV, type SearchIncidentsErrors as rW, type SearchIncidentsError as rX, type SearchIncidentsResponses as rY, type SearchIncidentsResponse as rZ, type GetIncidentData as r_, type SearchClientsForGroupResponses as ra, type SearchClientsForGroupResponse as rb, type UnassignClientFromGroupData as rc, type UnassignClientFromGroupErrors as rd, type UnassignClientFromGroupError as re, type UnassignClientFromGroupResponses as rf, type UnassignClientFromGroupResponse as rg, type AssignClientToGroupData as rh, type AssignClientToGroupErrors as ri, type AssignClientToGroupError as rj, type AssignClientToGroupResponses as rk, type AssignClientToGroupResponse as rl, type SearchMappingRulesForGroupData as rm, type SearchMappingRulesForGroupErrors as rn, type SearchMappingRulesForGroupError as ro, type SearchMappingRulesForGroupResponses as rp, type SearchMappingRulesForGroupResponse as rq, type UnassignMappingRuleFromGroupData as rr, type UnassignMappingRuleFromGroupErrors as rs, type UnassignMappingRuleFromGroupError as rt, type UnassignMappingRuleFromGroupResponses as ru, type UnassignMappingRuleFromGroupResponse as rv, type AssignMappingRuleToGroupData as rw, type AssignMappingRuleToGroupErrors as rx, type AssignMappingRuleToGroupError as ry, type AssignMappingRuleToGroupResponses as rz, type ThreadedJobWorkerConfig as s, type GetJobTimeSeriesStatisticsData as s$, type GetIncidentError as s0, type GetIncidentResponses as s1, type GetIncidentResponse as s2, type ResolveIncidentData as s3, type ResolveIncidentErrors as s4, type ResolveIncidentError as s5, type ResolveIncidentResponses as s6, type ResolveIncidentResponse as s7, type GetProcessInstanceStatisticsByDefinitionData as s8, type GetProcessInstanceStatisticsByDefinitionErrors as s9, type CompleteJobResponses as sA, type CompleteJobResponse as sB, type ThrowJobErrorData as sC, type ThrowJobErrorErrors as sD, type ThrowJobErrorError as sE, type ThrowJobErrorResponses as sF, type ThrowJobErrorResponse as sG, type FailJobData as sH, type FailJobErrors as sI, type FailJobError as sJ, type FailJobResponses as sK, type FailJobResponse as sL, type GetGlobalJobStatisticsData as sM, type GetGlobalJobStatisticsErrors as sN, type GetGlobalJobStatisticsError as sO, type GetGlobalJobStatisticsResponses as sP, type GetGlobalJobStatisticsResponse as sQ, type GetJobTypeStatisticsData as sR, type GetJobTypeStatisticsErrors as sS, type GetJobTypeStatisticsError as sT, type GetJobTypeStatisticsResponses as sU, type GetJobTypeStatisticsResponse as sV, type GetJobWorkerStatisticsData as sW, type GetJobWorkerStatisticsErrors as sX, type GetJobWorkerStatisticsError as sY, type GetJobWorkerStatisticsResponses as sZ, type GetJobWorkerStatisticsResponse as s_, type GetProcessInstanceStatisticsByDefinitionError as sa, type GetProcessInstanceStatisticsByDefinitionResponses as sb, type GetProcessInstanceStatisticsByDefinitionResponse as sc, type GetProcessInstanceStatisticsByErrorData as sd, type GetProcessInstanceStatisticsByErrorErrors as se, type GetProcessInstanceStatisticsByErrorError as sf, type GetProcessInstanceStatisticsByErrorResponses as sg, type GetProcessInstanceStatisticsByErrorResponse as sh, type ActivateJobsData as si, type ActivateJobsErrors as sj, type ActivateJobsError as sk, type ActivateJobsResponses as sl, type ActivateJobsResponse as sm, type SearchJobsData as sn, type SearchJobsErrors as so, type SearchJobsError as sp, type SearchJobsResponses as sq, type SearchJobsResponse as sr, type UpdateJobData as ss, type UpdateJobErrors as st, type UpdateJobError as su, type UpdateJobResponses as sv, type UpdateJobResponse as sw, type CompleteJobData as sx, type CompleteJobErrors as sy, type CompleteJobError as sz, ThreadPool as t, type GetProcessDefinitionMessageSubscriptionStatisticsResponse as t$, type GetJobTimeSeriesStatisticsErrors as t0, type GetJobTimeSeriesStatisticsError as t1, type GetJobTimeSeriesStatisticsResponses as t2, type GetJobTimeSeriesStatisticsResponse as t3, type GetJobErrorStatisticsData as t4, type GetJobErrorStatisticsErrors as t5, type GetJobErrorStatisticsError as t6, type GetJobErrorStatisticsResponses as t7, type GetJobErrorStatisticsResponse as t8, type GetLicenseData as t9, type UpdateMappingRuleError as tA, type UpdateMappingRuleResponses as tB, type UpdateMappingRuleResponse as tC, type SearchMessageSubscriptionsData as tD, type SearchMessageSubscriptionsErrors as tE, type SearchMessageSubscriptionsError as tF, type SearchMessageSubscriptionsResponses as tG, type SearchMessageSubscriptionsResponse as tH, type CorrelateMessageData as tI, type CorrelateMessageErrors as tJ, type CorrelateMessageError as tK, type CorrelateMessageResponses as tL, type CorrelateMessageResponse as tM, type PublishMessageData as tN, type PublishMessageErrors as tO, type PublishMessageError as tP, type PublishMessageResponses as tQ, type PublishMessageResponse as tR, type SearchProcessDefinitionsData as tS, type SearchProcessDefinitionsErrors as tT, type SearchProcessDefinitionsError as tU, type SearchProcessDefinitionsResponses as tV, type SearchProcessDefinitionsResponse as tW, type GetProcessDefinitionMessageSubscriptionStatisticsData as tX, type GetProcessDefinitionMessageSubscriptionStatisticsErrors as tY, type GetProcessDefinitionMessageSubscriptionStatisticsError as tZ, type GetProcessDefinitionMessageSubscriptionStatisticsResponses as t_, type GetLicenseErrors as ta, type GetLicenseError as tb, type GetLicenseResponses as tc, type GetLicenseResponse as td, type CreateMappingRuleData as te, type CreateMappingRuleErrors as tf, type CreateMappingRuleError as tg, type CreateMappingRuleResponses as th, type CreateMappingRuleResponse as ti, type SearchMappingRuleData as tj, type SearchMappingRuleErrors as tk, type SearchMappingRuleError as tl, type SearchMappingRuleResponses as tm, type SearchMappingRuleResponse as tn, type DeleteMappingRuleData as to, type DeleteMappingRuleErrors as tp, type DeleteMappingRuleError as tq, type DeleteMappingRuleResponses as tr, type DeleteMappingRuleResponse as ts, type GetMappingRuleData as tt, type GetMappingRuleErrors as tu, type GetMappingRuleError as tv, type GetMappingRuleResponses as tw, type GetMappingRuleResponse as tx, type UpdateMappingRuleData as ty, type UpdateMappingRuleErrors as tz, type CamundaConfig as u, type SearchProcessInstancesResponses as u$, type GetProcessDefinitionInstanceStatisticsData as u0, type GetProcessDefinitionInstanceStatisticsErrors as u1, type GetProcessDefinitionInstanceStatisticsError as u2, type GetProcessDefinitionInstanceStatisticsResponses as u3, type GetProcessDefinitionInstanceStatisticsResponse as u4, type GetProcessDefinitionData as u5, type GetProcessDefinitionErrors as u6, type GetProcessDefinitionError as u7, type GetProcessDefinitionResponses as u8, type GetProcessDefinitionResponse as u9, type CancelProcessInstancesBatchOperationErrors as uA, type CancelProcessInstancesBatchOperationError as uB, type CancelProcessInstancesBatchOperationResponses as uC, type CancelProcessInstancesBatchOperationResponse as uD, type DeleteProcessInstancesBatchOperationData as uE, type DeleteProcessInstancesBatchOperationErrors as uF, type DeleteProcessInstancesBatchOperationError as uG, type DeleteProcessInstancesBatchOperationResponses as uH, type DeleteProcessInstancesBatchOperationResponse as uI, type ResolveIncidentsBatchOperationData as uJ, type ResolveIncidentsBatchOperationErrors as uK, type ResolveIncidentsBatchOperationError as uL, type ResolveIncidentsBatchOperationResponses as uM, type ResolveIncidentsBatchOperationResponse as uN, type MigrateProcessInstancesBatchOperationData as uO, type MigrateProcessInstancesBatchOperationErrors as uP, type MigrateProcessInstancesBatchOperationError as uQ, type MigrateProcessInstancesBatchOperationResponses as uR, type MigrateProcessInstancesBatchOperationResponse as uS, type ModifyProcessInstancesBatchOperationData as uT, type ModifyProcessInstancesBatchOperationErrors as uU, type ModifyProcessInstancesBatchOperationError as uV, type ModifyProcessInstancesBatchOperationResponses as uW, type ModifyProcessInstancesBatchOperationResponse as uX, type SearchProcessInstancesData as uY, type SearchProcessInstancesErrors as uZ, type SearchProcessInstancesError as u_, type GetStartProcessFormData as ua, type GetStartProcessFormErrors as ub, type GetStartProcessFormError as uc, type GetStartProcessFormResponses as ud, type GetStartProcessFormResponse as ue, type GetProcessDefinitionStatisticsData as uf, type GetProcessDefinitionStatisticsErrors as ug, type GetProcessDefinitionStatisticsError as uh, type GetProcessDefinitionStatisticsResponses as ui, type GetProcessDefinitionStatisticsResponse as uj, type GetProcessDefinitionXmlData as uk, type GetProcessDefinitionXmlErrors as ul, type GetProcessDefinitionXmlError as um, type GetProcessDefinitionXmlResponses as un, type GetProcessDefinitionXmlResponse as uo, type GetProcessDefinitionInstanceVersionStatisticsData as up, type GetProcessDefinitionInstanceVersionStatisticsErrors as uq, type GetProcessDefinitionInstanceVersionStatisticsError as ur, type GetProcessDefinitionInstanceVersionStatisticsResponses as us, type GetProcessDefinitionInstanceVersionStatisticsResponse as ut, type CreateProcessInstanceData as uu, type CreateProcessInstanceErrors as uv, type CreateProcessInstanceError as uw, type CreateProcessInstanceResponses as ux, type CreateProcessInstanceResponse as uy, type CancelProcessInstancesBatchOperationData as uz, type activateAdHocSubProcessActivitiesInput as v, type DeleteResourceError as v$, type SearchProcessInstancesResponse as v0, type GetProcessInstanceData as v1, type GetProcessInstanceErrors as v2, type GetProcessInstanceError as v3, type GetProcessInstanceResponses as v4, type GetProcessInstanceResponse as v5, type GetProcessInstanceCallHierarchyData as v6, type GetProcessInstanceCallHierarchyErrors as v7, type GetProcessInstanceCallHierarchyError as v8, type GetProcessInstanceCallHierarchyResponses as v9, type ModifyProcessInstanceData as vA, type ModifyProcessInstanceErrors as vB, type ModifyProcessInstanceError as vC, type ModifyProcessInstanceResponses as vD, type ModifyProcessInstanceResponse as vE, type GetProcessInstanceSequenceFlowsData as vF, type GetProcessInstanceSequenceFlowsErrors as vG, type GetProcessInstanceSequenceFlowsError as vH, type GetProcessInstanceSequenceFlowsResponses as vI, type GetProcessInstanceSequenceFlowsResponse as vJ, type GetProcessInstanceStatisticsData as vK, type GetProcessInstanceStatisticsErrors as vL, type GetProcessInstanceStatisticsError as vM, type GetProcessInstanceStatisticsResponses as vN, type GetProcessInstanceStatisticsResponse as vO, type GetResourceData as vP, type GetResourceErrors as vQ, type GetResourceError as vR, type GetResourceResponses as vS, type GetResourceResponse as vT, type GetResourceContentData as vU, type GetResourceContentErrors as vV, type GetResourceContentError as vW, type GetResourceContentResponses as vX, type GetResourceContentResponse as vY, type DeleteResourceData as vZ, type DeleteResourceErrors as v_, type GetProcessInstanceCallHierarchyResponse as va, type CancelProcessInstanceData as vb, type CancelProcessInstanceErrors as vc, type CancelProcessInstanceError as vd, type CancelProcessInstanceResponses as ve, type CancelProcessInstanceResponse as vf, type DeleteProcessInstanceData as vg, type DeleteProcessInstanceErrors as vh, type DeleteProcessInstanceError as vi, type DeleteProcessInstanceResponses as vj, type DeleteProcessInstanceResponse as vk, type ResolveProcessInstanceIncidentsData as vl, type ResolveProcessInstanceIncidentsErrors as vm, type ResolveProcessInstanceIncidentsError as vn, type ResolveProcessInstanceIncidentsResponses as vo, type ResolveProcessInstanceIncidentsResponse as vp, type SearchProcessInstanceIncidentsData as vq, type SearchProcessInstanceIncidentsErrors as vr, type SearchProcessInstanceIncidentsError as vs, type SearchProcessInstanceIncidentsResponses as vt, type SearchProcessInstanceIncidentsResponse as vu, type MigrateProcessInstanceData as vv, type MigrateProcessInstanceErrors as vw, type MigrateProcessInstanceError as vx, type MigrateProcessInstanceResponses as vy, type MigrateProcessInstanceResponse as vz, type activateJobsInput as w, type UnassignRoleFromMappingRuleErrors as w$, type DeleteResourceResponses as w0, type DeleteResourceResponse2 as w1, type CreateRoleData as w2, type CreateRoleErrors as w3, type CreateRoleError as w4, type CreateRoleResponses as w5, type CreateRoleResponse as w6, type SearchRolesData as w7, type SearchRolesErrors as w8, type SearchRolesError as w9, type UnassignRoleFromClientResponse as wA, type AssignRoleToClientData as wB, type AssignRoleToClientErrors as wC, type AssignRoleToClientError as wD, type AssignRoleToClientResponses as wE, type AssignRoleToClientResponse as wF, type SearchGroupsForRoleData as wG, type SearchGroupsForRoleErrors as wH, type SearchGroupsForRoleError as wI, type SearchGroupsForRoleResponses as wJ, type SearchGroupsForRoleResponse as wK, type UnassignRoleFromGroupData as wL, type UnassignRoleFromGroupErrors as wM, type UnassignRoleFromGroupError as wN, type UnassignRoleFromGroupResponses as wO, type UnassignRoleFromGroupResponse as wP, type AssignRoleToGroupData as wQ, type AssignRoleToGroupErrors as wR, type AssignRoleToGroupError as wS, type AssignRoleToGroupResponses as wT, type AssignRoleToGroupResponse as wU, type SearchMappingRulesForRoleData as wV, type SearchMappingRulesForRoleErrors as wW, type SearchMappingRulesForRoleError as wX, type SearchMappingRulesForRoleResponses as wY, type SearchMappingRulesForRoleResponse as wZ, type UnassignRoleFromMappingRuleData as w_, type SearchRolesResponses as wa, type SearchRolesResponse as wb, type DeleteRoleData as wc, type DeleteRoleErrors as wd, type DeleteRoleError as we, type DeleteRoleResponses as wf, type DeleteRoleResponse as wg, type GetRoleData as wh, type GetRoleErrors as wi, type GetRoleError as wj, type GetRoleResponses as wk, type GetRoleResponse as wl, type UpdateRoleData as wm, type UpdateRoleErrors as wn, type UpdateRoleError as wo, type UpdateRoleResponses as wp, type UpdateRoleResponse as wq, type SearchClientsForRoleData as wr, type SearchClientsForRoleErrors as ws, type SearchClientsForRoleError as wt, type SearchClientsForRoleResponses as wu, type SearchClientsForRoleResponse as wv, type UnassignRoleFromClientData as ww, type UnassignRoleFromClientErrors as wx, type UnassignRoleFromClientError as wy, type UnassignRoleFromClientResponses as wz, type assignClientToGroupInput as x, type GetTenantErrors as x$, type UnassignRoleFromMappingRuleError as x0, type UnassignRoleFromMappingRuleResponses as x1, type UnassignRoleFromMappingRuleResponse as x2, type AssignRoleToMappingRuleData as x3, type AssignRoleToMappingRuleErrors as x4, type AssignRoleToMappingRuleError as x5, type AssignRoleToMappingRuleResponses as x6, type AssignRoleToMappingRuleResponse as x7, type SearchUsersForRoleData as x8, type SearchUsersForRoleErrors as x9, type GetStatusResponse as xA, type GetUsageMetricsData as xB, type GetUsageMetricsErrors as xC, type GetUsageMetricsError as xD, type GetUsageMetricsResponses as xE, type GetUsageMetricsResponse as xF, type GetSystemConfigurationData as xG, type GetSystemConfigurationErrors as xH, type GetSystemConfigurationError as xI, type GetSystemConfigurationResponses as xJ, type GetSystemConfigurationResponse as xK, type CreateTenantData as xL, type CreateTenantErrors as xM, type CreateTenantError as xN, type CreateTenantResponses as xO, type CreateTenantResponse as xP, type SearchTenantsData as xQ, type SearchTenantsErrors as xR, type SearchTenantsError as xS, type SearchTenantsResponses as xT, type SearchTenantsResponse as xU, type DeleteTenantData as xV, type DeleteTenantErrors as xW, type DeleteTenantError as xX, type DeleteTenantResponses as xY, type DeleteTenantResponse as xZ, type GetTenantData as x_, type SearchUsersForRoleError as xa, type SearchUsersForRoleResponses as xb, type SearchUsersForRoleResponse as xc, type UnassignRoleFromUserData as xd, type UnassignRoleFromUserErrors as xe, type UnassignRoleFromUserError as xf, type UnassignRoleFromUserResponses as xg, type UnassignRoleFromUserResponse as xh, type AssignRoleToUserData as xi, type AssignRoleToUserErrors as xj, type AssignRoleToUserError as xk, type AssignRoleToUserResponses as xl, type AssignRoleToUserResponse as xm, type CreateAdminUserData as xn, type CreateAdminUserErrors as xo, type CreateAdminUserError as xp, type CreateAdminUserResponses as xq, type CreateAdminUserResponse as xr, type BroadcastSignalData as xs, type BroadcastSignalErrors as xt, type BroadcastSignalError as xu, type BroadcastSignalResponses as xv, type BroadcastSignalResponse as xw, type GetStatusData as xx, type GetStatusErrors as xy, type GetStatusResponses as xz, type assignClientToTenantInput as y, type UnassignUserFromTenantData as y$, type GetTenantError as y0, type GetTenantResponses as y1, type GetTenantResponse as y2, type UpdateTenantData as y3, type UpdateTenantErrors as y4, type UpdateTenantError as y5, type UpdateTenantResponses as y6, type UpdateTenantResponse as y7, type SearchClientsForTenantData as y8, type SearchClientsForTenantResponses as y9, type SearchMappingRulesForTenantResponse as yA, type UnassignMappingRuleFromTenantData as yB, type UnassignMappingRuleFromTenantErrors as yC, type UnassignMappingRuleFromTenantError as yD, type UnassignMappingRuleFromTenantResponses as yE, type UnassignMappingRuleFromTenantResponse as yF, type AssignMappingRuleToTenantData as yG, type AssignMappingRuleToTenantErrors as yH, type AssignMappingRuleToTenantError as yI, type AssignMappingRuleToTenantResponses as yJ, type AssignMappingRuleToTenantResponse as yK, type SearchRolesForTenantData as yL, type SearchRolesForTenantResponses as yM, type SearchRolesForTenantResponse as yN, type UnassignRoleFromTenantData as yO, type UnassignRoleFromTenantErrors as yP, type UnassignRoleFromTenantError as yQ, type UnassignRoleFromTenantResponses as yR, type UnassignRoleFromTenantResponse as yS, type AssignRoleToTenantData as yT, type AssignRoleToTenantErrors as yU, type AssignRoleToTenantError as yV, type AssignRoleToTenantResponses as yW, type AssignRoleToTenantResponse as yX, type SearchUsersForTenantData as yY, type SearchUsersForTenantResponses as yZ, type SearchUsersForTenantResponse as y_, type SearchClientsForTenantResponse as ya, type UnassignClientFromTenantData as yb, type UnassignClientFromTenantErrors as yc, type UnassignClientFromTenantError as yd, type UnassignClientFromTenantResponses as ye, type UnassignClientFromTenantResponse as yf, type AssignClientToTenantData as yg, type AssignClientToTenantErrors as yh, type AssignClientToTenantError as yi, type AssignClientToTenantResponses as yj, type AssignClientToTenantResponse as yk, type SearchGroupIdsForTenantData as yl, type SearchGroupIdsForTenantResponses as ym, type SearchGroupIdsForTenantResponse as yn, type UnassignGroupFromTenantData as yo, type UnassignGroupFromTenantErrors as yp, type UnassignGroupFromTenantError as yq, type UnassignGroupFromTenantResponses as yr, type UnassignGroupFromTenantResponse as ys, type AssignGroupToTenantData as yt, type AssignGroupToTenantErrors as yu, type AssignGroupToTenantError as yv, type AssignGroupToTenantResponses as yw, type AssignGroupToTenantResponse as yx, type SearchMappingRulesForTenantData as yy, type SearchMappingRulesForTenantResponses as yz, type assignGroupToTenantInput as z, type AssignUserTaskResponse as z$, type UnassignUserFromTenantErrors as z0, type UnassignUserFromTenantError as z1, type UnassignUserFromTenantResponses as z2, type UnassignUserFromTenantResponse as z3, type AssignUserToTenantData as z4, type AssignUserToTenantErrors as z5, type AssignUserToTenantError as z6, type AssignUserToTenantResponses as z7, type AssignUserToTenantResponse as z8, type GetTopologyData as z9, type UpdateUserError as zA, type UpdateUserResponses as zB, type UpdateUserResponse as zC, type SearchUserTasksData as zD, type SearchUserTasksErrors as zE, type SearchUserTasksError as zF, type SearchUserTasksResponses as zG, type SearchUserTasksResponse as zH, type GetUserTaskData as zI, type GetUserTaskErrors as zJ, type GetUserTaskError as zK, type GetUserTaskResponses as zL, type GetUserTaskResponse as zM, type UpdateUserTaskData as zN, type UpdateUserTaskErrors as zO, type UpdateUserTaskError as zP, type UpdateUserTaskResponses as zQ, type UpdateUserTaskResponse as zR, type UnassignUserTaskData as zS, type UnassignUserTaskErrors as zT, type UnassignUserTaskError as zU, type UnassignUserTaskResponses as zV, type UnassignUserTaskResponse as zW, type AssignUserTaskData as zX, type AssignUserTaskErrors as zY, type AssignUserTaskError as zZ, type AssignUserTaskResponses as z_, type GetTopologyErrors as za, type GetTopologyError as zb, type GetTopologyResponses as zc, type GetTopologyResponse as zd, type CreateUserData as ze, type CreateUserErrors as zf, type CreateUserError as zg, type CreateUserResponses as zh, type CreateUserResponse as zi, type SearchUsersData as zj, type SearchUsersErrors as zk, type SearchUsersError as zl, type SearchUsersResponses as zm, type SearchUsersResponse as zn, type DeleteUserData as zo, type DeleteUserErrors as zp, type DeleteUserError as zq, type DeleteUserResponses as zr, type DeleteUserResponse as zs, type GetUserData as zt, type GetUserErrors as zu, type GetUserError as zv, type GetUserResponses as zw, type GetUserResponse as zx, type UpdateUserData as zy, type UpdateUserErrors as zz };